Class SessionHandler

Hierarchy

  • SessionHandlerParams
    • SessionHandler

Constructors

constructor

Properties

onSessionClosed? onSessionError? onSessionExpired? onSessionRefreshed? onSessionTokenRequired?

Constructors

constructor

  • new SessionHandler(params?): SessionHandler

  • Parameters

    • params: SessionHandlerParams = {}

    Returns SessionHandler

Properties

OptionalonSessionClosed

onSessionClosed?: (() => void) = noop

Called when the session is explicitly closed on refresh.

OptionalonSessionError

onSessionError?: ((err: Error) => void) = noop

Called when the SDK runs into an error while refreshing the session key.

OptionalonSessionExpired

onSessionExpired?: (() => void) = noop

Deprecated

since v4.0.7

OptionalonSessionRefreshed

onSessionRefreshed?: (() => void) = noop

Called after SDK successfully refreshes the session key.

OptionalonSessionTokenRequired

onSessionTokenRequired?: ((resolve: SessionTokenRefreshResolve, reject: SessionTokenRefreshReject) => void) = ...

Needs to fetch a new token and pass the new token to the SDK via resolve(), or reject() if error has occurred during the fetch.

Settings

Member Visibility

On This Page

Constructors
Properties