Mixin: UserUrlHelperMixin

Members

---

userId

Get the default user ID.

This gets the first available user ID from the userIds property.

---

userId

Set the user ID.

This will set the userIds property to a new array of just the given value.

Methods

---

baseUrl()

Get the base URL to the SolarUser v1 REST API.

The returned URL uses the configured environment to resolve the hostUrl and a solarUserPath context path. If the context path is not available, it will default to /solaruser.

Returns:

the base URL to SolarUser

Type

string

---

updateNodeArchivedStatusUrl(nodeId, archived)

Generate a URL to update the archived status of a set of nodes via a POST request.

Parameters:

Name	Type	Description
nodeId	number | Array.<number> | null	a specific node ID, or array of node IDs, to update; if not provided the nodeIds property of this class will be used
archived	boolean	true to mark the nodes as archived; false to un-mark and return to normal status

Returns:

the URL to update the nodes archived status

Type

string

---

viewArchivedNodesUrl()

Generate a URL to get a list of all archived nodes for the user account.

Returns:

the URL to access the user's archived nodes

Type

string

---

viewNodesUrl()

Generate a URL to get a list of all active nodes for the user account.

Returns:

the URL to access the user's active nodes

Type

string

---

viewPendingNodesUrl()

Generate a URL to get a list of all pending nodes for the user account.

Returns:

the URL to access the user's pending nodes

Type

string