Mixin: NodeDatumUrlHelperMixin

Source: net/nodeDatumUrlHelperMixin.js, line 19

Methods

availableSourcesUrl(datumFilter, withNodeIds) → {string}

Generate a URL for finding the available source IDs for a node or metadata filter.

Parameters:

Name	Type	Description
`datumFilter`	module:domain~DatumFilter	the search criteria, which can define `nodeId`, `startDate`, `endDate`, and `metadataFilter` properties to limit the results to; if `nodeId` not provided the `nodeIds` property of this class will be used
`withNodeIds`	boolean	if `true` then force the response to include node IDs along with source IDs, instead of just source IDs

Source: net/nodeDatumUrlHelperMixin.js, line 49

Returns:

the URL

Type:: string

datumFilter() → {module:domain~DatumFilter}

Get a new module:domain~DatumFilter configured with properties of this instance.

This will configure the following properties:

nodeIds
sourceIds

Source: net/nodeDatumUrlHelperMixin.js, line 175

Returns:

the filter

Type:: module:domain~DatumFilter

datumReadingUrl(datumFilter, readingType, toleranceopt, sortsopt, paginationopt) → {string}

Generate a URL for querying for datum reading values.

The datumFilter must provide the required date(s) to use for the reading type. If the reading type only requires one date, then the module:domain~DatumFilter#startDate or module:domain~DatumFilter#endDate value should be provided.

Parameters:

Name	Type	Attributes	Description
`datumFilter`	module:domain~DatumFilter		the search criteria
`readingType`	module:domain~DatumReadingType		the type of reading to find
`tolerance`	string	<optional>	optional query tolerance to use
`sorts`	Array.<module:domain~SortDescriptor>	<optional>	optional sort settings to use
`pagination`	module:domain~Pagination	<optional>	optional pagination settings to use

Source: net/nodeDatumUrlHelperMixin.js, line 99
See: https://github.com/SolarNetwork/solarnetwork/wiki/SolarQuery-API#datum-reading

Returns:

the URL

Type:: string

listDatumUrl(datumFilter, sortsopt, paginationopt) → {string}

Generate a URL for querying for datum, in either raw or aggregate form.

If the datumFilter has an aggregate value set, then aggregate results will be returned by SolarNet.

Parameters:

Name	Type	Attributes	Description
`datumFilter`	module:domain~DatumFilter		the search criteria
`sorts`	Array.<module:domain~SortDescriptor>	<optional>	optional sort settings to use
`pagination`	module:domain~Pagination	<optional>	optional pagination settings to use

Source: net/nodeDatumUrlHelperMixin.js, line 73

Returns:

the URL

Type:: string

mostRecentDatumUrl(datumFilter, sortsopt, paginationopt) → {string}

Generate a URL for querying for the most recent datum.

Parameters:

Name	Type	Attributes	Description
`datumFilter`	module:domain~DatumFilter		the search criteria
`sorts`	Array.<module:domain~SortDescriptor>	<optional>	optional sort settings to use
`pagination`	module:domain~Pagination	<optional>	optional pagination settings to use

Source: net/nodeDatumUrlHelperMixin.js, line 200

Returns:

the URL

Type:: string

reportableIntervalUrl(nodeIdopt, sourceIdsopt) → {string}

Generate a URL for the "reportable interval" for a node, optionally limited to a specific set of source IDs.

If no source IDs are provided, then the reportable interval query will return an interval for all available sources.

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
`sourceIds`	Array.<string>	<optional>	an array of source IDs to limit query to; if not provided the `sourceIds` property of this class will be used

Source: net/nodeDatumUrlHelperMixin.js, line 30

Returns:

the URL

Type:: string

streamDatumUrl(datumFilter, sortsopt, paginationopt) → {string}

Generate a URL for querying for stream datum, in either raw or aggregate form.

If the datumFilter has an aggregate value set, then aggregate results will be returned by SolarNet.

Parameters:

Name	Type	Attributes	Description
`datumFilter`	module:domain~DatumFilter		the search criteria
`sorts`	Array.<module:domain~SortDescriptor>	<optional>	optional sort settings to use
`pagination`	module:domain~Pagination	<optional>	optional pagination settings to use

Source: net/nodeDatumUrlHelperMixin.js, line 125
See: https://github.com/SolarNetwork/solarnetwork/wiki/SolarQuery-Stream-API#datum-stream-datum-list

Returns:

the URL

Type:: string

streamReadingUrl(datumFilter, readingType, toleranceopt, sortsopt, paginationopt) → {string}

Generate a URL for querying for stream reading values.

Parameters:

Name	Type	Attributes	Description
`datumFilter`	module:domain~DatumFilter		the search criteria
`readingType`	module:domain~DatumReadingType		the type of reading to find
`tolerance`	string	<optional>	optional query tolerance to use
`sorts`	Array.<module:domain~SortDescriptor>	<optional>	optional sort settings to use
`pagination`	module:domain~Pagination	<optional>	optional pagination settings to use

Source: net/nodeDatumUrlHelperMixin.js, line 151
See: https://github.com/SolarNetwork/solarnetwork/wiki/SolarQuery-Stream-API#datum-stream-reading-list

Returns:

the URL

Type:: string