org.mozilla.geckoview (geckoview 88.0.20210226161356 API)

Interface Summary
Interface	Description
Autocomplete.LoginStorageDelegate	Implement this interface to handle runtime login storage requests.
Autofill.Delegate
ContentBlocking.Delegate	GeckoSession applications implement this interface to handle content blocking events.
GeckoResult.CancellationDelegate	Interface used to delegate cancellation operations for a `GeckoResult`.
GeckoResult.Consumer<T>	Replacement for `Consumer` for devices with minApi < 24.
GeckoResult.OnExceptionListener<V>	An interface used to deliver exceptions to listeners of a `GeckoResult`
GeckoResult.OnExceptionMapper	An interface used to map `GeckoResult` exceptions.
GeckoResult.OnValueListener<T,U>	An interface used to deliver values to listeners of a `GeckoResult`
GeckoResult.OnValueMapper<T,U>	An interface used to map `GeckoResult` values.
GeckoRuntime.ActivityDelegate	This is used to allow GeckoRuntime to start activities via the embedding application (and `Activity`).
GeckoRuntime.Delegate
GeckoRuntime.ServiceWorkerDelegate
GeckoSession.ContentDelegate
GeckoSession.HistoryDelegate	An interface for recording new history visits and fetching the visited status for links.
GeckoSession.HistoryDelegate.HistoryItem	A representation of an entry in browser history.
GeckoSession.HistoryDelegate.HistoryList	A representation of browser history, accessible as a `List`.
GeckoSession.MediaDelegate	GeckoSession applications implement this interface to handle media events.
GeckoSession.NavigationDelegate
GeckoSession.PermissionDelegate	GeckoSession applications implement this interface to handle requests for permissions from content, such as geolocation and notifications.
GeckoSession.PermissionDelegate.Callback	Callback interface for notifying the result of a permission request.
GeckoSession.PermissionDelegate.MediaCallback	Callback interface for notifying the result of a media permission request, including which media source(s) to use.
GeckoSession.ProgressDelegate
GeckoSession.PromptDelegate	GeckoSession applications implement this interface to handle prompts triggered by content in the GeckoSession, such as alerts, authentication dialogs, and select list pickers.
GeckoSession.ScrollDelegate	GeckoSession applications implement this interface to handle content scroll events.
GeckoSession.SelectionActionDelegate
GeckoSession.TextInputDelegate	Interface that SessionTextInput uses for performing operations such as opening and closing the software keyboard.
MediaElement.Delegate	This interface allows apps to handle media events.
MediaSession.Delegate	Implement this delegate to receive media session events.
RuntimeTelemetry.Delegate	The runtime telemetry delegate.
WebExtension.ActionDelegate	Receives updates whenever a Browser action or a Page action has been defined by an extension.
WebExtension.BrowsingDataDelegate	This delegate is used to handle calls from the \|browsingData\| WebExtension API.
WebExtension.Download.Info	Interface for communicating the state of downloads to Web Extensions.
WebExtension.DownloadDelegate
WebExtension.MessageDelegate	Delegates that responds to messages sent from a WebExtension.
WebExtension.PortDelegate	Delegate that handles communication from a WebExtension on a specific `WebExtension.Port` instance.
WebExtension.SessionTabDelegate	This delegate is invoked whenever an extension uses the `tabs` WebExtension API to modify the state of a tab.
WebExtension.TabDelegate	This delegate is invoked whenever an extension uses the `tabs` WebExtension API and the request is not specific to an existing tab, e.g.
WebExtensionController.DebuggerDelegate
WebExtensionController.PromptDelegate	This delegate will be called whenever an extension is about to be installed or it needs new permissions, e.g during an update or because it called `permissions.request`
WebNotificationDelegate
WebPushDelegate

