Skip to main content

Class: ResolveSignalExternalWorkflow

coresdk.workflow_activation.ResolveSignalExternalWorkflow

Represents a ResolveSignalExternalWorkflow.

Implements​

Constructors​

constructor​

β€’ new ResolveSignalExternalWorkflow(properties?): ResolveSignalExternalWorkflow

Constructs a new ResolveSignalExternalWorkflow.

Parameters​

NameTypeDescription
properties?IResolveSignalExternalWorkflowProperties to set

Returns​

ResolveSignalExternalWorkflow

Properties​

failure​

β€’ Optional failure: null | IFailure

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

Implementation of​

IResolveSignalExternalWorkflow.failure


seq​

β€’ seq: number

Sequence number as provided by lang in the corresponding SignalExternalWorkflowExecution command

Implementation of​

IResolveSignalExternalWorkflow.seq

Methods​

toJSON​

β–Έ toJSON(): Object

Converts this ResolveSignalExternalWorkflow to JSON.

Returns​

Object

JSON object


create​

β–Έ create(properties?): ResolveSignalExternalWorkflow

Creates a new ResolveSignalExternalWorkflow instance using the specified properties.

Parameters​

NameTypeDescription
properties?IResolveSignalExternalWorkflowProperties to set

Returns​

ResolveSignalExternalWorkflow

ResolveSignalExternalWorkflow instance


decode​

β–Έ decode(reader, length?): ResolveSignalExternalWorkflow

Decodes a ResolveSignalExternalWorkflow message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

ResolveSignalExternalWorkflow

ResolveSignalExternalWorkflow

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

β–Έ decodeDelimited(reader): ResolveSignalExternalWorkflow

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ResolveSignalExternalWorkflow

ResolveSignalExternalWorkflow

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

β–Έ encode(message, writer?): Writer

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

Parameters​

NameTypeDescription
messageIResolveSignalExternalWorkflowResolveSignalExternalWorkflow message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

β–Έ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
messageIResolveSignalExternalWorkflowResolveSignalExternalWorkflow message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

β–Έ fromObject(object): ResolveSignalExternalWorkflow

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ResolveSignalExternalWorkflow

ResolveSignalExternalWorkflow


getTypeUrl​

β–Έ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ResolveSignalExternalWorkflow

Parameters​

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns​

string

The default type url


toObject​

β–Έ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageResolveSignalExternalWorkflowResolveSignalExternalWorkflow
options?IConversionOptionsConversion options

Returns​

Object

Plain object