Class: ActivityTask
coresdk.activity_task.ActivityTask
Represents an ActivityTask.
Implements
Constructors
constructor
• new ActivityTask(properties?): ActivityTask
Constructs a new ActivityTask.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityTask | Properties to set |
Returns
Properties
cancel
• Optional cancel: null | ICancel
Attempt to cancel activity execution.
Implementation of
start
• Optional start: null | IStart
Start activity execution.
Implementation of
taskToken
• taskToken: Uint8Array
A unique identifier for this task
Implementation of
variant
• Optional variant: "start" | "cancel"
ActivityTask variant.
Methods
toJSON
▸ toJSON(): Object
Converts this ActivityTask to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ActivityTask
Creates a new ActivityTask instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityTask | Properties to set |
Returns
ActivityTask instance
decode
▸ decode(reader, length?): ActivityTask
Decodes an ActivityTask 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
ActivityTask
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ActivityTask
Decodes an ActivityTask message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ActivityTask
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 ActivityTask message. Does not implicitly coresdk.activity_task.ActivityTask.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityTask | ActivityTask message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ActivityTask message, length delimited. Does not implicitly coresdk.activity_task.ActivityTask.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityTask | ActivityTask message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ActivityTask
Creates an ActivityTask message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ActivityTask
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ActivityTask
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 an ActivityTask message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ActivityTask | ActivityTask |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object