Skip to main content

Class: CancelSignalWorkflow

coresdk.workflow_commands.CancelSignalWorkflow

Can be used to cancel not-already-sent SignalExternalWorkflowExecution commands

Implements#

Constructors#

constructor#

new CancelSignalWorkflow(properties?)

Constructs a new CancelSignalWorkflow.

Parameters#

NameType
properties?ICancelSignalWorkflow

Properties#

seq#

seq: number

Lang's incremental sequence number as passed to SignalExternalWorkflowExecution

Implementation of#

ICancelSignalWorkflow.seq

Methods#

toJSON#

toJSON(): Object

Converts this CancelSignalWorkflow to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): CancelSignalWorkflow

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

CancelSignalWorkflow

CancelSignalWorkflow


decodeDelimited#

Static decodeDelimited(reader): CancelSignalWorkflow

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

CancelSignalWorkflow

CancelSignalWorkflow


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): CancelSignalWorkflow

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

CancelSignalWorkflow

CancelSignalWorkflow


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageCancelSignalWorkflowCancelSignalWorkflow
options?IConversionOptions-

Returns#

Object

Plain object