Class UserSessionHandler

Hierarchy

BaseSessionHandler
- UserSessionHandler

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new UserSessionHandler(connection: MetricsConnection, userResponse: UserResponse): UserSessionHandler

Overrides BaseSessionHandler.constructor
- Defined in src/session.ts:341
Parameters
- connection: MetricsConnection
- userResponse: UserResponse
Returns UserSessionHandler

Accessors

accessToken

get accessToken(): string

- Defined in src/session.ts:234
Returns string

connection

get connection(): MetricsConnection

- Defined in src/session.ts:217
Returns MetricsConnection

decodedAccessToken

get decodedAccessToken(): AccessToken

- Defined in src/session.ts:345
Returns AccessToken

decodedRefreshToken

get decodedRefreshToken(): null | RefreshToken

- Defined in src/session.ts:242
Returns null | RefreshToken

keepAlive

get keepAlive(): boolean
set keepAlive(value: boolean): void

- Defined in src/session.ts:221
Returns boolean
- Defined in src/session.ts:225
Parameters
- value: boolean
Returns void

onAccessTokenChangeEvent

get onAccessTokenChangeEvent(): IEvent<AccessTokenChangeEvent>

- Defined in src/session.ts:250
Returns IEvent<AccessTokenChangeEvent>

onRefreshTokenChangeEvent

get onRefreshTokenChangeEvent(): IEvent<RefreshTokenChangeEvent>

- Defined in src/session.ts:246
Returns IEvent<RefreshTokenChangeEvent>

refreshToken

get refreshToken(): null | string

- Defined in src/session.ts:238
Returns null | string

userId

get userId(): number

- Defined in src/session.ts:349
Returns number

Methods

action

action(action: string, params?: Object): Promise<AuthenticatedResponse>

Inherited from BaseSessionHandler.action
- Defined in src/session.ts:265
Parameters
- action: string
- params: Object = {}
Returns Promise<AuthenticatedResponse>

close

close(): void

Inherited from BaseSessionHandler.close
- Defined in src/session.ts:254
Returns void

logout

logout(): Promise<void>

Overrides BaseSessionHandler.logout
- Defined in src/session.ts:353
Returns Promise<void>

subscribeToModel

subscribeToModel(subscribeParameters: ModelSubscribeParameters, callback: (modelChangeEvent: ModelChangeEvent) => void): Promise<() => Promise<void>>

Inherited from BaseSessionHandler.subscribeToModel
- Defined in src/session.ts:285
Parameters
- subscribeParameters: ModelSubscribeParameters
- callback: (modelChangeEvent: ModelChangeEvent) => void
  - - (modelChangeEvent: ModelChangeEvent): void
    - Parameters
      - modelChangeEvent: ModelChangeEvent
      Returns void
Returns Promise<() => Promise<void>>

subscribeToModelList

subscribeToModelList(subscribeParameters: ListSubscribeParameters, callback: (modelChangeEvent: ModelChangeEvent) => void): Promise<() => Promise<void>>

Inherited from BaseSessionHandler.subscribeToModelList
- Defined in src/session.ts:291
Parameters
- subscribeParameters: ListSubscribeParameters
- callback: (modelChangeEvent: ModelChangeEvent) => void
  - - (modelChangeEvent: ModelChangeEvent): void
    - Parameters
      - modelChangeEvent: ModelChangeEvent
      Returns void
Returns Promise<() => Promise<void>>