Skip to main content

Class: CancelWorkflow

coresdk.workflow_activation.CancelWorkflow

Cancel a running workflow

Implements#

Constructors#

constructor#

new CancelWorkflow(properties?)

Constructs a new CancelWorkflow.

Parameters#

NameType
properties?ICancelWorkflow

Properties#

details#

details: IPayload[]

Information from the cancellation request

Implementation of#

ICancelWorkflow.details

Methods#

toJSON#

toJSON(): Object

Converts this CancelWorkflow to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): CancelWorkflow

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

CancelWorkflow

CancelWorkflow


decodeDelimited#

Static decodeDelimited(reader): CancelWorkflow

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

CancelWorkflow

CancelWorkflow


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

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#

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

NameTypeDescription
messageCancelWorkflowCancelWorkflow
options?IConversionOptions-

Returns#

Object

Plain object