GeckoView API Changelog.

⚠️ breaking change and deprecation notices

v82

⚠️ WebNotification.source is now @Nullable to account for WebExtension notifications which don’t have a source field.
⚠️ Deprecated ContentDelegate#onExternalResponse(GeckoSession, WebResponseInfo) with the intention of removing them in GeckoView v85. (bug 1530022)
Added ContentDelegate#onExternalResponse(GeckoSession, WebResponse) to eliminate the need to make a second request for downloads and ensure more efficient and reliable downloads in a single request. The second parameter is now a WebResponse (bug 1530022)
Added Image support for size-dependent bitmap retrieval from image resources. (bug 1658456)
⚠️ Use Image for MediaSession artwork and WebExtension icon support. (bug 1662508)
Added RepostConfirmPrompt to prompt the user for cofirmation before resending POST requests. (bug 1659073)
Removed Parcelable support in GeckoSession. Use ProgressDelegate#onSessionStateChange and ProgressDelegate#restoreState instead. (bug 1650108)

v81

Added cookiePurging to ContentBlocking.Settings.Builder and getCookiePurging and setCookiePurging to ContentBlocking.Settings.
Added GeckoSession.ContentDelegate.onPaintStatusReset() callback which notifies when valid content is no longer being rendered.
Made GeckoSession.ContentDelegate.onFirstContentfulPaint() additionally be called for the first contentful paint following a onPaintStatusReset() event, rather than just the first contentful paint of the session.
Removed deprecated GeckoRuntime.registerWebExtension. Use WebExtensionController.install instead. ⚠️ - Changed GeckoView.onTouchEventForResult to return a GeckoResult, as it now makes a round-trip to Gecko. The result will be more accurate now, since how content treats the event is now considered.
Added MediaSession API for session-based media events and control.

v80

Removed GeckoSession.hashCode and GeckoSession.equals overrides in favor of the default implementations. (bug 1647883)
Added strictSocialTrackingProtection to ContentBlocking.Settings.Builder and getStrictSocialTrackingProtection to ContentBlocking.Settings.

v79

Added runtime.openOptionsPage support. For options_ui.open_in_new_tab == false, TabDelegate.onOpenOptionsPage is called. (bug 1618058)
Added WebNotification.source, which is the URL of the page or Service Worker that created the notification.
Removed deprecated WebExtensionController.setTabDelegate and WebExtensionController.getTabDelegate APIs (bug 1618987).
⚠️ RuntimeTelemetry#getSnapshots is removed after deprecation. Use Glean to handle Gecko telemetry. (bug 1644447)
Added ensureBuiltIn that ensures that a built-in extension is installed without re-installing. (bug 1635564)
Added ProfilerController, accessible via GeckoRuntime.getProfilerController to allow adding gecko profiler markers. (bug 1624993)
⚠️ Deprecated Parcelable support in GeckoSession with the intention of removing in GeckoView v82. (bug 1649529)
⚠️ Deprecated GeckoRuntimeSettings.Builder.useMultiprocess and GeckoRuntimeSettings.getUseMultiprocess with the intention of removing them in GeckoView v82. (bug 1649530)

v78

Added WebExtensionController.installBuiltIn that allows installing an extension that is bundled with the APK. This method is meant as a replacement for GeckoRuntime.registerWebExtension, ⚠️ which is now deprecated and will be removed in GeckoView 81.
Added CookieBehavior.ACCEPT_FIRST_PARTY_AND_ISOLATE_OTHERS to allow enabling dynamic first party isolation; this will block tracking cookies and isolate all other third party cookies by keying them based on the first party from which they are accessed.
Added cookieStoreId field to WebExtension.CreateTabDetails. This adds the optional ability to create a tab with a given cookie store ID for its contextual identity. (bug 1622500)
Added NavigationDelegate.onSubframeLoadRequest to allow intercepting non-top-level navigations.
Added BeforeUnloadPrompt to respond to prompts from onbeforeunload.
⚠️ Refactored LoginStorage to the Autocomplete API to support login form autocomplete delegation. Refactored ‘LoginStorage.Delegate’ to ‘Autocomplete.LoginStorageDelegate’. Refactored GeckoSession.PromptDelegate.onLoginStoragePrompt to GeckoSession.PromptDelegate.onLoginSave. Added GeckoSession.PromptDelegate.onLoginSelect. (bug 1618058)
Added GeckoRuntimeSettings#setLoginAutofillEnabled to control whether login forms should be automatically filled in suitable situations.

