Class BridgeManager

Singleton-class for managing global setup of subaio-views. Before creating views, manager.configure should be invoked.

The manager automatically maintains a valid token and requests new ones using the onTokenRequired callback whenever necessary.

Hierarchy

BridgeManager

Index

Constructors

Accessors

customConfig initializationTimeout language shared

Methods

cleanup configure refreshToken

Constructors

constructor

new BridgeManager(): BridgeManager
Returns BridgeManager

Accessors

customConfig

get customConfig(): undefined | Record<string, string>
Custom named values (such as customizable colors) sent to the views.

Returns undefined | Record<string, string>
- Defined in Manager.ts:196
set customConfig(customConfig): void
Parameters
- customConfig: undefined | Record<string, string>
Returns void
- Defined in Manager.ts:198

initializationTimeout

get initializationTimeout(): number
Amount of time in milliseconds to wait before abandoning a loading view.

Returns number
- Defined in Manager.ts:203

language

get language(): null | string
Language to be used by all BridgeViews as a BCP-47 string. Assigning language automatically updates all views and triggers a token refetch if configure has already been called. If it is set to null or not set, views will never exit their loading-state.

Returns null | string
- Defined in Manager.ts:189
set language(language): void
Parameters
- language: null | string
Returns void
- Defined in Manager.ts:191

`Static` shared

get shared(): BridgeManager
Shared instance of the BridgeManager.

Returns BridgeManager
- Defined in Manager.ts:106

Methods

cleanup

cleanup(): void
Returns void

Deprecated
Token autorenewal has been removed, rendering this method obsolete

Stop all token refresh logic in preparation for the manager being garbage collected. Only relevant if instances are created manually.

Should never be called on the shared instance.
- Defined in Manager.ts:216

configure

configure(config): void
Global configuration for all BridgeViews. Must be called before any views are initiated.
Parameters
- config: Config
Returns void
- Defined in Manager.ts:136

refreshToken

refreshToken(): void
Force a new fetch of authentication token. Useful when the user logs out to force current token to be removed from memory and any views to clear all user data.

Returns void
- Defined in Manager.ts:297

Generated using TypeDoc