Methods
queueInstructionUrl(topic, parametersopt, nodeIdopt) → {string}
Generate a URL for posting an instruction request.
Name | Type | Attributes | Description |
---|---|---|---|
topic | string | the instruction topic | |
parameters | Array.<Object> | <optional> | an array of parameter objects in the form |
nodeId | number | <optional> | a specific node ID to use; if not provided the |
the URL
- Type:
- string
queueInstructionsUrl(topic, parametersopt, nodeIdsopt) → {string}
Generate a URL for posting instruction requests for multiple nodes.
Name | Type | Attributes | Description |
---|---|---|---|
topic | string | the instruction topic | |
parameters | Array.<Object> | <optional> | an array of parameter objects in the form |
nodeIds | Array.<number> | <optional> | a list of node IDs to use; if not provided the |
the URL
- Type:
- string
updateInstructionStateUrl(instructionId, state) → {string}
Generate a URL for changing the state of an instruction.
Name | Type | Description |
---|---|---|
instructionId | number | the instruction ID to update |
state | InstructionState | the instruction state to set |
- See
- the InstructionStates enum for possible state values
the URL
- Type:
- string
urlEncodeInstructionParameters(parametersopt) → {string}
Generate URL encoded query string for posting instruction parameters.
Name | Type | Attributes | Description |
---|---|---|---|
parameters | Array.<Object> | <optional> | an array of parameter objects in the form |
the URL encoded query string, or an empty string if parameters
is empty
- Type:
- string
viewActiveInstructionsUrl(nodeIdopt) → {string}
Generate a URL for viewing active instructions.
Name | Type | Attributes | Description |
---|---|---|---|
nodeId | number | <optional> | a specific node ID to use; if not provided the |
the URL
- Type:
- string
viewInstructionUrl(instructionId) → {string}
Generate a URL to get all details for a specific instruction.
Name | Type | Description |
---|---|---|
instructionId | number | the instruction ID to get |
the URL
- Type:
- string
viewPendingInstructionsUrl(nodeIdopt) → {string}
Generate a URL for viewing pending instructions.
Name | Type | Attributes | Description |
---|---|---|---|
nodeId | number | <optional> | a specific node ID to use; if not provided the |
the URL
- Type:
- string
(static) instructionParameter(name, value) → {object}
Create an instruction parameter suitable to passing to NodeInstructionUrlHelperMixin#queueInstructionUrl.
Name | Type | Description |
---|---|---|
name | string | the parameter name |
value | * | the parameter value |
with name
and value
properties
- Type:
- object