net~ NodeMetadataUrlHelperMixin

A mixin class that adds SolarNode metadata support to module:net~UrlHelper.

Methods

addNodeMetadataUrl(nodeIdopt) → {string}

Generate a URL for adding metadata to a node via a POST request.

Parameters:
NameTypeAttributesDescription
nodeIdnumber<optional>

a specific node ID to use; if not provided the nodeId property of this class will be used

Returns:

the URL

Type: 
string

deleteNodeMetadataUrl(nodeIdopt) → {string}

Generate a URL for deleting the metadata of a node via a DELETE request.

Parameters:
NameTypeAttributesDescription
nodeIdnumber<optional>

a specific node ID to use; if not provided the nodeId property of this class will be used

Returns:

the URL

Type: 
string

findNodeMetadataUrl(nodeIdopt, sortsopt, paginationopt) → {string}

Generate a URL for searching for node metadata.

Parameters:
NameTypeAttributesDescription
nodeIdnumber | Array.<number><optional>

a specific node ID, or array of node IDs, to use; if not provided the nodeIds property of this class will be used, unless null is passed in which case no node IDs will be added to the URL so that all available node metadata objects will be returned

sortsArray.<module:domain~SortDescriptor><optional>

optional sort settings to use

paginationmodule:domain~Pagination<optional>

optional pagination settings to use

Returns:

the URL

Type: 
string

replaceNodeMetadataUrl(nodeIdopt) → {string}

Generate a URL for setting the metadata of a node via a PUT request.

Parameters:
NameTypeAttributesDescription
nodeIdnumber<optional>

a specific node ID to use; if not provided the nodeId property of this class will be used

Returns:

the URL

Type: 
string

viewNodeMetadataUrl(nodeIdopt) → {string}

Generate a URL for viewing the configured node's metadata.

Parameters:
NameTypeAttributesDescription
nodeIdnumber<optional>

a specific node ID to use; if not provided the nodeId property of this class will be used

Returns:

the URL

Type: 
string