Class SolarUserApi

The SolarUser API URL helper.

Hierarchy

AuthUrlHelperMixin<{
    prototype: AuthTokenUrlHelperMixin<any>;
    new (...args): AuthTokenUrlHelperMixin<{
        prototype: InstructionUrlHelperMixin<any>;
        canUseSimpleRequest(parameters?) => boolean;
        instructionParameter(name, value) => InstructionParameter;
        urlEncodeInstructionParameters(parameters?) => string;
        new (...args): InstructionUrlHelperMixin<{
            prototype: __type<any>;
            new (...args): __type<{
                prototype: __type<any>;
                new (...args): __type<{
                    prototype: __type<any>;
                    new (...args): __type<typeof SolarUserUrlHelper>;
                } & typeof SolarUserUrlHelper>;
            } & {
                prototype: __type<any>;
                new (...args): __type<typeof SolarUserUrlHelper>;
            } & typeof SolarUserUrlHelper>;
        } & {
            prototype: __type<any>;
            new (...args): __type<{
                prototype: __type<any>;
                new (...args): __type<typeof SolarUserUrlHelper>;
            } & typeof SolarUserUrlHelper>;
        } & {
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<{
                prototype: __type<any>;
                new (...args): __type<typeof SolarUserUrlHelper>;
            } & typeof SolarUserUrlHelper>;
        } & {
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: InstructionUrlHelperMixin<any>;
    canUseSimpleRequest(parameters?) => boolean;
    instructionParameter(name, value) => InstructionParameter;
    urlEncodeInstructionParameters(parameters?) => string;
    new (...args): InstructionUrlHelperMixin<{
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<{
                prototype: __type<any>;
                new (...args): __type<typeof SolarUserUrlHelper>;
            } & typeof SolarUserUrlHelper>;
        } & {
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<{
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<{
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<typeof SolarUserUrlHelper>;
} & typeof SolarUserUrlHelper, this> & AuthTokenUrlHelperMixin<{
    prototype: InstructionUrlHelperMixin<any>;
    canUseSimpleRequest(parameters?) => boolean;
    instructionParameter(name, value) => InstructionParameter;
    urlEncodeInstructionParameters(parameters?) => string;
    new (...args): InstructionUrlHelperMixin<{
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<{
                prototype: __type<any>;
                new (...args): __type<typeof SolarUserUrlHelper>;
            } & typeof SolarUserUrlHelper>;
        } & {
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<{
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<{
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<typeof SolarUserUrlHelper>;
} & typeof SolarUserUrlHelper, this> & InstructionUrlHelperMixin<{
    prototype: __type<any>;
    new (...args): __type<{
        prototype: __type<any>;
        new (...args): __type<{
            prototype: __type<any>;
            new (...args): __type<typeof SolarUserUrlHelper>;
        } & typeof SolarUserUrlHelper>;
    } & {
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<{
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<typeof SolarUserUrlHelper>;
} & typeof SolarUserUrlHelper, this> & __type<{
    prototype: __type<any>;
    new (...args): __type<{
        prototype: __type<any>;
        new (...args): __type<typeof SolarUserUrlHelper>;
    } & typeof SolarUserUrlHelper>;
} & {
    prototype: __type<any>;
    new (...args): __type<typeof SolarUserUrlHelper>;
} & typeof SolarUserUrlHelper, this> & __type<{
    prototype: __type<any>;
    new (...args): __type<typeof SolarUserUrlHelper>;
} & typeof SolarUserUrlHelper, this> & __type<typeof SolarUserUrlHelper, this> & SolarUserUrlHelper<this>
- SolarUserApi

Index

Methods

Constructors

constructor

new SolarUserApi(environment?): SolarUserApi
Constructor.
Parameters
- Optional environment: HostConfigInfo
  
  the optional initial environment to use; if a non-Environment object is passed then the properties of that object will be used to construct a new Environment instance
Returns SolarUserApi
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).constructor
- Defined in src/main/net/urlHelper.ts:45

Properties

`Private` `Readonly` #environment

#environment: EnvironmentConfig & HostConfig

The network environment (host, port, and so on).

`Private` `Readonly` #parameters

#parameters: Configuration

Parameters for URL variables.

Accessors

environment

get environment(): EnvironmentConfig & HostConfig
Get the environment configuration.

Returns EnvironmentConfig & HostConfig
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).environment
- Defined in src/main/net/urlHelper.ts:59

parameters

get parameters(): Configuration
Get a parameters object that can be used to hold URL variables.

Returns Configuration
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).parameters
- Defined in src/main/net/urlHelper.ts:66

Methods

`Private` #instructionUrl

#instructionUrl(exec, topic, parameters?, nodeIds?): string
Parameters
- exec: boolean
- topic: string
- Optional parameters: InstructionParameter[]
- Optional nodeIds: number | number[]
Returns string
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).#instructionUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:147

`Private` #userDatumAuxiliaryBaseUrl

#userDatumAuxiliaryBaseUrl(): string
Returns string
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).#userDatumAuxiliaryBaseUrl
- Defined in src/main/net/userDatumAuxiliaryUrlHelperMixin.ts:21

`Private` #userMetadataUrl

#userMetadataUrl(userId?): string
Parameters
- Optional userId: number
Returns string
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).#userMetadataUrl
- Defined in src/main/net/userMetadataUrlHelperMixin.ts:37

addUserMetadataUrl

addUserMetadataUrl(userId?): string
Generate a URL for adding user metadata via a POST request.
Parameters
- Optional userId: number
  
  a specific user ID; if not provided the userId parameter of this class will be used; if no userId parameter is available then view metadata of the requesting user
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).addUserMetadataUrl
- Defined in src/main/net/userMetadataUrlHelperMixin.ts:73

baseUrl

baseUrl(): string
Get the base URL to the REST API.

Returns string
the base URL to the REST API
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).baseUrl
- Defined in src/main/net/urlHelper.ts:247

datumFilter

datumFilter(): DatumFilter
Get a new configured with parameters of this instance.

This will look for the following parameters:
- nodeIds
- sourceIds
Returns DatumFilter
the filter
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).datumFilter
- Defined in src/main/net/urlHelper.ts:316

deleteUserDatumAuxiliaryUrl

deleteUserDatumAuxiliaryUrl(type, nodeId, date, sourceId): string
Generate a URL for deleting a DatumAuxiliaryType via a DELETE request.

The Net.SolarUserApi#userDatumAuxiliaryIdUrl method is used to generate the URL.
Parameters
- type: DatumAuxiliaryType
  
  the datum auxiliary type
- nodeId: number
  
  the node ID
- date: Date
  
  a date
- sourceId: string
  
  the source ID
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).deleteUserDatumAuxiliaryUrl
- Defined in src/main/net/userDatumAuxiliaryUrlHelperMixin.ts:167

