Skip to main content

Class: Payloads

See Payload

Properties​

payloads​

payloads: $Properties[]

Payloads payloads.

Methods​

toJSON()​

toJSON(): object

Converts this Payloads to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Payloads & $Properties

Creates a new Payloads instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Payloads & $Properties

Payloads instance

Call Signature​

static create(properties?): Payloads

Creates a new Payloads instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Payloads

Payloads instance

decode()​

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

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

Payloads & $Properties

Payloads

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Payloads & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Payloads & $Properties

Payloads

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

Parameters​

message​

$Properties

Payloads message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Payloads message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Payloads

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Payloads

Payloads

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Payloads

Payloads

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object