Skip to main content

Class: UserGroupMemberId

identity.v1.UserGroupMemberId

Represents a UserGroupMemberId.

Properties

memberType

Optional memberType: "userId"

UserGroupMemberId memberType.


userId

Optional userId: null | string

UserGroupMemberId userId.

Methods

toJSON

toJSON(): Object

Converts this UserGroupMemberId to JSON.

Returns

Object

JSON object


create

create(properties?): UserGroupMemberId & $Shape

Creates a new UserGroupMemberId instance using the specified properties.

Parameters

NameTypeDescription
properties?$ShapeProperties to set

Returns

UserGroupMemberId & $Shape

UserGroupMemberId instance

create(properties?): UserGroupMemberId

Parameters

NameType
properties?$Properties

Returns

UserGroupMemberId


decode

decode(reader, length?): UserGroupMemberId & $Shape

Decodes a UserGroupMemberId message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

UserGroupMemberId & $Shape

UserGroupMemberId

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): UserGroupMemberId & $Shape

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

UserGroupMemberId & $Shape

UserGroupMemberId

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified UserGroupMemberId message. Does not implicitly temporal.api.cloud.identity.v1.UserGroupMemberId.verify|verify messages.

Parameters

NameTypeDescription
message$PropertiesUserGroupMemberId message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesUserGroupMemberId message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): UserGroupMemberId

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

UserGroupMemberId

UserGroupMemberId


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageUserGroupMemberIdUserGroupMemberId
options?IConversionOptionsConversion options

Returns

Object

Plain object