deleteUserMetadataUrl

deleteUserMetadataUrl(userId?): string
Generate a URL for deleting user metadata via a DELETE request.
Parameters
- Optional userId: number
  
  a specific user ID; if not provided the userId parameter of this class will be used; if no userId parameter is available then view metadata of the requesting user
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).deleteUserMetadataUrl
- Defined in src/main/net/userMetadataUrlHelperMixin.ts:97

env

env(key): any
Get or set an environment parameter.

This is a shortcut for calling Util.Configuration#value on the environment object.
Parameters
- key: string
  
  the environment parameter name to get
Returns any
when called as a getter, the environment parameter value; when called as a setter, the environment object
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).env
- Defined in src/main/net/urlHelper.ts:81
env(key, newValue): EnvironmentConfig & HostConfig
Parameters
- key: string
- newValue: any
Returns EnvironmentConfig & HostConfig
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).env
- Defined in src/main/net/urlHelper.ts:82

execInstructionUrl

execInstructionUrl(topic, parameters?, nodeIds?): string
Generate a URL for posting an instruction execution request.
Parameters
- topic: string
  
  the instruction topic
- Optional parameters: InstructionParameter[]
  
  an array of parameter objects
- Optional nodeIds: number | number[]
  
  the specific node ID(s) to use; if not provided the nodeIds parameter of this class will be used
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).execInstructionUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:226

findUserMetadataUrl

