Skip to main content

Class: ChildWorkflowResult

Used by core to resolve child workflow executions.

Properties​

cancelled?​

optional cancelled?: $Properties | null

ChildWorkflowResult cancelled.

completed?​

optional completed?: $Properties | null

ChildWorkflowResult completed.

failed?​

optional failed?: $Properties | null

ChildWorkflowResult failed.

status?​

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

ChildWorkflowResult status.

Methods​

toJSON()​

toJSON(): object

Converts this ChildWorkflowResult to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ChildWorkflowResult & $Shape

Creates a new ChildWorkflowResult instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ChildWorkflowResult & $Shape

ChildWorkflowResult instance

Call Signature​

static create(properties?): ChildWorkflowResult

Creates a new ChildWorkflowResult instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ChildWorkflowResult

ChildWorkflowResult instance

decode()​

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

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

ChildWorkflowResult & $Shape

ChildWorkflowResult

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ChildWorkflowResult & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ChildWorkflowResult & $Shape

ChildWorkflowResult

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

Parameters​

message​

$Properties

ChildWorkflowResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ChildWorkflowResult message, length delimited. Does not implicitly coresdk.child_workflow.ChildWorkflowResult.verify|verify messages.

Parameters​

message​

$Properties

ChildWorkflowResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ChildWorkflowResult

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ChildWorkflowResult

ChildWorkflowResult

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ChildWorkflowResult

ChildWorkflowResult

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object