Skip to main content

Class: WorkflowEvent

Represents a WorkflowEvent.

Properties​

eventRef?​

optional eventRef?: $Properties | null

WorkflowEvent eventRef.

namespace​

namespace: string

WorkflowEvent namespace.

reference?​

optional reference?: "eventRef" | "requestIdRef"

Additional information about the workflow event. Eg: the caller workflow can send the history event details that made the Nexus call.

requestIdRef?​

optional requestIdRef?: $Properties | null

WorkflowEvent requestIdRef.

runId​

runId: string

WorkflowEvent runId.

workflowId​

workflowId: string

WorkflowEvent workflowId.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowEvent to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowEvent & $Shape

Creates a new WorkflowEvent instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowEvent & $Shape

WorkflowEvent instance

Call Signature​

static create(properties?): WorkflowEvent

Creates a new WorkflowEvent instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowEvent

WorkflowEvent instance

decode()​

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

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

WorkflowEvent & $Shape

WorkflowEvent

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowEvent & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowEvent & $Shape

WorkflowEvent

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

Parameters​

message​

$Properties

WorkflowEvent message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowEvent message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowEvent

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

Parameters​

object​

Plain object

Returns​

WorkflowEvent

WorkflowEvent

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowEvent

WorkflowEvent

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object