v77

Added GeckoRuntime.appendAppNotesToCrashReport For adding app notes to the crash report. (bug 1626979)
⚠️ Remove the DynamicToolbarAnimator API along with accesors on GeckoView and GeckoSession. (bug 1627716)

v76

Added GeckoSession.PermissionDelegate.PERMISSION_MEDIA_KEY_SYSTEM_ACCESS to control EME media key access.
RuntimeTelemetry#getSnapshots is deprecated and will be removed in 79. Use Glean to handle Gecko telemetry. (bug 1620395)
Added [LoadRequest.isDirectNavigation] to know when calls to onLoadRequest originate from a direct navigation made by the app itself. (bug 1624675)

v75

⚠️ Remove GeckoRuntimeSettings.Builder#useContentProcessHint. The content process is now preloaded by default if GeckoRuntimeSettings.Builder#useMultiprocess is enabled.
⚠️ Move GeckoSessionSettings.Builder#useMultiprocess to GeckoRuntimeSettings.Builder#useMultiprocess. Multiprocess state is no longer determined per session.
Added DebuggerDelegate#onExtensionListUpdated to notify that a temporary extension has been installed by the debugger. (bug 1614295)
⚠️ Removed GeckoRuntimeSettings.setAutoplayDefault, use GeckoSession.PermissionDelegate#PERMISSION_AUTOPLAY_AUDIBLE and GeckoSession.PermissionDelegate#PERMISSION_AUTOPLAY_INAUDIBLE to control autoplay. (bug 1614894)
Added GeckoSession.reload(int flags) That takes a load flag parameter.
⚠️ Moved ActionDelegate and MessageDelegate to SessionController. (bug 1616625)
Added SessionTabDelegate to SessionController and TabDelegate to WebExtension which receive respectively calls for the session and the runtime. TabDelegate is also now per-WebExtension object instead of being global. The existing global TabDelegate is now deprecated and will be removed in GeckoView 77. (bug 1616625)
Added SessionTabDelegate#onUpdateTab which is called whenever an extension calls tabs.update on the corresponding GeckoSession. TabDelegate#onCreateTab now takes a CreateTabDetails object which contains additional information about the newly created tab (including the url which used to be passed in directly). (bug 1616625)
Added GeckoRuntimeSettings.setWebManifestEnabled, GeckoRuntimeSettings.webManifest, and GeckoRuntimeSettings.getWebManifestEnabled (bug 1614894), to enable or check Web Manifest support.
Added GeckoDisplay.safeAreaInsetsChanged to notify the content of safe area insets. (bug 1503656)
Added GeckoResult#cancel(), GeckoResult#setCancellationDelegate(), and GeckoResult.CancellationDelegate. This adds the optional ability to cancel an operation behind a pending GeckoResult.
Added baseUrl to WebExtension.MetaData to expose the base URL for all WebExtension pages for a given extension. (bug 1560048)
Added allowedInPrivateBrowsing and setAllowedInPrivateBrowsing to control whether an extension can run in private browsing or not. Extensions installed with registerWebExtension will always be allowed to run in private browsing. (bug 1599139)

v74

