@subaio/fintech-bridge-web
Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Accessors

Methods

Accessors

customConfig

  • get customConfig(): Record<string, string> | undefined
  • set customConfig(customConfig: Record<string, string> | undefined): any

  • Custom named values (such as customizable colors) sent to the views.

    Returns Record<string, string> | undefined

  • Custom named values (such as customizable colors) sent to the views.

    Parameters

    • customConfig: Record<string, string> | undefined

    Returns any

language

  • get language(): string | null
  • set language(language: string | null): any

  • 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 string | null

  • 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.

    Parameters

    • language: string | null

    Returns any

Static shared

  • Shared instance of the BridgeManager.

    Returns BridgeManager

Methods

cleanup

  • cleanup(): 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.

    Returns void

configure

  • configure(config: Config): void

  • Global configuration for all BridgeViews. Must be called before any views are initiated.

    Parameters

    Returns void

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

Legend

  • Constructor
  • Property
  • Method
  • Accessor

Generated using TypeDoc