Skip to main content

Class: Message

(-- api-linter: core::0146::any=disabled aip.dev/not-precedent: We want runtime extensibility for the body field --)

Properties​

body?​

optional body?: $Properties | null

The opaque data carried by this message. The protocol type can be extracted from the package name of the message carried inside the Any.

commandIndex?​

optional commandIndex?: Long | null

Message commandIndex.

eventId?​

optional eventId?: Long | null

Message eventId.

id​

id: string

An ID for this specific message.

protocolInstanceId​

protocolInstanceId: string

Identifies the specific instance of a protocol to which this message belongs.

sequencingId?​

optional sequencingId?: "eventId" | "commandIndex"

The event ID or command ID after which this message can be delivered. The effects of history up to and including this event ID should be visible to the code that handles this message. Omit to opt out of sequencing.

Methods​

toJSON()​

toJSON(): object

Converts this Message to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Message & $Shape

Creates a new Message instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Message & $Shape

Message instance

Call Signature​

static create(properties?): Message

Creates a new Message instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Message

Message instance

decode()​

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

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

Message & $Shape

Message

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Message & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Message & $Shape

Message

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

Parameters​

message​

$Properties

Message message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Message message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Message

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

Parameters​

object​

Plain object

Returns​

Message

Message

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Message

Message

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object