GeckoRuntimeis 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.
GeckoSessionis where most interesting work happens, such as loading pages. It relies on
GeckoRuntimeto talk to Gecko.
GeckoViewis the embeddable
View. This is the most common way of getting a
GeckoSessiononto the screen.
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
permissions. Declaring these are at the application's discretion. If you want full web
functionality, the following permissions should be declared:
ClassDescriptionThis represents a decision to allow or deny a request.The Autocomplete API provides a way to leverage Gecko's input form handling for autocompletion.Holds address information for a specific entry.Holds information required to process address saving requests.Holds information required to process address selection requests.Hint types for credit card selection requests.Holds credit card information for a specific entry.Holds information required to process credit card saving requests.Holds information required to process credit card selection requests.Hint types for credit card selection requests.Holds login information for a specific entry.Holds information required to process login saving requests.Holds information required to process login selection requests.Abstract base class for Autocomplete options.Abstract base class for saving options.Hint types for login saving requests.Abstract base class for saving options.Hint types for selection requests.Implement this interface to handle runtime login storage requests.Possible login entry field types for
Autocomplete.StorageDelegate.onLoginUsed(org.mozilla.geckoview.Autocomplete.LoginEntry, int).Represents an autofill node.Represents autofill data associated to a
Autofill.Node.Deprecated.Represents an autofill session.Class that implements a basic SelectionActionDelegate.Content Blocking API to hold and control anti-tracking, cookie and Safe Browsing settings.Holds content block event details.GeckoSession applications implement this interface to handle content blocking events.Possible settings for ETP.Holds configuration for a SafeBrowsing provider.ContentBlockingController is used to manage and modify the content blocking exception list.An entry in the content blocking log for a site.Data about why a given entry was blocked.Sends a crash report to the Mozilla Socorro crash report server.Additional metadata about a deprecation notice.Builder to construct screenshot requests.Wrapper class containing a Surface and associated information that the compositor should render in to.Helper class for constructing a
GeckoDisplay.SurfaceInfoobject.GeckoResult<T>GeckoResult is a class that represents an asynchronous result.Interface used to delegate cancellation operations for a
Consumerfor devices with minApi < 24.An interface used to deliver exceptions to listeners of a
GeckoResultAn interface used to map
GeckoResultexceptions.An interface used to deliver values to listeners of a
GeckoResultAn interface used to map
GeckoResultvalues.This is used to allow GeckoRuntime to start activities via the embedding application (and
Activity).Settings builder used to construct the settings object.Element details for onContextMenu callbacks.Represent the result of a find-in-page operation.An interface for recording new history visits and fetching the visited status for links.A representation of an entry in browser history.A representation of browser history, accessible as a `List`.Main entry point for loading URIs into a
Image.getBitmap(int)The MediaSession API provides media controls and events for a GeckoSession.Implement this delegate to receive media session events.The representation of a media element's metadata.Flags for supported media session features.The representation of a media session's metadata.Holds the details of the media session's playback state.This delegate will be called whenever an orientation lock is called.Represents how a
MotionEventwas handled in Gecko.ProfilerController is used to manage GeckoProfiler related features.Base class for (nested) runtime settings.Base class for (nested) runtime settings builders.The telemetry API gives access to telemetry data of the Gecko runtime.The runtime telemetry delegate.The Histogram telemetry metric object.The runtime telemetry metric object.ScreenLength is a class that represents a length on the screen using different units.
SessionFinderinstances returned by
GeckoSession.getFinder()performs find-in-page operations.
SessionTextInputhandles text input for
GeckoSessionthrough key events or input methods.Used by a ContentDelegate to indicate what action to take on a slow script event.Manage runtime storage data.Flags used for data clearing operations.Represents a WebExtension that may be used by GeckoView.Represents either a Browser Action or a Page Action from the WebExtension API.Receives updates whenever a Browser action or a Page action has been defined by an extension.Describes the blocklist state for a
WebExtension.This delegate is used to handle calls from the |browsingData| WebExtension API.This class represents the current default settings for the "Clear Data" functionality in the browser.Types of data that a browser "Clear Data" UI might have access to.Provides details about creating a tab with
tabs.create.Represents a possible reason why a download was interrupted.Represents a download in progress where the app is currently receiving data from the server.Interface for communicating the state of downloads to Web Extensions.Represents initial information on a download provided to Web ExtensionRepresents Web Extension API specific download requestExtension thrown when an error occurs during extension installation.Delegates that responds to messages sent from a WebExtension.Describes the sender of a message from a WebExtension.Port object that can be used for bidirectional communication with a WebExtension.Delegate that handles communication from a WebExtension on a specific
WebExtension.Portinstance.This delegate is invoked whenever an extension uses the `tabs` WebExtension API to modify the state of a tab.Describes the signed status for a
WebExtension.This delegate is invoked whenever an extension uses the `tabs` WebExtension API and the request is not specific to an existing tab, e.g.Provides details about upating a tab with
tabs.update.Contains the possible values for the
WebExtensionController.disable(org.mozilla.geckoview.WebExtension, int).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.requestThis is an abstract base class for HTTP request and response types.This is a Builder used by subclasses of
WebMessage.This class represents a single Web Notification.This class represents a single Web Push subscription, as described in the Web Push API specification.WebRequest represents an HTTP[S] request.Builder offers a convenient way for constructing
WebRequestinstances.WebRequestError is simply a container for error codes and categories used by
GeckoSession.NavigationDelegate.onLoadError(GeckoSession, String, WebRequestError).WebResponse represents an HTTP[S] response.Builder offers a convenient way to create WebResponse instances.