Type alias OnTokenRequired

OnTokenRequired: ((language) => Promise<string>) | ((language, callback) => void)

Callback invoked whenever BridgeViews need an authentication token.

Takes the current language-tag as first parameter. Can either return a promise or invoke a node-style callback provided as second parameter to signal completion.

Three cases are supported:

  • Success: Should resolve to the new token string.
  • Unauthenticated: User is not logged in. Should resolve to null.
  • Unavailable: User is still logged in, but a new token can't be retrived for some reason, e.g. lost connection. Should reject with any error

Type declaration

    • (language): Promise<string>

    • Parameters

      • language: string

      Returns Promise<string>

Type declaration

    • (language, callback): void

    • Parameters

      • language: string
      • callback: ((error, result) => void)
          • (error, result): void

          • Parameters

            • error: Error
            • result: string

            Returns void

      Returns void

Param

The current language tag, provided for convenience.

Param

node-style callback – (error, result) => void

Settings

Member Visibility

Theme

Generated using TypeDoc