nexus.command.device. process
Source: src/
Methods
end(deviceId, processId) → Promise containing ApiResponse
dispatches a command to end a process on the device
Parameters
Name | Type | Optional | Description |
---|---|---|---|
deviceId |
string |
|
|
processId |
string |
|
- Returns
-
Promise containing ApiResponse
goToNextPhase(deviceId, processId) → Promise containing ApiResponse
dispatches a command to transition a process on the device into the next phase
Parameters
Name | Type | Optional | Description |
---|---|---|---|
deviceId |
string |
|
|
processId |
string |
|
- Returns
-
Promise containing ApiResponse
pause(deviceId, processId) → Promise containing ApiResponse
dispatches a command to pause a process on the device
Parameters
Name | Type | Optional | Description |
---|---|---|---|
deviceId |
string |
|
|
processId |
string |
|
- Returns
-
Promise containing ApiResponse
resume(deviceId, processId) → Promise containing ApiResponse
dispatches a command to resume a process on the device
Parameters
Name | Type | Optional | Description |
---|---|---|---|
deviceId |
string |
|
|
processId |
string |
|
- Returns
-
Promise containing ApiResponse
start(deviceId, processId) → Promise containing ApiResponse
dispatches a command to start a process on the device
Parameters
Name | Type | Optional | Description |
---|---|---|---|
deviceId |
string |
|
|
processId |
string |
|
- Returns
-
Promise containing ApiResponse
updateRunning(deviceId, processId, params) → Promise containing ApiResponse
dispatches a command to update a running process on the device
Parameters
Name | Type | Optional | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
deviceId |
string |
|
|||||||||||||
processId |
string |
|
|||||||||||||
params |
Object |
|
Values in
|
- Returns
-
Promise containing ApiResponse