Skip to main content

Class: WFActivation

coresdk.workflow_activation.WFActivation

a cached state.

Implements#

Constructors#

constructor#

new WFActivation(properties?)

Constructs a new WFActivation.

Parameters#

NameType
properties?IWFActivation

Properties#

isReplaying#

isReplaying: boolean

Whether or not the activation is replaying past events

Implementation of#

IWFActivation.isReplaying


jobs#

jobs: IWFActivationJob[]

The things to do upon activating the workflow

Implementation of#

IWFActivation.jobs


runId#

runId: string

only ever be one active workflow task (and hence activation) of a run at one time.

Implementation of#

IWFActivation.runId


timestamp#

Optional timestamp: null | ITimestamp

The current time as understood by the workflow, which is set by workflow task started events

Implementation of#

IWFActivation.timestamp

Methods#

toJSON#

toJSON(): Object

Converts this WFActivation to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): WFActivation

Decodes a WFActivation 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#

WFActivation

WFActivation


decodeDelimited#

Static decodeDelimited(reader): WFActivation

Decodes a WFActivation 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#

WFActivation

WFActivation


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): WFActivation

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

WFActivation

WFActivation


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageWFActivationWFActivation
options?IConversionOptions-

Returns#

Object

Plain object