Class Summary
Class	Description
Autocomplete	The Autocomplete API provides a way to leverage Gecko's input form handling for autocompletion.
Autocomplete.LoginEntry	Holds login information for a specific entry.
Autocomplete.LoginEntry.Builder
Autocomplete.LoginSaveOption	Holds information required to process login saving requests.
Autocomplete.LoginSaveOption.Hint	Hint types for login saving requests.
Autocomplete.LoginSelectOption	Holds information required to process login selection requests.
Autocomplete.LoginSelectOption.Hint	Hint types for login selection requests.
Autocomplete.Option<T>	Abstract base class for Autocomplete options.
Autocomplete.SaveOption<T>	Abstract base class for saving options.
Autocomplete.SelectOption<T>	Abstract base class for saving options.
Autocomplete.UsedField	Possible login entry field types for `Autocomplete.LoginStorageDelegate.onLoginUsed(org.mozilla.geckoview.Autocomplete.LoginEntry, int)`.
Autofill
Autofill.Hint
Autofill.InputType
Autofill.Node	Represents an autofill node.
Autofill.Notify
Autofill.Session	Represents an autofill session.
BasicSelectionActionDelegate	Class that implements a basic SelectionActionDelegate.
CompositorController
ContentBlocking	Content Blocking API to hold and control anti-tracking, cookie and Safe Browsing settings.
ContentBlocking.AntiTracking
ContentBlocking.BlockEvent	Holds content block event details.
ContentBlocking.CookieBehavior
ContentBlocking.CookieLifetime
ContentBlocking.EtpLevel	Possible settings for ETP.
ContentBlocking.SafeBrowsing
ContentBlocking.SafeBrowsingProvider	Holds configuration for a SafeBrowsing provider.
ContentBlocking.SafeBrowsingProvider.Builder
ContentBlocking.Settings
ContentBlocking.Settings.Builder
ContentBlockingController	ContentBlockingController is used to manage and modify the content blocking exception list.
ContentBlockingController.ContentBlockingException
ContentBlockingController.Event
ContentBlockingController.LogEntry	An entry in the content blocking log for a site.
ContentBlockingController.LogEntry.BlockingData	Data about why a given entry was blocked.
CrashReporter	Sends a crash report to the Mozilla Socorro crash report server.
GeckoDisplay	Applications use a GeckoDisplay instance to provide `GeckoSession` with a `Surface` for displaying content.
GeckoDisplay.ScreenshotBuilder	Builder to construct screenshot requests.
GeckoResult<T>	GeckoResult is a class that represents an asynchronous result.
GeckoRuntime
GeckoRuntimeSettings
GeckoRuntimeSettings.Builder	Settings builder used to construct the settings object.
GeckoSession
GeckoSession.ContentDelegate.ContextElement	Element details for onContextMenu callbacks.
GeckoSession.FinderResult	Represent the result of a find-in-page operation.
GeckoSession.Loader	Main entry point for loading URIs into a `GeckoSession`.
GeckoSession.MediaDelegate.RecordingDevice
GeckoSession.MediaDelegate.RecordingDevice.Status
GeckoSession.MediaDelegate.RecordingDevice.Type
GeckoSession.NavigationDelegate.LoadRequest	Load request details.
GeckoSession.PermissionDelegate.MediaSource
GeckoSession.ProgressDelegate.SecurityInformation	Class representing security information for a site.
GeckoSession.PromptDelegate.AlertPrompt	AlertPrompt contains the information necessary to represent a JavaScript alert() call from content; it can only be dismissed, not confirmed.
GeckoSession.PromptDelegate.AuthPrompt	AuthPrompt contains the information necessary to represent an HTML authorization prompt generated by content.
GeckoSession.PromptDelegate.AuthPrompt.AuthOptions
GeckoSession.PromptDelegate.AuthPrompt.AuthOptions.Flags	Auth prompt flags.
GeckoSession.PromptDelegate.AuthPrompt.AuthOptions.Level	Auth prompt levels.
GeckoSession.PromptDelegate.AutocompleteRequest<T extends Autocomplete.Option<?>>	Request containing information required to resolve Autocomplete prompt requests.
GeckoSession.PromptDelegate.BasePrompt
GeckoSession.PromptDelegate.BeforeUnloadPrompt	BeforeUnloadPrompt represents the onbeforeunload prompt.
GeckoSession.PromptDelegate.ButtonPrompt	ButtonPrompt contains the information necessary to represent a JavaScript confirm() call from content.
GeckoSession.PromptDelegate.ButtonPrompt.Type
GeckoSession.PromptDelegate.ChoicePrompt	ChoicePrompt contains the information necessary to display a menu or list prompt generated by content.
GeckoSession.PromptDelegate.ChoicePrompt.Choice
GeckoSession.PromptDelegate.ChoicePrompt.Type
GeckoSession.PromptDelegate.ColorPrompt	ColorPrompt contains the information necessary to represent a prompt for color input generated by content.
GeckoSession.PromptDelegate.DateTimePrompt	DateTimePrompt contains the information necessary to represent a prompt for date and/or time input generated by content.
GeckoSession.PromptDelegate.DateTimePrompt.Type
GeckoSession.PromptDelegate.FilePrompt	FilePrompt contains the information necessary to represent a prompt for a file or files generated by content.
GeckoSession.PromptDelegate.FilePrompt.Capture	Possible capture attribute values.
GeckoSession.PromptDelegate.FilePrompt.Type	Types of file prompts.
GeckoSession.PromptDelegate.PopupPrompt	PopupPrompt contains the information necessary to represent a popup blocking request.
GeckoSession.PromptDelegate.PromptResponse	PromptResponse is an opaque class created upon confirming or dismissing a prompt.
GeckoSession.PromptDelegate.RepostConfirmPrompt	RepostConfirmPrompt represents a prompt shown whenever the browser needs to resubmit POST data (e.g.
GeckoSession.PromptDelegate.SharePrompt	SharePrompt contains the information necessary to represent a (v1) WebShare request.
GeckoSession.PromptDelegate.SharePrompt.Result	Possible results to a `GeckoSession.PromptDelegate.SharePrompt`.
GeckoSession.PromptDelegate.TextPrompt	TextPrompt contains the information necessary to represent a Javascript prompt() call from content.
GeckoSession.SelectionActionDelegate.Selection	Represents attributes of a selection.
GeckoSession.SessionState	Class representing a saved session state.
GeckoSession.WebResponseInfo	WebResponseInfo contains information about a single web response.
GeckoSessionSettings
GeckoSessionSettings.Builder	Settings builder used to construct the settings object.
GeckoSessionSettings.Key<T>
GeckoView
GeckoVRManager	Interface for registering the external VR context with WebVR.
GeckoWebExecutor	GeckoWebExecutor is responsible for fetching a `WebRequest` and delivering a `WebResponse` to the caller via `GeckoWebExecutor.fetch(WebRequest)`.
Image	Represents an Web API image resource as used in web app manifests and media session metadata.
MediaElement	GeckoSession applications can use this class to handle media events and control the HTMLMediaElement externally.
MediaElement.LoadProgressInfo	Data class that indicates infomation about a media load progress event.
MediaElement.Metadata	Data class with the Metadata associated to a Media Element.
MediaSession	The MediaSession API provides media controls and events for a GeckoSession.
MediaSession.ElementMetadata	The representation of a media element's metadata.
MediaSession.Feature	Flags for supported media session features.
MediaSession.Metadata	The representation of a media session's metadata.
MediaSession.PositionState	Holds the details of the media session's playback state.
OverscrollEdgeEffect
PanZoomController
PanZoomController.InputResultDetail	Represents how a `MotionEvent` was handled in Gecko.
ProfilerController	ProfilerController is used to manage GeckoProfiler related features.
RuntimeSettings	Base class for (nested) runtime settings.
RuntimeSettings.Builder<Settings extends RuntimeSettings>	Base class for (nested) runtime settings builders.
RuntimeTelemetry	The telemetry API gives access to telemetry data of the Gecko runtime.
RuntimeTelemetry.Histogram	The Histogram telemetry metric object.
RuntimeTelemetry.Metric<T>	The runtime telemetry metric object.
ScreenLength	ScreenLength is a class that represents a length on the screen using different units.
SessionAccessibility
SessionFinder	`SessionFinder` instances returned by `GeckoSession.getFinder()` performs find-in-page operations.
SessionTextInput	`SessionTextInput` handles text input for `GeckoSession` through key events or input methods.
StorageController	Manage runtime storage data.
StorageController.ClearFlags	Flags used for data clearing operations.
WebExtension	Represents a WebExtension that may be used by GeckoView.
WebExtension.Action	Represents either a Browser Action or a Page Action from the WebExtension API.
WebExtension.BlocklistStateFlags	Describes the blocklist state for a `WebExtension`.
WebExtension.BrowsingDataDelegate.Settings	This class represents the current default settings for the "Clear Data" functionality in the browser.
WebExtension.BrowsingDataDelegate.Type	Types of data that a browser "Clear Data" UI might have access to.
WebExtension.CreateTabDetails	Provides details about creating a tab with `tabs.create`.
WebExtension.DisabledFlags
WebExtension.Download	Represents a download for downloads API Instantiate using `WebExtensionController.createDownload(int)`
WebExtension.DownloadInitData	Represents initial information on a download provided to Web Extension
WebExtension.DownloadRequest	Represents Web Extension API specific download request
WebExtension.Flags
WebExtension.InstallException.ErrorCodes
WebExtension.MessageSender	Describes the sender of a message from a WebExtension.
WebExtension.Port	Port object that can be used for bidirectional communication with a WebExtension.
WebExtension.SessionController
WebExtension.SignedStateFlags	Describes the signed status for a `WebExtension`.
WebExtension.UpdateTabDetails	Provides details about upating a tab with `tabs.update`.
WebExtensionController
WebExtensionController.EnableSource	Contains the possible values for the `source` parameter in `WebExtensionController.enable(org.mozilla.geckoview.WebExtension, int)` and `WebExtensionController.disable(org.mozilla.geckoview.WebExtension, int)`.
WebMessage	This is an abstract base class for HTTP request and response types.
WebMessage.Builder	This is a Builder used by subclasses of `WebMessage`.
WebNotification	This class represents a single Web Notification.
WebPushController
WebPushSubscription	This class represents a single Web Push subscription, as described in the Web Push API specification.
WebRequest	WebRequest represents an HTTP[S] request.
WebRequest.Builder	Builder offers a convenient way for constructing `WebRequest` instances.
WebResponse	WebResponse represents an HTTP[S] response.
WebResponse.Builder	Builder offers a convenient way to create WebResponse instances.

Enum Summary
Enum	Description
AllowOrDeny	This represents a decision to allow or deny a request.
SlowScriptResponse	Used by a ContentDelegate to indicate what action to take on a slow script event.

Exception Summary
Exception	Description
GeckoResult.UncaughtException
Image.ImageProcessingException	Thrown whenever an image cannot be processed by `Image.getBitmap(int)`
WebExtension.InstallException	Extension thrown when an error occurs during extension installation.
WebRequestError	WebRequestError is simply a container for error codes and categories used by `GeckoSession.NavigationDelegate.onLoadError(GeckoSession, String, WebRequestError)`.

Annotation Types Summary
Annotation Type	Description
DeprecationSchedule	Additional metadata about a deprecation notice.
WebExtension.Download.DownloadInterruptReason	Represents a possible reason why a download was interrupted.
WebExtension.Download.DownloadState	Represents a download in progress where the app is currently receiving data from the server.

Package org.mozilla.geckoview Description

This package contains the public interfaces for the library.

GeckoRuntime is the entry point for starting and initializing Gecko. You can use this to preload Gecko before you need to load a page or to configure features such as crash reporting.
GeckoSession is where most interesting work happens, such as loading pages. It relies on GeckoRuntime to talk to Gecko.
GeckoView is the embeddable View. This is the most common way of getting a GeckoSession onto the screen.

Permissions

This library does not request any dangerous permissions in the manifest, though it's possible that some web features may require them. For instance, WebRTC video calls would need the Manifest.permission.CAMERA and Manifest.permission.RECORD_AUDIO permissions. Declaring these are at the application's discretion. If you want full web functionality, the following permissions should be declared:

For a detailed change log of the API see: CHANGELOG.