Skip to main content

Class: CancelWorkflow

Cancel a running workflow

Properties​

reason​

reason: string

User-specified reason the cancel request was issued

Methods​

toJSON()​

toJSON(): object

Converts this CancelWorkflow to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelWorkflow & $Properties

Creates a new CancelWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelWorkflow & $Properties

CancelWorkflow instance

Call Signature​

static create(properties?): CancelWorkflow

Creates a new CancelWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelWorkflow

CancelWorkflow instance

decode()​

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

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

CancelWorkflow & $Properties

CancelWorkflow

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CancelWorkflow & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CancelWorkflow & $Properties

CancelWorkflow

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

Parameters​

message​

$Properties

CancelWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CancelWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CancelWorkflow

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CancelWorkflow

CancelWorkflow

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CancelWorkflow

CancelWorkflow

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object