Skip to main content

Class: CancelNexusTask

Represents a CancelNexusTask.

Properties​

reason​

reason: NexusTaskCancelReason

Why Core is asking for this operation to be cancelled

taskToken​

taskToken: Uint8Array

The task token from the PollNexusTaskQueueResponse

Methods​

toJSON()​

toJSON(): object

Converts this CancelNexusTask to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelNexusTask & $Properties

Creates a new CancelNexusTask instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelNexusTask & $Properties

CancelNexusTask instance

Call Signature​

static create(properties?): CancelNexusTask

Creates a new CancelNexusTask instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelNexusTask

CancelNexusTask instance

decode()​

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

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

CancelNexusTask & $Properties

CancelNexusTask

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CancelNexusTask & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CancelNexusTask & $Properties

CancelNexusTask

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

Parameters​

message​

$Properties

CancelNexusTask message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CancelNexusTask message, length delimited. Does not implicitly coresdk.nexus.CancelNexusTask.verify|verify messages.

Parameters​

message​

$Properties

CancelNexusTask message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CancelNexusTask

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CancelNexusTask

CancelNexusTask

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CancelNexusTask

CancelNexusTask

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object