Skip to main content

Class: SignalWorkflow

coresdk.workflow_activation.SignalWorkflow

Send a signal to a workflow

Implements#

Constructors#

constructor#

new SignalWorkflow(properties?)

Constructs a new SignalWorkflow.

Parameters#

NameType
properties?ISignalWorkflow

Properties#

identity#

identity: string

SignalWorkflow identity.

Implementation of#

ISignalWorkflow.identity


input#

input: IPayload[]

SignalWorkflow input.

Implementation of#

ISignalWorkflow.input


signalName#

signalName: string

SignalWorkflow signalName.

Implementation of#

ISignalWorkflow.signalName

Methods#

toJSON#

toJSON(): Object

Converts this SignalWorkflow to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): SignalWorkflow

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

SignalWorkflow

SignalWorkflow


decodeDelimited#

Static decodeDelimited(reader): SignalWorkflow

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

SignalWorkflow

SignalWorkflow


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageSignalWorkflowSignalWorkflow
options?IConversionOptions-

Returns#

Object

Plain object