Skip to main content

Class: AddUserGroupMemberRequest

Represents an AddUserGroupMemberRequest.

Properties​

asyncOperationId​

asyncOperationId: string

The id to use for this async operation. Optional, if not provided a random id will be generated.

groupId​

groupId: string

The id of the group to add the member for.

memberId?​

optional memberId?: $Properties | null

The member id to add to the group.

Methods​

toJSON()​

toJSON(): object

Converts this AddUserGroupMemberRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): AddUserGroupMemberRequest & $Shape

Creates a new AddUserGroupMemberRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

AddUserGroupMemberRequest & $Shape

AddUserGroupMemberRequest instance

Call Signature​

static create(properties?): AddUserGroupMemberRequest

Creates a new AddUserGroupMemberRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AddUserGroupMemberRequest

AddUserGroupMemberRequest instance

decode()​

static decode(reader, length?): AddUserGroupMemberRequest & $Shape

Decodes an AddUserGroupMemberRequest 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​

AddUserGroupMemberRequest & $Shape

AddUserGroupMemberRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): AddUserGroupMemberRequest & $Shape

Decodes an AddUserGroupMemberRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

AddUserGroupMemberRequest & $Shape

AddUserGroupMemberRequest

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 AddUserGroupMemberRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.AddUserGroupMemberRequest.verify|verify messages.

Parameters​

message​

$Properties

AddUserGroupMemberRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

AddUserGroupMemberRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): AddUserGroupMemberRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

AddUserGroupMemberRequest

AddUserGroupMemberRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

AddUserGroupMemberRequest

AddUserGroupMemberRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object