Interface ISessionService

Hierarchy

  • ISessionService

Implemented by

Methods

close closeAsAdmin create getTokenInfo open

Methods

close

  • Close current session.

    Returns

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

    Returns Promise<boolean>

closeAsAdmin

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

    Returns

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

    Parameters

    • sessionId: string

      Identifier of session to close.

    Returns Promise<boolean>

create

  • Create session token and access token.

    Returns

    Session token and access token.

    Parameters

    • getAccessToken: (() => null | string)

      Return access token function.

        • (): null | string

        • Returns null | string

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

getTokenInfo

  • Returns the current token in json form.

    Returns

    Session token info.

    Parameters

    • Optional accessToken: null | string

      Current access token.

    Returns Promise<ISessionToken>

open

  • Open session to login user.

    Returns

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

    Parameters

    • request: OpenSessionRequest

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

    Returns Promise<IOpenSessionResult>

Generated using TypeDoc