Class: CancelWorkflow
coresdk.workflow_activation.CancelWorkflow
Cancel a running workflow
Properties
reason
• reason: string
User-specified reason the cancel request was issued
Methods
toJSON
▸ toJSON(): Object
Converts this CancelWorkflow to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelWorkflow & $Properties
Creates a new CancelWorkflow instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CancelWorkflow instance
▸ create(properties?): CancelWorkflow
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CancelWorkflow & $Properties
Decodes a CancelWorkflow 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
CancelWorkflow
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelWorkflow & $Properties
Decodes a CancelWorkflow message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelWorkflow
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 CancelWorkflow message. Does not implicitly coresdk.workflow_activation.CancelWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelWorkflow message, length delimited. Does not implicitly coresdk.workflow_activation.CancelWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelWorkflow
Creates a CancelWorkflow message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelWorkflow
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CancelWorkflow message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelWorkflow | CancelWorkflow |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object