Class SessionContainer

Provides session information.

Hierarchy

  • SessionContainer

Implements

Constructors

constructor

Accessors

accessToken applicationId id instanceName isInitialized serverCode session sessionToken user

Methods

initialize tryGetAccessToken tryGetSessionToken

Constructors

constructor

Accessors

accessToken

  • get accessToken(): string

  • Token describing the session access data.

    Returns string

applicationId

  • get applicationId(): string

  • ID of the application that opened the session.

    Returns string

id

  • get id(): string

  • Session ID.

    Returns string

instanceName

  • get instanceName(): string

  • Name of the server instance.

    Returns string

isInitialized

  • get isInitialized(): boolean

  • Session has been initialized.

    Returns boolean

serverCode

  • get serverCode(): string

  • Server code.

    Returns string

session

sessionToken

user

  • get user(): IUser

  • Information about the current user.

    Returns IUser

Methods

initialize

  • Performs session initialization.

    Parameters

    • session: ISession

      The session to initialize.

    Returns Promise<void>

tryGetAccessToken

  • Token describing the session access data, or `null' if the session is not associated with the token.

    Returns null | string

tryGetSessionToken

Generated using TypeDoc