findUserMetadataUrl(filter): string
Generate a URL for viewing the configured user's metadata via a GET request.
Parameters
- filter: UserMetadataFilter
  
  the search criteria
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).findUserMetadataUrl
- Defined in src/main/net/userMetadataUrlHelperMixin.ts:26

hostRequestUrl

hostRequestUrl(): string
Get a URL for just the SolarNet host, without any path to be used for actual requests.

Calls the toRequestUrl() with hostUrl() as the argument.

Returns string
the URL to make reqeusts to the SolarNet host
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).hostRequestUrl
- Defined in src/main/net/urlHelper.ts:193

hostUrl

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 Net.Environment:
1. If environment.useTls() returns true then use HTTPS as the protocol, otherwise HTTP.
2. Use host for the host name or IP address.
3. Use port for the port if available and not the standard 443 for HTTPS or 80 for HTTP.
Returns string
the URL to the SolarNet host
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).hostUrl
- Defined in src/main/net/urlHelper.ts:171

hostWebSocketUrl

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 Net.Environment:
1. If environment.useTls() returns true then use WSS as the protocol, otherwise WS.
2. Use host for the host name or IP address.
3. Use port for the port if available and not the standard 443 for WSS or 80 for WS.
Returns string
the URL to the SolarNet host WebSocket
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).hostWebSocketUrl
- Defined in src/main/net/urlHelper.ts:228

listUserDatumAuxiliaryUrl

listUserDatumAuxiliaryUrl(filter): string
Generate a URL for viewing the configured user's metadata via a GET request.
Parameters
- filter: DatumFilter
  
  the search criteria
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).listUserDatumAuxiliaryUrl
- Defined in src/main/net/userDatumAuxiliaryUrlHelperMixin.ts:31

param

param<T>(key): undefined | T
Get a parameter, with plural suffix array support.

This method will first look for a parameter named exactly key, and if found return that. Otherwise it will look for an array parameter named key with s appended, and if found return the first element from that array. For example:
```
const helper = new UrlHelper();
helper.parameter('nodeIds', [1, 2, 3]);

helper.param('nodeIds'); // [1, 2, 3]
helper.param('nodeId');  // 1
```
If key already ends in s, then a desired array result is assumed. If a value is not found for the parameter, then s is removed from key and that parameter value is returned, as an array if it is not already. For example:
```
const helper = new UrlHelper();
helper.parameter('nodeId', 1);

helper.param('nodeIds'); // [1]
helper.param('nodeId');  // 1
```
Type Parameters
- T
  
  the expected type
Parameters
- key: string
  
  the parameter name to get
Returns undefined | T
the parameter value
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).param
- Defined in src/main/net/urlHelper.ts:135

parameter

parameter(key): any
Get or set a parameter.

This is a shortcut for calling Util.Configuration#value on the parameters object.
Parameters
- key: string
  
  the parameter name to get
Returns any
when called as a getter, the parameter value; when called as a setter, the parameters object
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).parameter
- Defined in src/main/net/urlHelper.ts:98
parameter(key, newValue): Configuration
Parameters
- key: string
- newValue: any
Returns Configuration
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).parameter
- Defined in src/main/net/urlHelper.ts:99

queueInstructionRequest

queueInstructionRequest(topic?, parameters?, nodeId?, executionDate?): QueueInstructionRequest | QueueInstructionSimpleRequest
Create a queue instruction request object, suitable for submitting as JSON content.
Parameters
- Optional topic: string
  
  the topic to include (can be omitted if the topic is included in the request URL)
- Optional parameters: InstructionParameter[]
  
  the parameter to include
- Optional nodeId: number
  
  the specific node ID to use; if not provided the nodeId parameter of this class will be used
- Optional executionDate: Date
  
  a deferred execution date; this will be encoded as a executionDate parameter as an ISO 8601 timestamp value
Returns QueueInstructionRequest | QueueInstructionSimpleRequest
the request, encoded as a Net.QueueInstructionSimpleRequest if possible
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).queueInstructionRequest
- Defined in src/main/net/instructionUrlHelperMixin.ts:244

queueInstructionUrl

queueInstructionUrl(topic, parameters?, nodeId?): string
Generate a URL for posting an instruction request.
Parameters
- topic: string
  
  the instruction topic
