new Action(data, object)
An action to be control execution on a remote object
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | Action data |
object |
ServiceObject | reference to owner object |
- Source:
Extends
Members
getObject
- Overrides:
- Source:
Methods
cancel() → {Promise}
Cancel a launched action
- Source:
Returns:
Promise callback with result
- Type
- Promise
cancel() → {Promise}
Cancel a launched action
- Source:
Returns:
Promise callback with result
- Type
- Promise
exportProperties()
Exposes setter and getter for a class from the `data` field
- Overrides:
- Source:
getClient() → {Client}
Return the client reference
- Overrides:
- Source:
Returns:
client
- Type
- Client
getContainer() → {Raptor}
Return the Raptor instance wrapper
- Overrides:
- Source:
Returns:
container Raptor instance reference
- Type
- Raptor
invoke(body) → {Promise}
Invoke the ServiceObject action
Parameters:
| Name | Type | Description |
|---|---|---|
body |
String | The body of the request as STRING |
- Source:
Returns:
Promise callback with result
- Type
- Promise
invoke(body) → {Promise}
Invoke the ServiceObject action
Parameters:
| Name | Type | Description |
|---|---|---|
body |
String | The body of the request as STRING |
- Source:
Returns:
Promise callback with result
- Type
- Promise
parseJSON(raw)
Parse a plain object and populate the corresponding fields in the current instance
Parameters:
| Name | Type | Description |
|---|---|---|
raw |
Object | the json object |
- Overrides:
- Source:
reset()
Reset the status of an action
- Source:
reset()
Reset the status of an action
- Source:
setContainer(container)
Parameters:
| Name | Type | Description |
|---|---|---|
container |
Raptor | reference to Raptor instance wrapper |
- Overrides:
- Source:
setServiceObject(object)
Set a reference to the parent object
Parameters:
| Name | Type | Description |
|---|---|---|
object |
ServiceObject | reference to the parent object |
- Overrides:
- Source:
status(newStatus) → {Promise}
Get the status of an action
Parameters:
| Name | Type | Description |
|---|---|---|
newStatus |
mixed | optional, set a new status of the action |
- Source:
Returns:
Promise callback with result
- Type
- Promise
status(newStatus) → {Promise}
Get the status of an action
Parameters:
| Name | Type | Description |
|---|---|---|
newStatus |
mixed | optional, set a new status of the action |
- Source:
Returns:
Promise callback with result
- Type
- Promise
subscribe()
Subscribe to receive updates for an action
- Source:
subscribe()
Unsubscribe from updates for an action
- Source:
subscribe()
Subscribe to receive updates for an action
- Source:
subscribe()
Unsubscribe from updates for an action
- Source:
toJSON() → {Object}
Convert the instance to a js object
- Overrides:
- Source:
Returns:
Plain js object
- Type
- Object
toString() → {String}
Return a JSON string of this object
- Overrides:
- Source:
Returns:
json stringified JSON
- Type
- String
validate() → {void}
Validate the object and throw an exception if fails
- Overrides:
- Source:
Returns:
- Type
- void