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