Added WebExtensionController.enable and disable to enable and disable extensions. (bug 1599585)
⚠️ Added ‘GeckoSession.ProgressDelegate.SecurityInformation#certificate’, which is the full server certificate in use, if any. The other certificate-related fields were removed. (bug 1508730)
Added ‘WebResponse#isSecure’, which indicates whether or not the response was delivered over a secure connection. (bug 1508730)
Added ‘WebResponse#certificate’, which is the server certificate used for the response, if any. (bug 1508730)
Added ‘WebRequestError#certificate’, which is the server certificate used in the failed request, if any. (bug 1508730)
⚠️ Updated ContentBlockingController to use new representation for content blocking exceptions and to add better support for removing exceptions. This deprecates ExceptionList and restoreExceptionList with the intent to remove them in 76. (bug 1587552)
Added GeckoSession.ContentDelegate.onMetaViewportFitChange. This exposes viewport-fit value that is CSS Round Display Level 1. (bug 1574307)
Extended LoginStorage.Delegate with onLoginUsed to report when existing login entries are used for autofill. (bug 1610353)
Added ‘WebExtensionController#setTabActive’, which is used to notify extensions about tab changes (bug 1597793)
Added ‘WebExtension.metaData.optionsUrl’ and ‘WebExtension.metaData.openOptionsPageInTab’, which is the addon metadata necessary to show their option pages. (bug 1598792)
Added WebExtensionController.update to update extensions. (bug 1599581)
⚠️ Replaced subscription argument in WebPushDelegate.onSubscriptionChanged from a WebPushSubscription to the String scope.

v73

Added WebExtensionController.install and uninstall to manage installed extensions
⚠️ Renamed ScreenLength.VIEWPORT_WIDTH, ScreenLength.VIEWPORT_HEIGHT, ScreenLength.fromViewportWidth and ScreenLength.fromViewportHeight to ScreenLength.VISUAL_VIEWPORT_WIDTH, ScreenLength.VISUAL_VIEWPORT_HEIGHT, ScreenLength.fromVisualViewportWidth and ScreenLength.fromVisualViewportHeight respectively.
Added the LoginStorage API. Apps may handle login fetch requests now by attaching a LoginStorage.Delegate via GeckoRuntime#setLoginStorageDelegate (bug 1602881)
⚠️ WebExtension’s constructor now requires a WebExtensionController instance.
Added GeckoResult.allOf for consuming a list of results.
Added WebExtensionController.list to list all installed extensions.
Added GeckoSession.PermissionDelegate#PERMISSION_AUTOPLAY_AUDIBLE and GeckoSession.PermissionDelegate#PERMISSION_AUTOPLAY_INAUDIBLE. These control autoplay permissions for audible and inaudible videos. (bug 1577596)
Added LoginStorage.Delegate.onLoginSave for login storage save requests and GeckoSession.PromptDelegate.onLoginStoragePrompt for login storage prompts. (bug 1599873)

v72

Added GeckoSession.NavigationDelegate.LoadRequest#hasUserGesture. This indicates if a load was requested while a user gesture was active (e.g., a tap). (bug 1555337)
⚠️ Refactored AutofillElement and AutofillSupport into the Autofill API. (bug 1591462)
Make read() in the InputStream returned from WebResponse#body timeout according to WebResponse#setReadTimeoutMillis(). The default timeout value is reflected in WebResponse#DEFAULT_READ_TIMEOUT_MS, currently 30s. (bug 1595145)
⚠️ Removed GeckoResponse (bug 1581161)
⚠️ Removed actions and response arguments from SelectionActionDelegate.onShowActionRequest and BasicSelectionActionDelegate.onShowActionRequest (bug 1581161)
Added text selection action methods to SelectionActionDelegate.Selection (bug 1581161)
Added BasicSelectionActionDelegate.getSelection (bug 1581161)
Changed BasicSelectionActionDelegate.clearSelection to public. (bug 1581161)
Added Autofill commit support. (bug 1577005)
Added GeckoView.setViewBackend to set whether GeckoView should be backed by a TextureView or a SurfaceView. (bug 1530402)
Added support for Browser and Page Action from the WebExtension API. See WebExtension.Action. (bug 1530402)
⚠️ Split ContentBlockingController.Event.LOADED_TRACKING_CONTENT into ContentBlockingController.Event.LOADED_LEVEL_1_TRACKING_CONTENT and ContentBlockingController.Event.LOADED_LEVEL_2_TRACKING_CONTENT.
Replaced subscription argument in WebPushDelegate.onPushEvent from a WebPushSubscription to the String scope.
⚠️ Renamed WebExtension.ActionIcon to Icon.
Added ‘GeckoWebExecutor#FETCH_FLAGS_STREAM_FAILURE_TEST’, which is a new flag used to immediately fail when reading a WebResponse body. (bug 1594905)
Changed CrashReporter#sendCrashReport(Context, File, JSONObject) to accept a JSON object instead of a Map. Said object also includes the application name that was previously passed as the fourth argument to the method, which was thus removed.
Added WebXR device access permission support, PERMISSION_PERSISTENT_XR. (bug 1599927)

