Class default

Config

The configuration class will hold the configuration information used when accessing the API.

Constructors

constructor

Accessors

authToken baseUrl getCommunity

Methods

getRootDomain setAuthToken setBaseUrl setCommunity setConfig setRootDomain

Constructors

constructor

Properties

Static Private _authToken

_authToken: string

Static Private _baseUrl

_baseUrl: string

Static Private _baseUrlLocked

_baseUrlLocked: boolean = false

Static Private _community

_community: object

Static Private _rootDomain

_rootDomain: string

Accessors

Static authToken

Static baseUrl

Static getCommunity

  • get getCommunity(): object

  • Gets the community currently associated

    Returns object

Methods

Static getRootDomain

Static setAuthToken

  • setAuthToken(authToken): void

  • Set the JSON Web Token (JWT) that will be passed to the API

    Parameters

    • authToken: string

      The JWT

    Returns void

Static setBaseUrl

  • setBaseUrl(baseUrl, lock?): void

  • Sets the endpoint for the API

    Parameters

    • baseUrl: string

      The url that connects to the APIs base

    • Optional lock: boolean

      If set to true, will lock the baseUrl so it cannot be changed

    Returns void

Static setCommunity

  • setCommunity(community): void

  • Set the community to be associated with this config through

    Parameters

    • community: Record<string, any>

      The object of the community

    Returns void

Static setConfig

  • setConfig(baseUrl, authToken, lock?): void

  • Set the configuration

    Parameters

    • baseUrl: string

      The url base endpoint of the api

    • authToken: string

      The JSON Web Token

    • Optional lock: boolean

    Returns void

Static setRootDomain

  • setRootDomain(domain): void

  • Sets the root level domain so data can be accessed across multiple subdomains

    Parameters

    • domain: string

      The domain ie: example.com

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc