UITour

• UITour library API
  • Mozilla.UITour
    • Mozilla.UITour.ConfigurationName
    • Mozilla.UITour.HighlightEffect
    • Mozilla.UITour.MenuName
    • Mozilla.UITour.Target
    • Mozilla.UITour.addNavBarWidget
    • Mozilla.UITour.closeTab
    • Mozilla.UITour.forceShowReaderIcon
    • Mozilla.UITour.getConfiguration
    • Mozilla.UITour.getTreatmentTag
    • Mozilla.UITour.hideHighlight
    • Mozilla.UITour.hideInfo
    • Mozilla.UITour.hideMenu
    • Mozilla.UITour.observe
    • Mozilla.UITour.openPreferences
    • Mozilla.UITour.openSearchPanel
    • Mozilla.UITour.ping
    • Mozilla.UITour.registerPageID
    • Mozilla.UITour.resetFirefox
    • Mozilla.UITour.setConfiguration
    • Mozilla.UITour.setDefaultSearchEngine
    • Mozilla.UITour.setSearchTerm
    • Mozilla.UITour.setTreatmentTag
    • Mozilla.UITour.showConnectAnotherDevice
    • Mozilla.UITour.showFirefoxAccounts
    • Mozilla.UITour.showHighlight
    • Mozilla.UITour.showInfo
    • Mozilla.UITour.showMenu
    • Mozilla.UITour.showNewTab
    • Mozilla.UITour.showProtectionReport
    • Mozilla.UITour.toggleReaderMode
  • Mozilla.UITour.Configuration
    • Mozilla.UITour.Configuration.AccountService
    • Mozilla.UITour.Configuration.AccountServices
    • Mozilla.UITour.Configuration.AppInfo
    • Mozilla.UITour.Configuration.AvailableTargets
    • Mozilla.UITour.Configuration.BrowserServices
    • Mozilla.UITour.Configuration.CanReset
    • Mozilla.UITour.Configuration.FxA
    • Mozilla.UITour.Configuration.FxAConnections
    • Mozilla.UITour.Configuration.Search
    • Mozilla.UITour.Configuration.Sync

class Mozilla.UITour()

Library that exposes an event-based Web API for communicating with the desktop browser chrome. It can be used for tasks such as opening menu panels and highlighting the position of buttons in the toolbar.

For security/privacy reasons Mozilla.UITour will only work on a list of allowed secure origins. The list of allowed origins can be found in https://searchfox.org/mozilla-central/source/browser/app/permissions.