Skip to main content

Class: WFActivationJob

coresdk.workflow_activation.WFActivationJob

Represents a WFActivationJob.

Implements#

Constructors#

constructor#

new WFActivationJob(properties?)

Constructs a new WFActivationJob.

Parameters#

NameType
properties?IWFActivationJob

Properties#

cancelWorkflow#

Optional cancelWorkflow: null | ICancelWorkflow

A request to cancel the workflow was received.

Implementation of#

IWFActivationJob.cancelWorkflow


fireTimer#

Optional fireTimer: null | IFireTimer

A timer has fired, allowing whatever was waiting on it (if anything) to proceed

Implementation of#

IWFActivationJob.fireTimer


notifyHasPatch#

Optional notifyHasPatch: null | INotifyHasPatch

command being sent first.

Implementation of#

IWFActivationJob.notifyHasPatch


queryWorkflow#

Optional queryWorkflow: null | IQueryWorkflow

A request to query the workflow was received.

Implementation of#

IWFActivationJob.queryWorkflow


removeFromCache#

Optional removeFromCache: null | boolean

will be set to true if this is the variant.

Implementation of#

IWFActivationJob.removeFromCache


resolveActivity#

Optional resolveActivity: null | IResolveActivity

An activity was resolved, result could be completed, failed or cancelled

Implementation of#

IWFActivationJob.resolveActivity


resolveChildWorkflowExecution#

Optional resolveChildWorkflowExecution: null | IResolveChildWorkflowExecution

A child workflow was resolved, result could be completed or failed

Implementation of#

IWFActivationJob.resolveChildWorkflowExecution


resolveChildWorkflowExecutionStart#

Optional resolveChildWorkflowExecutionStart: null | IResolveChildWorkflowExecutionStart

A child workflow execution has started or failed to start

Implementation of#

IWFActivationJob.resolveChildWorkflowExecutionStart


resolveRequestCancelExternalWorkflow#

Optional resolveRequestCancelExternalWorkflow: null | IResolveRequestCancelExternalWorkflow

An attempt to cancel an external workflow resolved

Implementation of#

IWFActivationJob.resolveRequestCancelExternalWorkflow


resolveSignalExternalWorkflow#

Optional resolveSignalExternalWorkflow: null | IResolveSignalExternalWorkflow

An attempt to signal an external workflow resolved

Implementation of#

IWFActivationJob.resolveSignalExternalWorkflow


signalWorkflow#

Optional signalWorkflow: null | ISignalWorkflow

A request to signal the workflow was received.

Implementation of#

IWFActivationJob.signalWorkflow


startWorkflow#

Optional startWorkflow: null | IStartWorkflow

Begin a workflow for the first time

Implementation of#

IWFActivationJob.startWorkflow


updateRandomSeed#

Optional updateRandomSeed: null | IUpdateRandomSeed

Workflow was reset. The randomness seed must be updated.

Implementation of#

IWFActivationJob.updateRandomSeed


variant#

Optional variant: "startWorkflow" | "fireTimer" | "updateRandomSeed" | "queryWorkflow" | "cancelWorkflow" | "signalWorkflow" | "resolveActivity" | "notifyHasPatch" | "resolveChildWorkflowExecutionStart" | "resolveChildWorkflowExecution" | "resolveSignalExternalWorkflow" | "resolveRequestCancelExternalWorkflow" | "removeFromCache"

WFActivationJob variant.

Methods#

toJSON#

toJSON(): Object

Converts this WFActivationJob to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): WFActivationJob

Decodes a WFActivationJob message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

WFActivationJob

WFActivationJob


decodeDelimited#

Static decodeDelimited(reader): WFActivationJob

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

WFActivationJob

WFActivationJob


encode#

Static encode(message, writer?): Writer

Encodes the specified WFActivationJob message. Does not implicitly {@link coresdk.workflow_activation.WFActivationJob.verify|verify} messages.

Parameters#

NameTypeDescription
messageIWFActivationJobWFActivationJob message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified WFActivationJob message, length delimited. Does not implicitly {@link coresdk.workflow_activation.WFActivationJob.verify|verify} messages.

Parameters#

NameTypeDescription
messageIWFActivationJobWFActivationJob message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): WFActivationJob

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

WFActivationJob

WFActivationJob


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageWFActivationJobWFActivationJob
options?IConversionOptions-

Returns#

Object

Plain object