Skip to main content

Class: ProtocolMessageCommandAttributes

Represents a ProtocolMessageCommandAttributes.

Properties​

messageId​

messageId: string

The message ID of the message to which this command is a pointer.

Methods​

toJSON()​

toJSON(): object

Converts this ProtocolMessageCommandAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ProtocolMessageCommandAttributes & $Properties

Creates a new ProtocolMessageCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ProtocolMessageCommandAttributes & $Properties

ProtocolMessageCommandAttributes instance

Call Signature​

static create(properties?): ProtocolMessageCommandAttributes

Creates a new ProtocolMessageCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ProtocolMessageCommandAttributes

ProtocolMessageCommandAttributes instance

decode()​

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

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

ProtocolMessageCommandAttributes & $Properties

ProtocolMessageCommandAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ProtocolMessageCommandAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ProtocolMessageCommandAttributes & $Properties

ProtocolMessageCommandAttributes

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

Parameters​

message​

$Properties

ProtocolMessageCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ProtocolMessageCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ProtocolMessageCommandAttributes

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

Parameters​

object​

Plain object

Returns​

ProtocolMessageCommandAttributes

ProtocolMessageCommandAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ProtocolMessageCommandAttributes

ProtocolMessageCommandAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object