Skip to main content

Class: SignalExternalWorkflowExecution

Send a signal to an external or child workflow

Properties​

args​

args: $Properties[]

Arguments for the handler

childWorkflowId?​

optional childWorkflowId?: string | null

The desired target must be a child of the issuing workflow, and this is its workflow id

headers​

headers: object

Headers to attach to the signal

Index Signature​

[k: string]: $Properties

seq​

seq: number

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

signalName​

signalName: string

Name of the signal handler

target?​

optional target?: "workflowExecution" | "childWorkflowId"

What workflow is being targeted

workflowExecution?​

optional workflowExecution?: $Properties | null

A specific workflow instance

Methods​

toJSON()​

toJSON(): object

Converts this SignalExternalWorkflowExecution to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SignalExternalWorkflowExecution & $Shape

Creates a new SignalExternalWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

SignalExternalWorkflowExecution & $Shape

SignalExternalWorkflowExecution instance

Call Signature​

static create(properties?): SignalExternalWorkflowExecution

Creates a new SignalExternalWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalExternalWorkflowExecution

SignalExternalWorkflowExecution instance

decode()​

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

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

SignalExternalWorkflowExecution & $Shape

SignalExternalWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SignalExternalWorkflowExecution & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SignalExternalWorkflowExecution & $Shape

SignalExternalWorkflowExecution

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 SignalExternalWorkflowExecution message. Does not implicitly coresdk.workflow_commands.SignalExternalWorkflowExecution.verify|verify messages.

Parameters​

message​

$Properties

SignalExternalWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SignalExternalWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

Plain 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​

message​

SignalExternalWorkflowExecution

SignalExternalWorkflowExecution

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object