Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UnbluUiApi

This class allows controlling of the UI state and the Unblu individual UI.

Hierarchy

  • UnbluUiApi

Index

Events

Methods

Events

Static UI_STATE_CHANGE

UI_STATE_CHANGE: "uiStateChange" = "uiStateChange"

Event emitted every time the state of the individual UI is changed.

see

on for listener registration

see

UiStateChangeListener

Methods

collapseIndividualUi

  • collapseIndividualUi(): Promise<void>

  • Collapses the individual UI if it was open. - Does nothing if it was already collapsed.

    Returns Promise<void>

getIndividualUiState

  • Get the state of the individual UI.

    Returns Promise<IndividualUiState>

    A promise that resolves to the IndividualUiState of the individual UI.

maximizeIndividualUi

  • maximizeIndividualUi(): Promise<void>

  • Maximize the individual UI - Does nothing if it is already maximized or popped out.

    Returns Promise<void>

minimizeIndividualUi

  • minimizeIndividualUi(): Promise<void>

  • Minimize the individual UI - Does nothing if it is already minimized.

    Returns Promise<void>

off

  • off(event: GeneralEventType, listener: Listener): boolean

  • Removes a previously registered listener

    Parameters

    • event: GeneralEventType

      The event to unregister from.

    • listener: Listener

      The listener to remove.

    Returns boolean

on

  • Registers an event listener for the given event.

    see

    UI_STATE_CHANGE

    Parameters

    • event: "uiStateChange"

      The uistateChange event.

    • listener: UiStateChangeListener

      The listener to be called.

    Returns void

openIndividualUi

  • openIndividualUi(): Promise<void>

  • Opens the individual UI if it was collapsed. - Does nothing if it was already open.

    Returns Promise<void>

openPinEntryUi

  • openPinEntryUi(): Promise<void>

  • Navigates the individual UI to the PIN entry UI.

    NOTE: calling this method will NOT automatically open the Unblu UI if it is collapsed. Use openIndividualUi if this is needed.

    Returns Promise<void>

popinIndividualUi

  • popinIndividualUi(): Promise<void>

  • Pop-in the individual UI when it is in POPPED_OUT state.

    The pop-out window will automatically close and the individual UI will be displayed in the original window again.

    Returns Promise<void>

popoutIndividualUi

  • popoutIndividualUi(): Promise<void>

  • Pop-out the individual UI into a separate window.

    NOTE: this has to be called in a click-event in order to be able to open the pop-up window without being blocked by the browser!

    Returns Promise<void>

toggleIndividualUi

  • toggleIndividualUi(): Promise<void>

  • Opens the individual UI if it is collapsed and collapses it if it is open.

    Returns Promise<void>