- Source
Classes
- AuthorizationV2Builder
- Environment
- HttpHeaders
- LocationDatumMetadataUrlHelper
- LocationDatumUrlHelper
- NodeDatumMetadataUrlHelper
- NodeDatumUrlHelper
- NodeInstructionUrlHelper
- NodeMetadataUrlHelper
- UrlHelper
- UserAuthTokenUrlHelper
- UserDatumAuxiliaryUrlHelper
- UserMetadataUrlHelper
Mixins
- AuthTokenUrlHelperMixin
- LocationDatumMetadataUrlHelperMixin
- LocationDatumUrlHelperMixin
- LocationUrlHelperMixin
- NodeDatumMetadataUrlHelperMixin
- NodeDatumUrlHelperMixin
- NodeInstructionUrlHelperMixin
- NodeMetadataUrlHelperMixin
- NodeUrlHelperMixin
- QueryUrlHelperMixin
- UserAuthTokenUrlHelperMixin
- UserDatumAuxiliaryUrlHelperMixin
- UserMetadataUrlHelperMixin
- UserUrlHelperMixin
Members
(inner, constant) HttpContentType :string
Enumeration of common HTTP Content-Type values.
- string
| Name | Type | Description |
|---|---|---|
APPLICATION_JSON | string | |
APPLICATION_JSON_UTF8 | string | |
FORM_URLENCODED | string | |
FORM_URLENCODED_UTF8 | string |
- Source
(inner, constant) HttpMethod :string
Enumeration of HTTP methods (verbs).
- string
| Name | Type | Description |
|---|---|---|
GET | string | |
HEAD | string | |
POST | string | |
PUT | string | |
PATCH | string | |
DELETE | string | |
OPTIONS | string | |
TRACE | string |
- Source
(inner, constant) SolarQueryApiPathV1 :string
The SolarQuery REST API path.
- string
(inner, constant) SolarQueryDefaultPath :string
The SolarQuery default path.
- string
- Source
(inner, constant) SolarQueryPathKey :string
The module:net~UrlHelper#parameters key for the SolarQuery path.
- string
(inner, constant) SolarQueryPublicPathKey :string
The module:net~UrlHelper#parameters key that holds a boolean flag to use the public path scheme (/pub) when constructing URLs.
- string
(inner, constant) SolarUserApiPathV1 :string
The SolarUser REST API path.
- string
- Source
(inner, constant) SolarUserDefaultPath :string
The SolarUser default path.
- string
- Source
(inner, constant) SolarUserPathKey :string
The module:net~UrlHelper parameters key for the SolarUser path.
- string
- Source
(inner, constant) instructionParameter
The static NodeInstructionUrlHelperMixin#instructionParameter method so it can be imported directly.
Methods
(inner) normalizedConfig(configopt) → {Object}
Normalize the environment configuration.
Passing a browser Location object, like window.location, is supported. The protocol, hostname, and port values will be used.
| Name | Type | Attributes | Description |
|---|---|---|---|
config | Object | <optional> | the initial configuration |
- Source
a new object with normalized configuration values
- Type:
- Object
(inner) normalizedProtocol(valopt) → {String}
Normailze a protocol value.
This method is used to normalize protocol values which might come from a Location object and thus contain a trailing colon.
| Name | Type | Attributes | Description |
|---|---|---|---|
val | String | <optional> | the protocol value to normalize |
- Source
the normalized protocol value
- Type:
- String
(inner) urlQueryEncode(parameters, encoderFn) → {string}
Encode the properties of an object as a URL query string.
If an object property has an array value, multiple URL parameters will be encoded for that property.
The optional `encoderFn` argument is a function that accepts a string value and should return a URI-safe string for that value.
| Name | Type | Description |
|---|---|---|
parameters | object | an object to encode as URL parameters |
encoderFn | function | an optional function to encode each URI component with; if not provided the built-in |
- Source
the encoded query parameters
- Type:
- string
(inner) urlQueryParse(search, multiValueKeysopt) → {object}
Parse the query portion of a URL string, and return a parameter object for the parsed key/value pairs.
Multiple parameters of the same name will be stored as an array on the returned object.
| Name | Type | Attributes | Description |
|---|---|---|---|
search | string | the query portion of the URL, which may optionally include the leading | |
multiValueKeys | Set.<String> | <optional> | if provided, a set of keys for which to always treat as a multi-value array, even if there is only one value |
- Source
the parsed query parameters, as a parameter object
- Type:
- object