- Optional parameters: InstructionParameter[]
  
  an array of parameter objects
- Optional nodeId: number
  
  the specific node ID to use; if not provided the nodeId parameter of this class will be used
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).queueInstructionUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:194

queueInstructionsUrl

queueInstructionsUrl(topic, parameters?, nodeIds?): string
Generate a URL for posting instruction requests for multiple nodes.
Parameters
- topic: string
  
  the instruction topic
- Optional parameters: InstructionParameter[]
  
  an array of parameter objects
- Optional nodeIds: number[]
  
  a list of node IDs to use; if not provided the nodeIds parameter of this class will be used
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).queueInstructionsUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:210

refreshTokenV2Url

refreshTokenV2Url(date?): string
Generate a URL to refresh the signing key of an authentication token.

Note this method only works against the /sec version of the API endpoint.
Parameters
- Optional date: Date
  
  the signing date to use, or null for the current date
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).refreshTokenV2Url
- Defined in src/main/net/authTokenUrlHelperMixin.ts:28

replaceUserMetadataUrl

replaceUserMetadataUrl(userId?): string
Generate a URL for replacing user metadata via a PUT request.
Parameters
- Optional userId: number
  
  a specific user ID; if not provided the userId parameter of this class will be used; if no userId parameter is available then view metadata of the requesting user
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).replaceUserMetadataUrl
- Defined in src/main/net/userMetadataUrlHelperMixin.ts:85

resolveTemplatePath

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.
Parameters
- template: string
  
  a URL path template
Returns string
an absolute URL

See
Net.UrlHelper#resolveTemplateUrl
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).resolveTemplatePath
- Defined in src/main/net/urlHelper.ts:263

resolveTemplateUrl

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.
Parameters
- template: string
  
  a URL template
Returns string
the URL with template variables resolved
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).resolveTemplateUrl
- Defined in src/main/net/urlHelper.ts:278

storeUserDatumAuxiliaryUrl

storeUserDatumAuxiliaryUrl(type, nodeId, date, sourceId): string
Generate a URL for storing a DatumAuxiliaryType via a POST request.

The module:net~UserDatumAuxiliaryUrlHelperMixin#userDatumAuxiliaryIdUrl method is used to generate the URL.
Parameters
- type: DatumAuxiliaryType
  
  the datum auxiliary type
- nodeId: number
  
  the node ID
- date: Date
  
  a date
- sourceId: string
  
  the source ID
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).storeUserDatumAuxiliaryUrl
- Defined in src/main/net/userDatumAuxiliaryUrlHelperMixin.ts:125

toRequestUrl

toRequestUrl(url): string
Get the URL to actually request, incorporating the environment's proxyUrlPrefix if available.

If a environment.proxyUrlPrefix value is configured, this will re-write the URL to use that host prefix, otherwise url will be returned unchanged.
Parameters
- url: string
Returns string
the URL to make reqeusts to the SolarNet host
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).toRequestUrl
- Defined in src/main/net/urlHelper.ts:206

updateInstructionStateUrl

updateInstructionStateUrl(instructionId, state): string
Generate a URL for changing the state of an instruction.
Parameters
- instructionId: number
  
  the instruction ID to update
- state: InstructionState
  
  the instruction state to set
Returns string
the URL

See
the Domain.InstructionStates enum for possible state values
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).updateInstructionStateUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:104

updateNodeArchivedStatusUrl

updateNodeArchivedStatusUrl(archived, nodeId?): string
Generate a URL to update the archived status of a set of nodes via a POST request.
Parameters
- archived: boolean
  
  true to mark the nodes as archived; false to un-mark and return to normal status
- Optional nodeId: number | number[]
  
  a specific node ID, or array of node IDs, to update; if not provided the nodeIds property of this class will be used
Returns string
the URL to update the nodes archived status
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).updateNodeArchivedStatusUrl
- Defined in src/main/net/userNodesUrlHelperMixin.ts:52

userDatumAuxiliaryIdQueryUrl

userDatumAuxiliaryIdQueryUrl(type, nodeId, date, sourceId): string
Generate a URL for accessing a specific DatumAuxiliaryType by its primary key, using query parameters for id components.
Parameters
- type: DatumAuxiliaryType
  
  the datum auxiliary type
