Interface MbpEmbedClient

interface MbpEmbedClient {
    connect(): Promise<void>;
    id: string;
    version: string;
    ui: {
        setTitle: ((title) => Promise<void>);
        setDescription: ((description) => Promise<void>);
        setBacklinkLabel: ((label) => Promise<void>);
        setStatusLoading: ((isLoading?) => Promise<void>);
        setStatusSuccess: ((opts) => Promise<void>);
        setStatusError: ((opts) => Promise<void>);
        enableExitConfirmation: ((opts) => Promise<void>);
        disableExitConfirmation: (() => Promise<void>);
    };
    navigation: {
        back: (() => Promise<void>);
        openNewEmbed: ((url) => Promise<void>);
        openExternal: ((url) => Promise<void>);
    };
    context: {
        getTenant: (() => Promise<Tenant>);
        getIpdcProduct: (() => Promise<IpdcProduct>);
    };
    appointment: {
        start: (() => Promise<{
            products: IpdcProduct[];
        }>);
        create: ((appointment) => Promise<void>);
        cancel: ((id?) => Promise<void>);
    };
}

Hierarchy

  • Client
    • MbpEmbedClient

Methods

connect

Properties

id version ui navigation context appointment

Methods

connect

  • connect(): Promise<void>

  • Returns Promise<void>

Properties

Readonly id

id: string

Readonly version

version: string

Namespace ui

ui: {
    setTitle: ((title) => Promise<void>);
    setDescription: ((description) => Promise<void>);
    setBacklinkLabel: ((label) => Promise<void>);
    setStatusLoading: ((isLoading?) => Promise<void>);
    setStatusSuccess: ((opts) => Promise<void>);
    setStatusError: ((opts) => Promise<void>);
    enableExitConfirmation: ((opts) => Promise<void>);
    disableExitConfirmation: (() => Promise<void>);
} = ...

Type declaration

  • Readonly setTitle: ((title) => Promise<void>)
      • (title): Promise<void>

      • Parameters

        • title: string

        Returns Promise<void>

  • Readonly setDescription: ((description) => Promise<void>)
      • (description): Promise<void>

      • Parameters

        • description: string

        Returns Promise<void>

  • Readonly setBacklinkLabel: ((label) => Promise<void>)
      • (label): Promise<void>

      • Parameters

        • label: string

        Returns Promise<void>

  • Readonly setStatusLoading: ((isLoading?) => Promise<void>)
      • (isLoading?): Promise<void>

      • Parameters

        • isLoading: boolean = true

        Returns Promise<void>

  • Readonly setStatusSuccess: ((opts) => Promise<void>)
      • (opts): Promise<void>

      • Parameters

        • opts: {
              title?: string;
              message?: string;
          }
          • Optional title?: string
          • Optional message?: string

        Returns Promise<void>

  • Readonly setStatusError: ((opts) => Promise<void>)
      • (opts): Promise<void>

      • Parameters

        • opts: {
              title?: string;
              message?: string;
          }
          • Optional title?: string
          • Optional message?: string

        Returns Promise<void>

  • Readonly enableExitConfirmation: ((opts) => Promise<void>)
      • (opts): Promise<void>

      • Parameters

        • opts: {
              title?: string;
              message?: string;
              confirm?: string;
              ignore?: string;
          }
          • Optional title?: string
          • Optional message?: string
          • Optional confirm?: string
          • Optional ignore?: string

        Returns Promise<void>

  • Readonly disableExitConfirmation: (() => Promise<void>)
      • (): Promise<void>

      • Returns Promise<void>

Namespace navigation

navigation: {
    back: (() => Promise<void>);
    openNewEmbed: ((url) => Promise<void>);
    openExternal: ((url) => Promise<void>);
} = ...

Type declaration

  • back: (() => Promise<void>)
      • (): Promise<void>

      • Returns Promise<void>

  • openNewEmbed: ((url) => Promise<void>)
      • (url): Promise<void>

      • Parameters

        • url: string

        Returns Promise<void>

  • openExternal: ((url) => Promise<void>)
      • (url): Promise<void>

      • Parameters

        • url: string

        Returns Promise<void>

Namespace context

context: {
    getTenant: (() => Promise<Tenant>);
    getIpdcProduct: (() => Promise<IpdcProduct>);
} = ...

Type declaration

Namespace appointment

appointment: {
    start: (() => Promise<{
        products: IpdcProduct[];
    }>);
    create: ((appointment) => Promise<void>);
    cancel: ((id?) => Promise<void>);
} = ...

Type declaration

  • start: (() => Promise<{
        products: IpdcProduct[];
    }>)
  • create: ((appointment) => Promise<void>)
      • (appointment): Promise<void>

      • Parameters

        Returns Promise<void>

  • cancel: ((id?) => Promise<void>)
      • (id?): Promise<void>

      • Parameters

        • Optional id: string

        Returns Promise<void>

Settings

Theme

On This Page

connectidversionuinavigationcontextappointment