Class SessionHandler

Hierarchy

SessionHandlerParams
- SessionHandler

Index

Constructors

Properties

onSessionClosed? onSessionError? onSessionExpired? onSessionRefreshed? onSessionTokenRequired?

Constructors

constructor

new SessionHandler(params?): SessionHandler
Parameters
- params: SessionHandlerParams = {}
Returns SessionHandler

Overrides SessionHandlerParams.constructor

Properties

`Optional` onSessionClosed

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

Type declaration

- (): void
- Called when the session is explicitly closed on refresh.
  
  Returns void

`Optional` onSessionError

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

Type declaration

- (err): void
- Called when the SDK runs into an error while refreshing the session key.
  Parameters
  - err: Error
  Returns void

`Optional` onSessionExpired

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

Type declaration

- (): void
- Returns void
  
  Deprecated
  since v4.0.7

`Optional` onSessionRefreshed

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

Type declaration

- (): void
- Called after SDK successfully refreshes the session key.
  
  Returns void

`Optional` onSessionTokenRequired

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

Type declaration

- (resolve, reject): 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.
  Parameters
  - resolve: SessionTokenRefreshResolve
  - reject: SessionTokenRefreshReject
  Returns void

Generated using TypeDoc