Skip to main content

Class: CancelActivityCommand

Cancel an activity if it is still running. Otherwise, do nothing.

Properties​

taskToken​

taskToken: Uint8Array

CancelActivityCommand taskToken.

Methods​

toJSON()​

toJSON(): object

Converts this CancelActivityCommand to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelActivityCommand & $Properties

Creates a new CancelActivityCommand instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelActivityCommand & $Properties

CancelActivityCommand instance

Call Signature​

static create(properties?): CancelActivityCommand

Creates a new CancelActivityCommand instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelActivityCommand

CancelActivityCommand instance

decode()​

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

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

CancelActivityCommand & $Properties

CancelActivityCommand

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CancelActivityCommand & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CancelActivityCommand & $Properties

CancelActivityCommand

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 CancelActivityCommand message. Does not implicitly temporal.api.worker.v1.CancelActivityCommand.verify|verify messages.

Parameters​

message​

$Properties

CancelActivityCommand message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CancelActivityCommand message, length delimited. Does not implicitly temporal.api.worker.v1.CancelActivityCommand.verify|verify messages.

Parameters​

message​

$Properties

CancelActivityCommand message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CancelActivityCommand

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

Parameters​

object​

Plain object

Returns​

CancelActivityCommand

CancelActivityCommand

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CancelActivityCommand

CancelActivityCommand

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object