Class: UserMetadata

Information a user can set, often for use by user interfaces.

Properties

details?

optional details?: $Properties | null

Long-form text that provides details. This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may apply to this text in common use. The payload data section is limited to 20000 bytes by default.

---

summary?

optional summary?: $Properties | null

Short-form text that provides a summary. This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may not apply to this text when used in "title" situations. The payload data section is limited to 400 bytes by default.

Methods

toJSON()

toJSON(): object

Converts this UserMetadata to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): UserMetadata & $Properties

Creates a new UserMetadata instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

UserMetadata & $Properties

UserMetadata instance

Call Signature

static create(properties?): UserMetadata

Creates a new UserMetadata instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

UserMetadata

UserMetadata instance

---

decode()

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

Decodes a UserMetadata 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

UserMetadata & $Properties

UserMetadata

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): UserMetadata & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

UserMetadata & $Properties

UserMetadata

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 UserMetadata message. Does not implicitly temporal.api.sdk.v1.UserMetadata.verify|verify messages.

Parameters

message

$Properties

UserMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified UserMetadata message, length delimited. Does not implicitly temporal.api.sdk.v1.UserMetadata.verify|verify messages.

Parameters

message

$Properties

UserMetadata message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): UserMetadata

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

Parameters

object

Plain object

Returns

UserMetadata

UserMetadata

---

toObject()

static toObject(message, options?): object

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

Parameters

message

UserMetadata

UserMetadata

options?

IConversionOptions

Conversion options

Returns

object

Plain object