Skip to main content

Class: CancelSignalWorkflow

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

Properties​

seq​

seq: number

Lang's incremental sequence number as passed to SignalExternalWorkflowExecution

Methods​

toJSON()​

toJSON(): object

Converts this CancelSignalWorkflow to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelSignalWorkflow & $Properties

Creates a new CancelSignalWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelSignalWorkflow & $Properties

CancelSignalWorkflow instance

Call Signature​

static create(properties?): CancelSignalWorkflow

Creates a new CancelSignalWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelSignalWorkflow

CancelSignalWorkflow instance

decode()​

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

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

CancelSignalWorkflow & $Properties

CancelSignalWorkflow

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CancelSignalWorkflow & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CancelSignalWorkflow & $Properties

CancelSignalWorkflow

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

Parameters​

message​

$Properties

CancelSignalWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CancelSignalWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

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

message​

CancelSignalWorkflow

CancelSignalWorkflow

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object