- nodeId: number
  
  the node ID
- date: Date
  
  a date
- sourceId: string
  
  the source ID
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).userDatumAuxiliaryIdQueryUrl
- Defined in src/main/net/userDatumAuxiliaryUrlHelperMixin.ts:93

userDatumAuxiliaryIdUrl

userDatumAuxiliaryIdUrl(type, nodeId, date, sourceId): string
Generate a URL for accessing a specific DatumAuxiliaryType by its primary key.

If sourceId contains any / characters, then Net.SolarUserApi#userDatumAuxiliaryIdQueryUrl will be invoked instead.
Parameters
- type: DatumAuxiliaryType
  
  the datum auxiliary type
- nodeId: number
  
  the node ID
- date: Date
  
  a date
- sourceId: string
  
  the source ID
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).userDatumAuxiliaryIdUrl
- Defined in src/main/net/userDatumAuxiliaryUrlHelperMixin.ts:55

viewActiveInstructionsUrl

viewActiveInstructionsUrl(nodeId?): string
Generate a URL for viewing active instructions.
Parameters
- Optional nodeId: number
  
  a specific node ID to use; if not provided the nodeId parameter of this instance will be used
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewActiveInstructionsUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:74

viewArchivedNodesUrl

viewArchivedNodesUrl(): string
Generate a URL to get a list of all archived nodes for the user account.

Returns string
the URL to access the user's archived nodes
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewArchivedNodesUrl
- Defined in src/main/net/userNodesUrlHelperMixin.ts:39

viewInstructionUrl

viewInstructionUrl(instructionId): string
Generate a URL to get all details for a specific instruction.
Parameters
- instructionId: number
  
  the instruction ID to get
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewInstructionUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:60

viewNodesUrl

viewNodesUrl(): string
Generate a URL to get a list of all active nodes for the user account.

Returns string
the URL to access the user's active nodes
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewNodesUrl
- Defined in src/main/net/userNodesUrlHelperMixin.ts:21

viewPendingInstructionsUrl

viewPendingInstructionsUrl(nodeId?): string
Generate a URL for viewing pending instructions.
Parameters
- Optional nodeId: number
  
  a specific node ID to use; if not provided the nodeId parameter of this instance will be used
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewPendingInstructionsUrl
- Defined in src/main/net/instructionUrlHelperMixin.ts:88

viewPendingNodesUrl

viewPendingNodesUrl(): string
Generate a URL to get a list of all pending nodes for the user account.

Returns string
the URL to access the user's pending nodes
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewPendingNodesUrl
- Defined in src/main/net/userNodesUrlHelperMixin.ts:30

viewUserDatumAuxiliaryUrl

viewUserDatumAuxiliaryUrl(type, nodeId, date, sourceId): string
Generate a URL for viewing a DatumAuxiliaryType via a GET request.

The Net.SolarUserApi#userDatumAuxiliaryIdUrl method is used to generate the URL.
Parameters
- type: DatumAuxiliaryType
  
  the datum auxiliary type
- nodeId: number
  
  the node ID
- date: Date
  
  a date
- sourceId: string
  
  the source ID
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewUserDatumAuxiliaryUrl
- Defined in src/main/net/userDatumAuxiliaryUrlHelperMixin.ts:146

viewUserMetadataUrl

viewUserMetadataUrl(userId?): string
Generate a URL for viewing a specific user's metadata via a GET request.
Parameters
- Optional userId: number
  
  a specific user ID; if not provided the userId parameter of this class will be used; if no userId parameter is available then view metadata of the requesting user
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).viewUserMetadataUrl
- Defined in src/main/net/userMetadataUrlHelperMixin.ts:61

whoamiUrl

whoamiUrl(): string
Generate a URL to get information about the requesting authenticated user.

Returns string
the URL to view information about the authenticated user
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).whoamiUrl
- Defined in src/main/net/authUrlHelperMixin.ts:22

`Static` canUseSimpleRequest

canUseSimpleRequest(parameters?): boolean
Test if a list of instructions can be encoded as a Net.QueueInstructionSimpleRequest object.
Parameters
- Optional parameters: InstructionParameter[]
  
  the parameters to inspect
