Interface ISessionService

interface ISessionService {
    close(): Promise<boolean>;
    closeAsAdmin(sessionId: string): Promise<boolean>;
    create(
        getAccessToken: () => null | string,
    ): Promise<{ accessToken: string; sessionToken: ISessionToken }>;
    getTokenInfo(accessToken?: null | string): Promise<ISessionToken>;
    open(request: OpenSessionRequest): Promise<IOpenSessionResult>;
}

Implemented by

Methods

close closeAsAdmin create getTokenInfo open

Methods

close

  • close(): Promise<boolean>

    Close current session.

    Returns Promise<boolean>

    true if session was present and was closed; false otherwise.

closeAsAdmin

  • closeAsAdmin(sessionId: string): Promise<boolean>

    Close session with specified identifier. Returns flag whether session was present and was closed. Method is available for administrators only.

    Parameters

    • sessionId: string

      Identifier of session to close.

    Returns Promise<boolean>

    true if session was present and was closed; false otherwise.

create

  • create(
        getAccessToken: () => null | string,
    ): Promise<{ accessToken: string; sessionToken: ISessionToken }>

    Create session token and access token.

    Parameters

    • getAccessToken: () => null | string

      Return access token function.

    Returns Promise<{ accessToken: string; sessionToken: ISessionToken }>

    Session token and access token.

getTokenInfo

  • getTokenInfo(accessToken?: null | string): Promise<ISessionToken>

    Returns the current token in json form.

    Parameters

    • OptionalaccessToken: null | string

      Current access token.

    Returns Promise<ISessionToken>

    Session token info.

open

  • open(request: OpenSessionRequest): Promise<IOpenSessionResult>

    Open session to login user.

    Parameters

    • request: OpenSessionRequest

      Request to open the sessions including auth parameters and info on app and the client.

    Returns Promise<IOpenSessionResult>

    Session token, access token, 2FA response or null if value is not set.

Settings

Member Visibility

On This Page

Methods