Class: NexusTaskCompletion
coresdk.nexus.NexusTaskCompletion
A response to a Nexus task
Properties
ackCancel
• Optional ackCancel: null | boolean
The lang SDK acknowledges that it is responding to a CancelNexusTask and thus the
response is irrelevant. This is not the only way to respond to a cancel, the other
variants can still be used, but this variant should be used when the handler was aborted
by cancellation.
completed
• Optional completed: null | $Properties
The handler completed (successfully or not). Note that the response kind must match the request kind (start or cancel).
error
• Optional error: null | $Properties
The handler could not complete the request for some reason. Deprecated, use failure.
failure
• Optional failure: null | $Properties
The handler could not complete the request for some reason.
status
• Optional status: "completed" | "error" | "ackCancel" | "failure"
NexusTaskCompletion status.
taskToken
• taskToken: Uint8Array
The unique identifier for this task provided in the poll response
Methods
toJSON
▸ toJSON(): Object
Converts this NexusTaskCompletion to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusTaskCompletion & $Shape
Creates a new NexusTaskCompletion instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
NexusTaskCompletion instance
▸ create(properties?): NexusTaskCompletion
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): NexusTaskCompletion & $Shape
Decodes a NexusTaskCompletion 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
NexusTaskCompletion
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusTaskCompletion & $Shape
Decodes a NexusTaskCompletion message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusTaskCompletion
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 NexusTaskCompletion message. Does not implicitly coresdk.nexus.NexusTaskCompletion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusTaskCompletion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusTaskCompletion message, length delimited. Does not implicitly coresdk.nexus.NexusTaskCompletion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusTaskCompletion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusTaskCompletion
Creates a NexusTaskCompletion message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusTaskCompletion
toObject
▸ toObject(message, options?): Object
Creates a plain object from a NexusTaskCompletion message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusTaskCompletion | NexusTaskCompletion |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object