- Source:
Members
goalId
Gets the goal Id.
- Source:
isActive
Gets if the goal handle is active.
- Source:
isCancelRequested
Gets if cancellation was requested.
- Source:
request
Gets the goal request.
- Source:
status
Gets the status of the goal.
- Source:
Methods
abort() → {undefined}
Updates the goal handle with the abort status.
- Source:
Returns:
- Type
- undefined
canceled() → {undefined}
Updates the goal handle with the canceled status.
- Source:
Returns:
- Type
- undefined
execute(callback) → {undefined}
Updates the goal handle with the execute status and begins exection.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | An optional callback to use instead of the one provided to the action server. |
- Source:
Returns:
- Type
- undefined
publishFeedback(feedback) → {undefined}
Sends feedback back to the client.
Parameters:
| Name | Type | Description |
|---|---|---|
feedback |
object | The feedback to send back. |
- Source:
Returns:
- Type
- undefined
succeed() → {undefined}
Updates the goal handle with the succeed status.
- Source:
Returns:
- Type
- undefined