Skip to main content

Class: ResolveSignalExternalWorkflow

Represents a ResolveSignalExternalWorkflow.

Properties​

cause​

cause: SignalExternalWorkflowExecutionFailedCause

The server-reported cause when the signal failed. Unspecified when the signal succeeded or was cancelled before being sent.


failure?​

optional failure?: $Properties | null

If populated, this signal either failed to be sent or was cancelled depending on failure type / info.


seq​

seq: number

Sequence number as provided by lang in the corresponding SignalExternalWorkflowExecution command

Methods​

toJSON()​

toJSON(): object

Converts this ResolveSignalExternalWorkflow to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): ResolveSignalExternalWorkflow & $Shape

Creates a new ResolveSignalExternalWorkflow instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ResolveSignalExternalWorkflow & $Shape

ResolveSignalExternalWorkflow instance

Call Signature​

static create(properties?): ResolveSignalExternalWorkflow

Creates a new ResolveSignalExternalWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ResolveSignalExternalWorkflow

ResolveSignalExternalWorkflow instance


decode()​

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

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

ResolveSignalExternalWorkflow & $Shape

ResolveSignalExternalWorkflow

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): ResolveSignalExternalWorkflow & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ResolveSignalExternalWorkflow & $Shape

ResolveSignalExternalWorkflow

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

Parameters​

message​

$Properties

ResolveSignalExternalWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ResolveSignalExternalWorkflow message, length delimited. Does not implicitly coresdk.workflow_activation.ResolveSignalExternalWorkflow.verify|verify messages.

Parameters​

message​

$Properties

ResolveSignalExternalWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): ResolveSignalExternalWorkflow

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ResolveSignalExternalWorkflow

ResolveSignalExternalWorkflow


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ResolveSignalExternalWorkflow

ResolveSignalExternalWorkflow

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object