Class User

Classdesc

The User class is a child class of the SetConfig class. The User class has a constructor that takes in a userID and a config object. The User class has a bunch of methods that make API calls to the Identity Server.

Hierarchy

  • SetConfig
    • User

Constructors

  • The constructor function is a special function that is called when an object is created from a class

    Parameters

    • userID: string

      The user ID of the user you want to get the profile of.

    • config: Config

      Config - This is the configuration object that is passed to the constructor of the base class.

    Returns User

Properties

API_KEY: string
APPLICATION_SERVER: string
IDENTITY_SERVER: string
JOIN_SERVER: string
NETWORK_SERVER: string
TENANT_ID: undefined | string

Accessors

  • get headers(): {
        AUTHORIZATION: string;
    }
  • The headers function returns an object with a key of AUTHORIZATION and a value of Bearer + the API_KEY.

    Returns {
        AUTHORIZATION: string;
    }

    The headers object.

    • AUTHORIZATION: string

Methods

Generated using TypeDoc