Class OnboardingMessages

injectName

dismissToAddressBar

• dismissToAddressBar(): void

  Sent when the "Start Browsing" button has been clicked.

  Returns void

dismissToSettings

• dismissToSettings(): void

  Sent when onboarding is complete and the user has chosen to go to settings

  Returns void

init

• init(): Promise<InitResponse>

  Sends an initial message to the native layer. This is the opportunity for the native layer to provide the initial state of the application or any configuration, for example:

  {
    "stepDefinitions": {
      "systemSettings": {
        "rows": ["dock", "import", "default-browser"]
      }
    },
    "order": "v2",
    "exclude": ["dockSingle"],
    "locale": "en"
  }
  Copy

  In that example, the native layer is providing the list of rows that should be shown in the systemSettings step, overriding the default list provided in data.js.

  Returns Promise<InitResponse>

reportInitException

• reportInitException(params: { message: string }): void

  This will be sent if the application fails to load.

  Parameters

  • params: { message: string }

  Returns void

reportPageException

• reportPageException(
      params: {
          id:
              | "summary"
              | "customize"
              | "welcome"
              | "getStarted"
              | "privateByDefault"
              | "cleanerBrowsing"
              | "systemSettings"
              | "dockSingle"
              | "importSingle"
              | "makeDefaultSingle"
              | "duckPlayerSingle";
          message: string;
      },
  ): void

  This will be sent if the application has loaded, but a client-side error has occurred that cannot be recovered from

  Parameters

  • params: {
        id:
            | "summary"
            | "customize"
            | "welcome"
            | "getStarted"
            | "privateByDefault"
            | "cleanerBrowsing"
            | "systemSettings"
            | "dockSingle"
            | "importSingle"
            | "makeDefaultSingle"
            | "duckPlayerSingle";
        message: string;
    }

  Returns void

requestDockOptIn

• requestDockOptIn(): Promise<any>

  Sent when the user wants to keep the application in the dock/taskbar.

  Native side should respond when the operation is 'complete'.

  Returns Promise<any>

requestImport

• requestImport(): Promise<any>

  Sent when the user wants to import data. The UI will remain in a loading state until the native layer sends a response.

  Native side should respond when the operation is 'complete'.

  Returns Promise<any>

requestSetAsDefault

• requestSetAsDefault(): Promise<any>

  Sent when the user wants to set DuckDuckGo as their default browser. The UI will remain in a loading state until the native layer sends a response.

  Native side should respond when the operation is 'complete'.

  Returns Promise<any>

setBookmarksBar

• setBookmarksBar(params: BooleanSystemValue): void

  Sent when the user wants to enable or disable the bookmarks bar

  Parameters

  • params: BooleanSystemValue

  Returns void

setSessionRestore

• setSessionRestore(params: BooleanSystemValue): void

  Sent when the user wants to enable or disable the session restore setting

  Parameters

  • params: BooleanSystemValue

  Returns void

setShowHomeButton

• setShowHomeButton(params: BooleanSystemValue): void

  Sent when the user wants to enable or disable the home button Note: Although the home button can placed in multiple places in the browser taskbar, this application will only ever send enabled/disabled to the native layer

  Parameters

  • params: BooleanSystemValue

  Returns void

stepCompleted

• stepCompleted(params: StepCompleteParams): void

  Sends a notification to the native layer that the user has completed a step

  Parameters

  • params: StepCompleteParams

  Returns void