v71

Added a content blocking flag for blocked social cookies to ContentBlocking. (bug 1584479)
Added onBooleanScalar, onLongScalar, onStringScalar to RuntimeTelemetry.Delegate to support scalars in streaming telemetry. ⚠️ As part of this change, onTelemetryReceived has been renamed to onHistogram, and Metric now takes a type parameter. (bug 1576730)
Added overloads of GeckoSession.loadUri that accept a map of additional HTTP request headers. (bug 1567549)
Added support for exposing the content blocking log in ContentBlockingController. (bug 1580201)
⚠️ Added nativeApp to WebExtension.MessageDelegate.onMessage which exposes the native application identifier that was used to send the message. (bug 1546445)
Added GeckoRuntime.ServiceWorkerDelegate set via setServiceWorkerDelegate to support ServiceWorkerClients.openWindow (bug 1511033)
Added GeckoRuntimeSettings.Builder#aboutConfigEnabled to control whether or not about:config should be available. (bug 1540065)
Added GeckoSession.ContentDelegate.onFirstContentfulPaint (bug 1578947)
Added setEnhancedTrackingProtectionLevel to [ContentBlocking.Settings][71.14]. (bug 1580854)
⚠️ Added GeckoView.onTouchEventForResult and modified PanZoomController.onTouchEvent to return how the touch event was handled. This allows apps to know if an event is handled by touch event listeners in web content. The methods in PanZoomController now return int instead of boolean.
Added GeckoSession.purgeHistory allowing apps to clear a session’s history. (bug 1583265)
Added GeckoRuntimeSettings.Builder#forceUserScalableEnabled to control whether or not to force user scalable zooming. (bug 1540615)
⚠️ Moved Autofill related methods from SessionTextInput and GeckoSession.TextInputDelegate into GeckoSession and AutofillDelegate.
Added GeckoSession.getAutofillElements(), which is a new method for getting an autofill virtual structure without using ViewStructure. It relies on a new class, AutofillElement, for representing the virtual tree.
Added GeckoView.setAutofillEnabled for controlling whether or not the GeckoView instance participates in Android autofill. When enabled, this connects an AutofillDelegate to the session it holds.
Changed AutofillElement.children interface to Collection to provide an efficient way to pre-allocate memory when filling ViewStructure.
Added GeckoSession.PromptDelegate.onSharePrompt to support the WebShare API. (bug 1402369)
Added GeckoDisplay.screenshot allowing apps finer grain control over screenshots. (bug 1577192)
Added GeckoView.setDynamicToolbarMaxHeight to make ICB size static, ICB doesn’t include the dynamic toolbar region. (bug 1586144)

v70

