Skip to main content

Class: NexusOperationResult

Used by core to resolve nexus operations.

Properties​

cancelled?​

optional cancelled?: $Properties | null

NexusOperationResult cancelled.

completed?​

optional completed?: $Properties | null

NexusOperationResult completed.

failed?​

optional failed?: $Properties | null

NexusOperationResult failed.

status?​

optional status?: "completed" | "failed" | "cancelled" | "timedOut"

NexusOperationResult status.

timedOut?​

optional timedOut?: $Properties | null

NexusOperationResult timedOut.

Methods​

toJSON()​

toJSON(): object

Converts this NexusOperationResult to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NexusOperationResult & $Shape

Creates a new NexusOperationResult instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

NexusOperationResult & $Shape

NexusOperationResult instance

Call Signature​

static create(properties?): NexusOperationResult

Creates a new NexusOperationResult instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusOperationResult

NexusOperationResult instance

decode()​

static decode(reader, length?): NexusOperationResult & $Shape

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

NexusOperationResult & $Shape

NexusOperationResult

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NexusOperationResult & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NexusOperationResult & $Shape

NexusOperationResult

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

Parameters​

message​

$Properties

NexusOperationResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NexusOperationResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NexusOperationResult

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

NexusOperationResult

NexusOperationResult

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NexusOperationResult

NexusOperationResult

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object