Interface MbpEmbedClientNavigation

Methods available as mbpClient.navigation.

See the navigation guide.

interface MbpEmbedClientNavigation {
    back(): Promise<void>;
    openNewEmbed(url: string): Promise<void>;
    openExternal(url: string): Promise<void>;
    openHostRoute<R>(route: R, params?: RouteParams<HostRoute>[R]): Promise<void>;
    onBackNavigation(callback: (() => boolean)): (() => void);
    enableExitConfirmation(options: {
        title?: string;
        message?: string;
        confirm?: string;
        ignore?: string;
    }): Promise<void>;
    disableExitConfirmation(): Promise<void>;
}

Methods

back openNewEmbed openExternal openHostRoute onBackNavigation enableExitConfirmation disableExitConfirmation

Methods

back

  • back(): Promise<void>

  • Returns Promise<void>

openNewEmbed

  • openNewEmbed(url): Promise<void>

  • Parameters

    • url: string

    Returns Promise<void>

openExternal

  • openExternal(url): Promise<void>

  • Parameters

    • url: string

    Returns Promise<void>

openHostRoute

  • openHostRoute<R>(route, params?): Promise<void>

  • Type Parameters

    Parameters

    Returns Promise<void>

onBackNavigation

  • onBackNavigation(callback): (() => void)

  • Register a callback for native or host back navigation.

    A new callback replaces the previously registered callback. Return false to block host navigation. The host continues navigation if it does not receive a response within 100 ms.

    Parameters

    • callback: (() => boolean)
        • (): boolean

        • Returns boolean

    Returns (() => void)

      • (): void

      • Returns void

enableExitConfirmation

  • enableExitConfirmation(options): Promise<void>

  • Parameters

    • options: {
          title?: string;
          message?: string;
          confirm?: string;
          ignore?: string;
      }
      • Optionaltitle?: string
      • Optionalmessage?: string
      • Optionalconfirm?: string
      • Optionalignore?: string

    Returns Promise<void>

disableExitConfirmation

  • disableExitConfirmation(): Promise<void>

  • Returns Promise<void>

Settings

On This Page

Methods