Skip to main content

Class: Trigger

Represents a Trigger.

Properties​

updateWorkflowExecutionCompleted?​

optional updateWorkflowExecutionCompleted?: $Properties | null

Trigger updateWorkflowExecutionCompleted.

variant?​

optional variant?: "workflowClosed" | "updateWorkflowExecutionCompleted"

Trigger variant.

workflowClosed?​

optional workflowClosed?: $Properties | null

Trigger workflowClosed.

Methods​

toJSON()​

toJSON(): object

Converts this Trigger to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Trigger & $Shape

Creates a new Trigger instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Trigger & $Shape

Trigger instance

Call Signature​

static create(properties?): Trigger

Creates a new Trigger instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Trigger

Trigger instance

decode()​

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

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

Trigger & $Shape

Trigger

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Trigger & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Trigger & $Shape

Trigger

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 Trigger message. Does not implicitly temporal.api.workflow.v1.CallbackInfo.Trigger.verify|verify messages.

Parameters​

message​

$Properties

Trigger message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Trigger message, length delimited. Does not implicitly temporal.api.workflow.v1.CallbackInfo.Trigger.verify|verify messages.

Parameters​

message​

$Properties

Trigger message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Trigger

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

Parameters​

object​

Plain object

Returns​

Trigger

Trigger

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Trigger

Trigger

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object