Skip to main content

Class: ActivityExecutionResult

Used to report activity completions to core

Properties​

cancelled?​

optional cancelled?: $Properties | null

ActivityExecutionResult cancelled.

completed?​

optional completed?: $Properties | null

ActivityExecutionResult completed.

failed?​

optional failed?: $Properties | null

ActivityExecutionResult failed.

status?​

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

ActivityExecutionResult status.

willCompleteAsync?​

optional willCompleteAsync?: $Properties | null

ActivityExecutionResult willCompleteAsync.

Methods​

toJSON()​

toJSON(): object

Converts this ActivityExecutionResult to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ActivityExecutionResult & $Shape

Creates a new ActivityExecutionResult instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ActivityExecutionResult & $Shape

ActivityExecutionResult instance

Call Signature​

static create(properties?): ActivityExecutionResult

Creates a new ActivityExecutionResult instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityExecutionResult

ActivityExecutionResult instance

decode()​

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

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

ActivityExecutionResult & $Shape

ActivityExecutionResult

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ActivityExecutionResult & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ActivityExecutionResult & $Shape

ActivityExecutionResult

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

Parameters​

message​

$Properties

ActivityExecutionResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ActivityExecutionResult message, length delimited. Does not implicitly coresdk.activity_result.ActivityExecutionResult.verify|verify messages.

Parameters​

message​

$Properties

ActivityExecutionResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ActivityExecutionResult

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ActivityExecutionResult

ActivityExecutionResult

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ActivityExecutionResult

ActivityExecutionResult

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object