Skip to main content

Class: CompleteWorkflowExecution

coresdk.workflow_commands.CompleteWorkflowExecution

Issued when the workflow completes successfully

Implements#

Constructors#

constructor#

new CompleteWorkflowExecution(properties?)

Constructs a new CompleteWorkflowExecution.

Parameters#

NameType
properties?ICompleteWorkflowExecution

Properties#

result#

Optional result: null | IPayload

CompleteWorkflowExecution result.

Implementation of#

ICompleteWorkflowExecution.result

Methods#

toJSON#

toJSON(): Object

Converts this CompleteWorkflowExecution to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): CompleteWorkflowExecution

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

CompleteWorkflowExecution

CompleteWorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): CompleteWorkflowExecution

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

CompleteWorkflowExecution

CompleteWorkflowExecution


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): CompleteWorkflowExecution

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

CompleteWorkflowExecution

CompleteWorkflowExecution


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageCompleteWorkflowExecutionCompleteWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object