Class: SignalWorkflow

coresdk.workflow_activation.SignalWorkflow

Send a signal to a workflow

Implements

• ISignalWorkflow

Constructors

constructor

• new SignalWorkflow(properties?): SignalWorkflow

Constructs a new SignalWorkflow.

Parameters

Name	Type	Description
properties?	ISignalWorkflow	Properties to set

Returns

SignalWorkflow

Properties

headers

• headers: Object

Headers attached to the signal

Index signature

▪ [k: string]: IPayload

Implementation of

ISignalWorkflow.headers

---

identity

• identity: string

Identity of the sender of the signal

Implementation of

ISignalWorkflow.identity

---

input

• input: IPayload[]

SignalWorkflow input.

Implementation of

ISignalWorkflow.input

---

signalName

• signalName: string

SignalWorkflow signalName.

Implementation of

ISignalWorkflow.signalName

Methods

toJSON

▸ toJSON(): Object

Converts this SignalWorkflow to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): SignalWorkflow

Creates a new SignalWorkflow instance using the specified properties.

Parameters

Name	Type	Description
properties?	ISignalWorkflow	Properties to set

Returns

SignalWorkflow

SignalWorkflow instance

---

decode

▸ decode(reader, length?): SignalWorkflow

Decodes a SignalWorkflow message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

SignalWorkflow

SignalWorkflow

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): SignalWorkflow

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

SignalWorkflow

SignalWorkflow

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 SignalWorkflow message. Does not implicitly coresdk.workflow_activation.SignalWorkflow.verify|verify messages.

Parameters

Name	Type	Description
message	ISignalWorkflow	SignalWorkflow message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ISignalWorkflow	SignalWorkflow message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): SignalWorkflow

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

SignalWorkflow

SignalWorkflow

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for SignalWorkflow

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	SignalWorkflow	SignalWorkflow
options?	IConversionOptions	Conversion options

Returns

Object

Plain object