Skip to main content

Class: ActivityCancellationDetails

Represents an ActivityCancellationDetails.

Properties​

isCancelled​

isCancelled: boolean

ActivityCancellationDetails isCancelled.

isNotFound​

isNotFound: boolean

ActivityCancellationDetails isNotFound.

isPaused​

isPaused: boolean

ActivityCancellationDetails isPaused.

isReset​

isReset: boolean

ActivityCancellationDetails isReset.

isTimedOut​

isTimedOut: boolean

ActivityCancellationDetails isTimedOut.

isWorkerShutdown​

isWorkerShutdown: boolean

ActivityCancellationDetails isWorkerShutdown.

Methods​

toJSON()​

toJSON(): object

Converts this ActivityCancellationDetails to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ActivityCancellationDetails & $Properties

Creates a new ActivityCancellationDetails instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityCancellationDetails & $Properties

ActivityCancellationDetails instance

Call Signature​

static create(properties?): ActivityCancellationDetails

Creates a new ActivityCancellationDetails instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityCancellationDetails

ActivityCancellationDetails instance

decode()​

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

Decodes an ActivityCancellationDetails 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​

ActivityCancellationDetails & $Properties

ActivityCancellationDetails

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ActivityCancellationDetails & $Properties

Decodes an ActivityCancellationDetails message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ActivityCancellationDetails & $Properties

ActivityCancellationDetails

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

Parameters​

message​

$Properties

ActivityCancellationDetails message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ActivityCancellationDetails message, length delimited. Does not implicitly coresdk.activity_task.ActivityCancellationDetails.verify|verify messages.

Parameters​

message​

$Properties

ActivityCancellationDetails message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ActivityCancellationDetails

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ActivityCancellationDetails

ActivityCancellationDetails

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ActivityCancellationDetails

ActivityCancellationDetails

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object