Added API for session context assignment GeckoSessionSettings.Builder.contextId and deletion of data related to a session context StorageController.clearDataForSessionContext. (bug 1501108)
Removed setSession(session, runtime) from GeckoView. With this change, GeckoView will no longer manage opening/closing of the GeckoSession and instead leave that up to the app. It’s also now allowed to call setSession with a closed GeckoSession. (bug 1510314)
Added an overload of GeckoSession.loadUri() that accepts a referring GeckoSession. This should be used when the URI we’re loading originates from another page. A common example of this would be long pressing a link and then opening that in a new GeckoSession. (bug 1561079)
Added capture parameter to onFilePrompt and corresponding CAPTURE_TYPE_* constants. (bug 1553603)
Removed the obsolete success parameter from CrashReporter#sendCrashReport(Context, File, File, String) and CrashReporter#sendCrashReport(Context, File, Map, String). (bug 1570789)
Add GeckoSession.LOAD_FLAGS_REPLACE_HISTORY. (bug 1571088)
Complete rewrite of PromptDelegate. (bug 1499394)
Added RuntimeTelemetry.Delegate that receives streaming telemetry data from GeckoView. (bug 1566367)
Updated ContentBlocking to better report blocked and allowed ETP events. (bug 1567268)
Added API for controlling Gecko logging GeckoRuntimeSettings.debugLogging (bug 1573304)
Added WebNotification and WebNotificationDelegate for handling Web Notifications. (bug 1533057)
Added Social Tracking Protection support to ContentBlocking. (bug 1568295)
Added WebExtensionController and WebExtensionController.TabDelegate to handle browser.tabs.create calls by WebExtensions. (bug 1539144)
Added onCloseTab to WebExtensionController.TabDelegate to handle browser.tabs.remove calls by WebExtensions. (bug 1565782)
Added onSlowScript to ContentDelegate which allows handling of slow and hung scripts. (bug 1621094)
Added support for Web Push via WebPushController, WebPushDelegate, and WebPushSubscription.
Added ContentBlockingController, accessible via GeckoRuntime.getContentBlockingController to allow modification and inspection of a content blocking exception list.

v69

Modified behavior of ‘setAutomaticFontSizeAdjustment’ so that it no longer has any effect on ‘setFontInflationEnabled’
Add GeckoSession.LOAD_FLAGS_FORCE_ALLOW_DATA_URI
Added GeckoResult.accept for consuming a result without transforming it.
GeckoSession.setMessageDelegate callers must now specify the WebExtension that the MessageDelegate will receive messages from.
Created onKill to ContentDelegate to differentiate from crashes.

v68

Added GeckoRuntime#configurationChanged to notify the device configuration has changed.
Added onSessionStateChange to ProgressDelegate and removed saveState.
Added ContentBlocking#AT_CRYPTOMINING for cryptocurrency miner blocking.
Added ContentBlocking#AT_DEFAULT, ContentBlocking#AT_STRICT, ContentBlocking#CB_DEFAULT and ContentBlocking#CB_STRICT for clearer app default selections.
Added GeckoSession.SessionState.fromString. This can be used to deserialize a GeckoSession.SessionState instance previously serialized to a String via GeckoSession.SessionState.toString.
Added GeckoRuntimeSettings#setPreferredColorScheme to override the default color theme for web content (“light” or “dark”).
Added @NonNull or @Nullable to all fields.
RuntimeTelemetry#getSnapshots returns a JSONObject now.
Removed all org.mozilla.gecko references in the API.
Added ContentBlocking#AT_FINGERPRINTING to block fingerprinting trackers.
Added HistoryItem and HistoryList interfaces and onHistoryStateChange to HistoryDelegate and added gotoHistoryIndex to GeckoSession.
GeckoView will not create a GeckoSession anymore when attached to a window without a session.
Added GeckoRuntimeSettings.Builder#configFilePath to set a path to a configuration file from which GeckoView will read configuration options such as Gecko process arguments, environment variables, and preferences.
Added unregisterWebExtension to unregister a web extension.
Added messaging support for WebExtension. setMessageDelegate allows embedders to listen to messages coming from a WebExtension. Port allows bidirectional communication between the embedder and the WebExtension.
Expose the following prefs in GeckoRuntimeSettings: setAutoZoomEnabled, setDoubleTapZoomingEnabled, setGlMsaaLevel.
Added new constant for requesting external storage Android permissions, PERMISSION_PERSISTENT_STORAGE
Added setVerticalClipping to GeckoDisplay and GeckoView to tell Gecko how much of its vertical space is clipped.
Added StorageController API for clearing data.
Added onRecordingStatusChanged to MediaDelegate to handle events related to the status of recording devices.
Removed redundant constants in MediaSource

v67

