Skip to main content

Class: RemoveUserGroupMemberRequest

Represents a RemoveUserGroupMemberRequest.

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 RemoveUserGroupMemberRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RemoveUserGroupMemberRequest & $Shape

Creates a new RemoveUserGroupMemberRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

RemoveUserGroupMemberRequest & $Shape

RemoveUserGroupMemberRequest instance

Call Signature​

static create(properties?): RemoveUserGroupMemberRequest

Creates a new RemoveUserGroupMemberRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RemoveUserGroupMemberRequest

RemoveUserGroupMemberRequest instance

decode()​

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

Decodes a RemoveUserGroupMemberRequest 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​

RemoveUserGroupMemberRequest & $Shape

RemoveUserGroupMemberRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RemoveUserGroupMemberRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RemoveUserGroupMemberRequest & $Shape

RemoveUserGroupMemberRequest

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

Parameters​

message​

$Properties

RemoveUserGroupMemberRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RemoveUserGroupMemberRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RemoveUserGroupMemberRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

RemoveUserGroupMemberRequest

RemoveUserGroupMemberRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RemoveUserGroupMemberRequest

RemoveUserGroupMemberRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object