Skip to main content

Class: SignalWorkflow

Send a signal to a workflow

Properties​

headers​

headers: object

Headers attached to the signal

Index Signature​

[k: string]: $Properties

identity​

identity: string

Identity of the sender of the signal

input​

input: $Properties[]

SignalWorkflow input.

originatingEventId​

originatingEventId: Long

Event ID of the WORKFLOW_EXECUTION_SIGNALED history event that produced this job.

signalName​

signalName: string

SignalWorkflow signalName.

Methods​

toJSON()​

toJSON(): object

Converts this SignalWorkflow to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SignalWorkflow & $Properties

Creates a new SignalWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalWorkflow & $Properties

SignalWorkflow instance

Call Signature​

static create(properties?): SignalWorkflow

Creates a new SignalWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalWorkflow

SignalWorkflow instance

decode()​

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

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

SignalWorkflow & $Properties

SignalWorkflow

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SignalWorkflow & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SignalWorkflow & $Properties

SignalWorkflow

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

Parameters​

message​

$Properties

SignalWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified SignalWorkflow message, length delimited. Does not implicitly coresdk.workflow_activation.SignalWorkflow.verify|verify messages.

Parameters​

message​

$Properties

SignalWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SignalWorkflow

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

SignalWorkflow

SignalWorkflow

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SignalWorkflow

SignalWorkflow

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object