Returns boolean
true if a QueueInstructionSimpleRequest can be used to encode the instruction parameters
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).canUseSimpleRequest
- Defined in src/main/net/instructionUrlHelperMixin.ts:313

`Static` instructionParameter

instructionParameter(name, value): InstructionParameter
Create an instruction parameter.
Parameters
- name: string
  
  the parameter name
- value: string
  
  the parameter value
Returns InstructionParameter
the parameter object

See
Domain.Instruction.parameter
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).instructionParameter
- Defined in src/main/net/instructionUrlHelperMixin.ts:342

`Static` resolveTemplateUrl

resolveTemplateUrl(template, params): string
Replace occurances of URL template variables with values from a parameter object.

URL template variables are specified as {<em>name</em>}. The variable will be replaced by the value associated with property name in the provided parameter object. The value will be URI encoded.

Any occurances of // after replacing template variables will be reduced to /.
Parameters
- template: string
  
  a URL template
- params: Record<string, any>
  
  an object whose properties should serve as template variables
Returns string
the URL
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).resolveTemplateUrl
- Defined in src/main/net/urlHelper.ts:295

`Static` urlEncodeInstructionParameters

urlEncodeInstructionParameters(parameters?): string
Generate URL encoded query string for posting instruction parameters.
Parameters
- Optional parameters: InstructionParameter[]
  
  an array of parameter objects
Returns string
the URL encoded query string, or an empty string if parameters is empty
Inherited from AuthUrlHelperMixin( AuthTokenUrlHelperMixin( InstructionUrlHelperMixin( UserDatumAuxiliaryUrlHelperMixin( UserMetadataUrlHelperMixin( UserNodesUrlHelperMixin(SolarUserUrlHelper) ) ) ) ) ).urlEncodeInstructionParameters
- Defined in src/main/net/instructionUrlHelperMixin.ts:123

Class SolarUserApi

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional environment: HostConfigInfo

Returns SolarUserApi

Properties

Private Readonly #environment

Private Readonly #parameters

Accessors

environment

Returns EnvironmentConfig & HostConfig

parameters

Returns Configuration

Methods

Private #instructionUrl

Parameters

exec: boolean

topic: string

Optional parameters: InstructionParameter[]

Optional nodeIds: number | number[]

Returns string

Private #userDatumAuxiliaryBaseUrl

Returns string

Private #userMetadataUrl

Parameters

Optional userId: number

Returns string

addUserMetadataUrl

Parameters

Optional userId: number

Returns string

baseUrl

Returns string

datumFilter

Returns DatumFilter

deleteUserDatumAuxiliaryUrl

Parameters

type: DatumAuxiliaryType

nodeId: number

date: Date

sourceId: string

Returns string

deleteUserMetadataUrl

Parameters

Optional userId: number

Returns string

env

Parameters

key: string

Returns any

Parameters

key: string

newValue: any

Returns EnvironmentConfig & HostConfig

execInstructionUrl

Parameters

topic: string

Optional parameters: InstructionParameter[]

Optional nodeIds: number | number[]

Returns string

findUserMetadataUrl

Parameters

filter: UserMetadataFilter

Returns string

hostRequestUrl

Returns string

hostUrl

Returns string

hostWebSocketUrl

Returns string

listUserDatumAuxiliaryUrl

Parameters

filter: DatumFilter

`Optional` environment: HostConfigInfo

`Private` `Readonly` #environment

`Private` `Readonly` #parameters

`Private` #instructionUrl

`Optional` parameters: InstructionParameter[]

`Optional` nodeIds: number | number[]

`Private` #userDatumAuxiliaryBaseUrl

`Private` #userMetadataUrl

`Optional` userId: number

`Optional` userId: number

`Optional` userId: number

`Optional` parameters: InstructionParameter[]

`Optional` nodeIds: number | number[]

`Optional` topic: string

`Optional` parameters: InstructionParameter[]

`Optional` nodeId: number

`Optional` executionDate: Date

`Optional` parameters: InstructionParameter[]

`Optional` nodeId: number

`Optional` parameters: InstructionParameter[]

`Optional` nodeIds: number[]

`Optional` date: Date

`Optional` userId: number