- Source:
Members
accepted
Gets if the goal response was accepted.
- Deprecated:
- use isAccepted()
- Source:
goalId
Gets the goal Id.
- Source:
stamp
Gets the goal response timestamp.
- Source:
status
Gets the goal status.
- Source:
status
Update status to the latest state of goal computation.
When status is in a final state it can not be revered to an
earlier state, e.g., can not change from SUCCEEDED to ACCEPTED.
- Source:
Methods
cancelGoal() → {Promise}
Send a cancel request for the goal.
- Source:
Returns:
- The cancel response.
- Type
- Promise
getResult() → {Promise}
Request the result for the goal.
- Source:
Returns:
- The result response.
- Type
- Promise
isAborted() → {bool}
Determine if goal has been aborted.
- Source:
Returns:
- True if goal was aborted; otherwise return false.
- Type
- bool
isAccepted() → {bool}
Determine if goal is currently executing
- Source:
Returns:
- True if goal is executing; otherwise return false.
- Type
- bool
isCanceled() → {bool}
Determine if goal has been canceled.
- Source:
Returns:
- True if goal has been aborted; otherwise return false.
- Type
- bool
isCanceling() → {bool}
Determine if goal is in the process of canceling.
- Source:
Returns:
- True if goal is canceling; otherwise return false.
- Type
- bool
isExecuting() → {bool}
Determine if goal is currently executing
- Source:
Returns:
- True if goal is executing; otherwise return false.
- Type
- bool
isSucceeded() → {bool}
Determine if goal completed successfullly.
- Source:
Returns:
- True if goal completed successfully; otherwise return false.
- Type
- bool