Interface ISessionContainer

Provides session information.

interface ISessionContainer {
    accessToken: string;
    id: string;
    isInitialized: boolean;
    serverCode: string;
    session: ISession;
    sessionToken: ISessionToken;
    user: IUser;
    initialize(session: ISession): Promise<void>;
    tryGetAccessToken(): null | string;
    tryGetSessionToken(): null | ISessionToken;
}

Hierarchy (View Summary)

Implemented by

Properties

accessToken id isInitialized serverCode session sessionToken user

Methods

initialize tryGetAccessToken tryGetSessionToken

Properties

ReadonlyaccessToken

accessToken: string

Token describing the session access data.

Readonlyid

id: string

Session ID.

ReadonlyisInitialized

isInitialized: boolean

Session has been initialized.

ReadonlyserverCode

serverCode: string

Server code.

Readonlysession

session: ISession

Opened session.

ReadonlysessionToken

sessionToken: ISessionToken

Token describing the session.

Readonlyuser

user: IUser

Information about the current user.

Methods

initialize

  • initialize(session: ISession): Promise<void>

    Performs session initialization.

    Parameters

    • session: ISession

      The session to initialize.

    Returns Promise<void>

tryGetAccessToken

  • tryGetAccessToken(): null | string

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

    Returns null | string

tryGetSessionToken

  • tryGetSessionToken(): null | ISessionToken

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

    Returns null | ISessionToken

Settings

Member Visibility

On This Page

Properties
Methods