Constructor
new UserMetadataUrlHelper()
Extends
Members
environment :module:net~Environment
The environment associated with this helper.
- Inherited From
- Source
(readonly) parameters :module:util~Configuration
Get a parameters object that can be used to hold URL variables.
- Inherited From
- Source
Methods
(abstract) baseUrl() → {string}
Get the base URL to the REST API.
This implementation is a stub, meant for subclasses to override. This implementation simply returns module:net~UrlHelper#hostUrl.
- Inherited From
- Source
the base URL to the REST API
- Type:
- string
env(key, valopt) → {object}
Get or set an environment parameter.
This is a shortcut for calling module:net~Configuration#value on the environment
object.
Name | Type | Attributes | Description |
---|---|---|---|
key | string | the environment parameter name to get | |
val | object | <optional> | the optional value to set |
- Inherited From
- Source
when called as a getter, the environment parameter value; when called as a setter, the environment parameters object
- Type:
- object
hostUrl() → {string}
Get a URL for just the SolarNet host, without any path.
This method constructs an absolute URL based on the following properties configured on this instance's module:net~Environment:
- If environment.useTls() returns
true
then use HTTPS as the protocol, otherwise HTTP. - Use
host
for the host name or IP address, unlessproxyHost
is available. - Use
port
for the port, unlessproxyPort
is available. If neither are available, use443
for HTTPS or80
for HTTP.
- Inherited From
- Source
the URL to the SolarNet host
- Type:
- string
hostWebSocketUrl() → {string}
Get a URL for just the SolarNet host using the WebSocket protocol, without any path.
This method constructs an absolute URL based on the following properties configured on this instance's module:net~Environment:
- If environment.useTls() returns
true
then use WSS as the protocol, otherwise WS. - Use
host
for the host name or IP address, unlessproxyHost
is available. - Use
port
for the port, unlessproxyPort
is available. If neither are available, use443
for WSS or80
for WS.
- Inherited From
- Source
the URL to the SolarNet host WebSocket
- Type:
- string
parameter(key, valopt) → {Object}
Get or set a parameter.
This is a shortcut for calling module:net~Configuration#value on the parameters
object.
Name | Type | Attributes | Description |
---|---|---|---|
key | string | the parameter name to get | |
val | Object | <optional> | the optional value to set |
- Inherited From
- Source
when called as a getter, the parameter value; when called as a setter, the parameters object
- Type:
- Object
resolveTemplatePath(template) → {string}
Replace occurances of URL template variables with values from the parameters
property and append to the host URL.
This method provides a way to resolve an absolute URL based on the configured environment and parameters on this object.
Name | Type | Description |
---|---|---|
template | string | a URL path template |
- Inherited From
- Source
an absolute URL
- Type:
- string
resolveTemplateUrl(template) → {string}
Replace occurances of URL template variables with values from the parameters
property.
URL template variables are specified as {<em>name</em>}
. The variable will be replaced by the value associated with property name
in the parameters
object. The value will be URI encoded.
Name | Type | Description |
---|---|---|
template | string | a URL template |
- Inherited From
- Source
the URL with template variables resolved
- Type:
- string