Mixin: NodeInstructionUrlHelperMixin

Source: net/nodeInstructionUrlHelperMixin.js, line 18

Methods

queueInstructionUrl(topic, parametersopt, nodeIdopt) → {string}

Generate a URL for posting an instruction request.

Parameters:

Name	Type	Attributes	Description
`topic`	string		the instruction topic
`parameters`	Array.<Object>	<optional>	an array of parameter objects in the form `{name:n1, value:v1}`
`nodeId`	number	<optional>	a specific node ID to use; if not provided the `nodeId` property of this class will be used

Source: net/nodeInstructionUrlHelperMixin.js, line 103

Returns:

the URL

Type:: string

queueInstructionsUrl(topic, parametersopt, nodeIdsopt) → {string}

Generate a URL for posting instruction requests for multiple nodes.

Parameters:

Name	Type	Attributes	Description
`topic`	string		the instruction topic
`parameters`	Array.<Object>	<optional>	an array of parameter objects in the form `{name:n1, value:v1}`
`nodeIds`	Array.<number>	<optional>	a list of node IDs to use; if not provided the `nodeIds` property of this class will be used

Source: net/nodeInstructionUrlHelperMixin.js, line 124

Returns:

the URL

Type:: string

updateInstructionStateUrl(instructionId, state) → {string}

Generate a URL for changing the state of an instruction.

Parameters:

Name	Type	Description
`instructionId`	number	the instruction ID to update
`state`	InstructionState	the instruction state to set

Source: net/nodeInstructionUrlHelperMixin.js, line 57
See: the InstructionStates enum for possible state values

Returns:

the URL

Type:: string

urlEncodeInstructionParameters(parametersopt) → {string}

Generate URL encoded query string for posting instruction parameters.

Parameters:

Name	Type	Attributes	Description
`parameters`	Array.<Object>	<optional>	an array of parameter objects in the form `{name:n1, value:v1}`

Source: net/nodeInstructionUrlHelperMixin.js, line 73

Returns:

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.

Parameters:

Name	Type	Attributes	Description
`nodeId`	number	<optional>	a specific node ID to use; if not provided the `nodeId` property of this class will be used

Source: net/nodeInstructionUrlHelperMixin.js, line 35

Returns:

the URL

Type:: string

viewInstructionUrl(instructionId) → {string}

Generate a URL to get all details for a specific instruction.

Parameters:

Name	Type	Description
`instructionId`	number	the instruction ID to get

Source: net/nodeInstructionUrlHelperMixin.js, line 25

Returns:

the URL

Type:: string

viewPendingInstructionsUrl(nodeIdopt) → {string}

Generate a URL for viewing pending instructions.

Parameters:

Name	Type	Attributes	Description
`nodeId`	number	<optional>	a specific node ID to use; if not provided the `nodeId` property of this class will be used

Source: net/nodeInstructionUrlHelperMixin.js, line 45

Returns:

the URL

Type:: string

(static) instructionParameter(name, value) → {object}

Create an instruction parameter suitable to passing to NodeInstructionUrlHelperMixin#queueInstructionUrl.

Parameters:

Name	Type	Description
`name`	string	the parameter name
`value`	*	the parameter value

Source: net/nodeInstructionUrlHelperMixin.js, line 148

Returns:

with name and value properties

Type:: object