Class: ResolveSignalExternalWorkflow
coresdk.workflow_activation.ResolveSignalExternalWorkflow
Represents a ResolveSignalExternalWorkflow.
Properties
cause
• cause: SignalExternalWorkflowExecutionFailedCause
The server-reported cause when the signal failed. Unspecified when the signal succeeded or was cancelled before being sent.
failure
• Optional failure: null | $Properties
If populated, this signal either failed to be sent or was cancelled depending on failure type / info.
seq
• seq: number
Sequence number as provided by lang in the corresponding SignalExternalWorkflowExecution command
Methods
toJSON
▸ toJSON(): Object
Converts this ResolveSignalExternalWorkflow to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ResolveSignalExternalWorkflow & $Shape
Creates a new ResolveSignalExternalWorkflow instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
ResolveSignalExternalWorkflow & $Shape
ResolveSignalExternalWorkflow instance
▸ create(properties?): ResolveSignalExternalWorkflow
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ResolveSignalExternalWorkflow & $Shape
Decodes a ResolveSignalExternalWorkflow 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
ResolveSignalExternalWorkflow & $Shape
ResolveSignalExternalWorkflow
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ResolveSignalExternalWorkflow & $Shape
Decodes a ResolveSignalExternalWorkflow message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ResolveSignalExternalWorkflow & $Shape
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
| Name | Type | Description |
|---|---|---|
message | $Properties | ResolveSignalExternalWorkflow message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | $Properties | ResolveSignalExternalWorkflow message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ResolveSignalExternalWorkflow
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ResolveSignalExternalWorkflow message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ResolveSignalExternalWorkflow | ResolveSignalExternalWorkflow |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object