Skip to main content

Class: SignalWorkflowExecutionResponse

Represents a SignalWorkflowExecutionResponse.

Properties​

optional link?: $Properties | null

Link to be associated with the WorkflowExecutionSignaled event. Added on the response to propagate the backlink. Available from Temporal server 1.31 and up.

Methods​

toJSON()​

toJSON(): object

Converts this SignalWorkflowExecutionResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SignalWorkflowExecutionResponse & $Shape

Creates a new SignalWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

SignalWorkflowExecutionResponse & $Shape

SignalWorkflowExecutionResponse instance

Call Signature​

static create(properties?): SignalWorkflowExecutionResponse

Creates a new SignalWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalWorkflowExecutionResponse

SignalWorkflowExecutionResponse instance

decode()​

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

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

SignalWorkflowExecutionResponse & $Shape

SignalWorkflowExecutionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SignalWorkflowExecutionResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SignalWorkflowExecutionResponse & $Shape

SignalWorkflowExecutionResponse

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 SignalWorkflowExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.SignalWorkflowExecutionResponse.verify|verify messages.

Parameters​

message​

$Properties

SignalWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified SignalWorkflowExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SignalWorkflowExecutionResponse.verify|verify messages.

Parameters​

message​

$Properties

SignalWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SignalWorkflowExecutionResponse

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

Parameters​

object​

Plain object

Returns​

SignalWorkflowExecutionResponse

SignalWorkflowExecutionResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SignalWorkflowExecutionResponse

SignalWorkflowExecutionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object