Added setAutomaticFontSizeAdjustment to GeckoRuntimeSettings for automatically adjusting font size settings depending on the OS-level font size setting.
Added setFontSizeFactor to GeckoRuntimeSettings for setting a font size scaling factor, and for enabling font inflation for non-mobile-friendly pages.
Updated video autoplay API to reflect changes in Gecko. Instead of being a per-video permission in the PermissionDelegate, it is a runtime setting that either allows or blocks autoplay videos.
Change ContentBlocking.AT_AD and ContentBlocking.SB_ALL values to mirror the actual constants they encompass.
Added nested ContentBlocking runtime settings.
Added RuntimeSettings base class to support nested settings.
Added baseUri to ContentDelegate.ContextElement and changed linkUri to absolute form.
Added scrollBy and scrollTo to PanZoomController.
Added GeckoSession.getDefaultUserAgent to expose the build-time default user agent synchronously.
Changed WebResponse.body from a ByteBuffer to an InputStream. Apps that want access to the entire response body will now need to read the stream themselves.
Added GeckoWebExecutor.FETCH_FLAGS_NO_REDIRECTS, which will cause GeckoWebExecutor.fetch() to not automatically follow HTTP redirects (e.g., 302).
Moved GeckoVRManager into the org.mozilla.geckoview package.
Initial WebExtension support. GeckoRuntime#registerWebExtension allows embedders to register a local web extension.
Added API to GeckoView to take screenshot of the visible page. Calling capturePixels returns a ‘GeckoResult’ that completes to a Bitmap of the current Surface contents, or an IllegalStateException if the GeckoSession is not ready to render content.
Added API to capture a screenshot to GeckoDisplay. capturePixels returns a ‘GeckoResult’ that completes to a Bitmap of the current Surface contents, or an IllegalStateException if the GeckoSession is not ready to render content.
Add missing @Nullable annotation to return value for GeckoSession.PromptDelegate.ChoiceCallback.onPopupResult()
Added default implementations for all non-functional interfaces.
Added ContentDelegate.onWebAppManifest, which will deliver the contents of a parsed and validated Web App Manifest on pages that contain one.

v66

Removed redundant field trackingMode from SecurityInformation. Use TrackingProtectionDelegate.onTrackerBlocked for notification of blocked elements during page load.
Added @NonNull or @Nullable to all APIs.
Added methods for each setting in GeckoSessionSettings
Added GeckoSessionSettings for enabling desktop viewport. Desktop viewport is no longer set by USER_AGENT_MODE_DESKTOP and must be set separately.
Added @UiThread to GeckoSession.releaseSession and GeckoSession.setSession

v65

Added experimental ad-blocking category to GeckoSession.TrackingProtectionDelegate.
Moved CompositorController, DynamicToolbarAnimator, OverscrollEdgeEffect, PanZoomController from org.mozilla.gecko.gfx to org.mozilla.geckoview
Added @UiThread, @AnyThread annotations to all APIs
Changed GeckoRuntimeSettings#getLocale to getLocales and related APIs.
Merged org.mozilla.gecko.gfx.LayerSession into GeckoSession
Added GeckoSession.MediaDelegate and MediaElement. This allow monitoring and control of web media elements (play, pause, seek, etc).
Removed unused access parameter from GeckoSession.PermissionDelegate#onContentPermissionRequest
Added WebMessage, WebRequest, WebResponse, and GeckoWebExecutor. This exposes Gecko networking to apps. It includes speculative connections, name resolution, and a Fetch-like HTTP API.
Added GeckoSession.HistoryDelegate. This allows apps to implement their own history storage system and provide visited link status.
Added ContentDelegate#onFirstComposite to get first composite callback after a compositor start.
Changed LoadRequest.isUserTriggered to isRedirect.
Added GeckoSession.LOAD_FLAGS_BYPASS_CLASSIFIER to bypass the URI classifier.
Added a protected empty constructor to all field-only classes so that apps can mock these classes in tests.
Added ContentDelegate.ContextElement to extend the information passed to ContentDelegate#onContextMenu. Extended information includes the element’s title and alt attributes.
Changed ContentDelegate.ContextElement TYPE_ constants to public access.
Changed ContentDelegate.ContextElement, GeckoSession.FinderResult to non-final class.
Update CrashReporter#sendCrashReport to return the crash ID as a GeckoResult<String>.