Class: CancelSignalWorkflow
coresdk.workflow_commands.CancelSignalWorkflow
Can be used to cancel not-already-sent SignalExternalWorkflowExecution commands
Properties
seq
• seq: number
Lang's incremental sequence number as passed to SignalExternalWorkflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this CancelSignalWorkflow to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelSignalWorkflow & $Properties
Creates a new CancelSignalWorkflow instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CancelSignalWorkflow & $Properties
CancelSignalWorkflow instance
▸ create(properties?): CancelSignalWorkflow
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CancelSignalWorkflow & $Properties
Decodes a CancelSignalWorkflow 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
CancelSignalWorkflow & $Properties
CancelSignalWorkflow
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelSignalWorkflow & $Properties
Decodes a CancelSignalWorkflow message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelSignalWorkflow & $Properties
CancelSignalWorkflow
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 CancelSignalWorkflow message. Does not implicitly coresdk.workflow_commands.CancelSignalWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelSignalWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelSignalWorkflow message, length delimited. Does not implicitly coresdk.workflow_commands.CancelSignalWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelSignalWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelSignalWorkflow
Creates a CancelSignalWorkflow message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelSignalWorkflow
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CancelSignalWorkflow message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelSignalWorkflow | CancelSignalWorkflow |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object