Interface MbpEmbedClientUi

Methods available as mbpClient.ui.

See the getting started guide for initial UI setup.

interface MbpEmbedClientUi {
    setTitle(title: string): Promise<void>;
    setDescription(description: string): Promise<void>;
    setBacklinkLabel(label: string): Promise<void>;
    setStatusLoading(isLoading?: boolean): Promise<void>;
    setStatusSuccess(options: {
        title?: string;
        message?: string;
    }): Promise<void>;
    setStatusError(options: {
        title?: string;
        message?: string;
    }): Promise<void>;
}

Methods

setTitle setDescription setBacklinkLabel setStatusLoading setStatusSuccess setStatusError

Methods

setTitle

  • setTitle(title): Promise<void>

  • Parameters

    • title: string

    Returns Promise<void>

setDescription

  • setDescription(description): Promise<void>

  • Parameters

    • description: string

    Returns Promise<void>

setBacklinkLabel

  • setBacklinkLabel(label): Promise<void>

  • Parameters

    • label: string

    Returns Promise<void>

setStatusLoading

  • setStatusLoading(isLoading?): Promise<void>

  • Parameters

    • OptionalisLoading: boolean

    Returns Promise<void>

setStatusSuccess

  • setStatusSuccess(options): Promise<void>

  • Parameters

    • options: {
          title?: string;
          message?: string;
      }
      • Optionaltitle?: string
      • Optionalmessage?: string

    Returns Promise<void>

setStatusError

  • setStatusError(options): Promise<void>

  • Parameters

    • options: {
          title?: string;
          message?: string;
      }
      • Optionaltitle?: string
      • Optionalmessage?: string

    Returns Promise<void>

Settings

On This Page

Methods