Skip to main content

Class: CreateUserRequest

Represents a CreateUserRequest.

Properties​

asyncOperationId​

asyncOperationId: string

The id to use for this async operation - optional

spec?​

optional spec?: $Properties | null

The spec for the user to invite

Methods​

toJSON()​

toJSON(): object

Converts this CreateUserRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CreateUserRequest & $Properties

Creates a new CreateUserRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateUserRequest & $Properties

CreateUserRequest instance

Call Signature​

static create(properties?): CreateUserRequest

Creates a new CreateUserRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateUserRequest

CreateUserRequest instance

decode()​

static decode(reader, length?): CreateUserRequest & $Properties

Decodes a CreateUserRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

CreateUserRequest & $Properties

CreateUserRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CreateUserRequest & $Properties

Decodes a CreateUserRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CreateUserRequest & $Properties

CreateUserRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified CreateUserRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.CreateUserRequest.verify|verify messages.

Parameters​

message​

$Properties

CreateUserRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CreateUserRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.CreateUserRequest.verify|verify messages.

Parameters​

message​

$Properties

CreateUserRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CreateUserRequest

Creates a CreateUserRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CreateUserRequest

CreateUserRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a CreateUserRequest message. Also converts values to other types if specified.

Parameters​

message​

CreateUserRequest

CreateUserRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object