Class PrivacyDashboardJavascriptInterface

This describes the JavaScript Interface, PrivacyDashboard, that gets added to the window object by Android.

The Privacy Dashboard communicates with Android by calling methods on that global object.

For example, to show the breakage form, we'd call:

window.PrivacyDashboard.showBreakageForm()

Each method documented below is intended

Methods

close getToggleReportOptions openInNewTab openSettings rejectToggleReport seeWhatIsSent sendToggleReport showBreakageForm showNativeFeedback submitBrokenSiteReport toggleAllowlist

Methods

close

getToggleReportOptions

openInNewTab

  • openInNewTab(payload): void

  • Calling this method should close the dashboard and open the given URL in a new tab.

    Parameters

    • payload: {
          url: string;
      }
      • url: string

    Returns void

openSettings

  • openSettings(payload): void

  • Calling this method should open the settings at the 'target' provided

    Supported targets:

    • cpm - used from the Cookie Prompt Management screen when user taps 'disable in settings'

    Parameters

    • payload: {
          target: "cpm";
      }
      • target: "cpm"

    Returns void

rejectToggleReport

seeWhatIsSent

sendToggleReport

showBreakageForm

  • showBreakageForm(): void

  • Shows the native breakage form, instead of using the one embedded in the Privacy Dashboard

    Returns void

    Example

    window.PrivacyDashboard.showBreakageForm()

showNativeFeedback

submitBrokenSiteReport

toggleAllowlist

  • toggleAllowlist(params): void

  • Parameters

    • params: SetProtectionParams

      Add the current domain to the 'allowlist'

      window.PrivacyDashboard.toggleAllowlist(JSON.stringify({
        "isProtected": true,
        "eventOrigin": { "screen": "primaryScreen" }
      }))

      Remove the current domain from the 'allowlist'

      window.PrivacyDashboard.toggleAllowlist(JSON.stringify({
        "isProtected": false,
        "eventOrigin": { "screen": "primaryScreen" }
      }))

    Returns void

Settings

Member Visibility

On This Page

Methods