Skip to main content

Class: SignalExternalWorkflowExecution

coresdk.workflow_commands.SignalExternalWorkflowExecution

Send a signal to an external or child workflow

Implements#

Constructors#

constructor#

new SignalExternalWorkflowExecution(properties?)

Constructs a new SignalExternalWorkflowExecution.

Parameters#

NameType
properties?ISignalExternalWorkflowExecution

Properties#

args#

args: IPayload[]

Arguments for the handler

Implementation of#

ISignalExternalWorkflowExecution.args


childWorkflowId#

Optional childWorkflowId: null | string

SignalExternalWorkflowExecution childWorkflowId.

Implementation of#

ISignalExternalWorkflowExecution.childWorkflowId


seq#

seq: number

Lang's incremental sequence number, used as the operation identifier

Implementation of#

ISignalExternalWorkflowExecution.seq


signalName#

signalName: string

Name of the signal handler

Implementation of#

ISignalExternalWorkflowExecution.signalName


target#

Optional target: "workflowExecution" | "childWorkflowId"

SignalExternalWorkflowExecution target.


workflowExecution#

Optional workflowExecution: null | INamespacedWorkflowExecution

SignalExternalWorkflowExecution workflowExecution.

Implementation of#

ISignalExternalWorkflowExecution.workflowExecution

Methods#

toJSON#

toJSON(): Object

Converts this SignalExternalWorkflowExecution to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): SignalExternalWorkflowExecution

Decodes a SignalExternalWorkflowExecution message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

SignalExternalWorkflowExecution

SignalExternalWorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): SignalExternalWorkflowExecution

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

SignalExternalWorkflowExecution

SignalExternalWorkflowExecution


encode#

Static encode(message, writer?): Writer

Encodes the specified SignalExternalWorkflowExecution message. Does not implicitly {@link coresdk.workflow_commands.SignalExternalWorkflowExecution.verify|verify} messages.

Parameters#

NameTypeDescription
messageISignalExternalWorkflowExecutionSignalExternalWorkflowExecution message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified SignalExternalWorkflowExecution message, length delimited. Does not implicitly {@link coresdk.workflow_commands.SignalExternalWorkflowExecution.verify|verify} messages.

Parameters#

NameTypeDescription
messageISignalExternalWorkflowExecutionSignalExternalWorkflowExecution message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): SignalExternalWorkflowExecution

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

SignalExternalWorkflowExecution

SignalExternalWorkflowExecution


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageSignalExternalWorkflowExecutionSignalExternalWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object