| AllowOrDeny.java |
This represents a decision to allow or deny a request. |
559 |
| Autocomplete.java |
The Autocomplete API provides a way to leverage Gecko's input form handling for autocompletion.
<p>The API is split into two parts: 1. Storage-level delegates. 2. User-prompt delegates.
<p>The storage-level delegates connect Gecko mechanics to the app's storage, e.g., retrieving and
storing of login entries.
<p>The user-prompt delegates propagate decisions to the app that could require user choice, e.g.,
saving or updating of login entries or the selection of a login entry out of multiple options.
<p>Throughout the documentation, we will refer to the filling out of input forms using two terms:
1. Autofill: automatic filling without user interaction. 2. Autocomplete: semi-automatic filling
that requires user prompting for the selection.
<h2>Examples</h2>
<h3>Autocomplete/Fetch API</h3>
<p>GeckoView loads <code>https://example.com</code> which contains (for the purpose of this
example) elements resembling a login form, e.g.,
<pre><code>
<form>
<input type="text" placeholder="username">
<input type="password" placeholder="password">
<input type="submit" value="submit">
</form>
</code></pre>
<p>With the document parsed and the login input fields identified, GeckoView dispatches a <code>
StorageDelegate.onLoginFetch("example.com")</code> request to fetch logins for the
given domain.
<p>Based on the provided login entries, GeckoView will attempt to autofill the login input
fields, if there is only one suitable login entry option.
<p>In the case of multiple valid login entry options, GeckoView dispatches a <code>
GeckoSession.PromptDelegate.onLoginSelect</code> request, which allows for user-choice
delegation.
<p>Based on the returned login entries, GeckoView will attempt to autofill/autocomplete the login
input fields.
<h3>Update API</h3>
<p>When the user submits some login input fields, GeckoView dispatches another <code>
StorageDelegate.onLoginFetch("example.com")</code> request to check whether the
submitted login exists or whether it's a new or updated login entry.
<p>If the submitted login is already contained as-is in the collection returned by <code>
onLoginFetch</code>, then GeckoView dispatches <code>StorageDelegate.onLoginUsed</code> with the
submitted login entry.
<p>If the submitted login is a new or updated entry, GeckoView dispatches a sequence of requests
to save/update the login entry, see the Save API example.
<h3>Save API</h3>
<p>The user enters new or updated (password) login credentials in some login input fields and
submits explicitely (submit action) or by navigation. GeckoView identifies the entered
credentials and dispatches a <code>GeckoSession.PromptDelegate.onLoginSave(session, request)
</code> with the provided credentials.
<p>The app may dismiss the prompt request via <code>
return GeckoResult.fromValue(prompt.dismiss())</code> which terminates this saving request, or
confirm it via <code>return GeckoResult.fromValue(prompt.confirm(login))</code> where <code>login
</code> either holds the credentials originally provided by the prompt request (<code>
prompt.logins[0]</code>) or a new or modified login entry.
<p>The login entry returned in a confirmed save prompt is used to request for saving in the
runtime delegate via <code>StorageDelegate.onLoginSave(login)</code>. If the app has already
stored the entry during the prompt request handling, it may ignore this storage saving request.
<br>
@see GeckoRuntime#setAutocompleteStorageDelegate <br>
@see GeckoSession#setPromptDelegate <br>
@see GeckoSession.PromptDelegate#onLoginSave <br>
@see GeckoSession.PromptDelegate#onLoginSelect
|
52969 |
| Autofill.java |
Autofill functionality for forms and input fields. |
41640 |
| Base64Utils.java |
This class exposes the Base64 URL encode/decode functions from Gecko. They are different from
android.util.Base64 in that they always use URL encoding, no padding, and are constant time. The
last bit is important when dealing with values that might be secret as we do with Web Push.
|
766 |
| BasicSelectionActionDelegate.java |
Class that implements a basic SelectionActionDelegate. This class is used by GeckoView by default
if the consumer does not explicitly set a SelectionActionDelegate.
<p>To provide custom actions, extend this class and override the following methods,
<p>1) Override {@link #getAllActions} to include custom action IDs in the returned array. This
array must include all actions, available or not, and must not change over the class lifetime.
<p>2) Override {@link #isActionAvailable} to return whether a custom action is currently
available.
<p>3) Override {@link #prepareAction} to set custom title and/or icon for a custom action.
<p>4) Override {@link #performAction} to perform a custom action when used.
|
22972 |
| CallbackResult.java |
package |
560 |
| CompositorController.java |
Controller for managing compositor-related functionality. |
3914 |
| ContentBlocking.java |
Content Blocking API to hold and control anti-tracking, cookie and Safe Browsing settings. |
84566 |
| ContentBlockingController.java |
ContentBlockingController is used to manage and modify the content blocking exception list. This
list is shared across all sessions.
|
9268 |
| ContentInputStream.java |
This class provides an {@link OutputStream} wrapper for a Gecko nsIOutputStream (or really,
nsIRequest).
|
5847 |
| CrashHandler.java |
Handler for processing application crashes and sending crash reports. |
18700 |
| CrashPullController.java |
The CrashPullController offers a way to get notified of JS level Crash Pull events, that may be
triggered by incoming Remote Settings requests offering developpers a way to collect specific
crash reports that may be required for investigation on specific bugs.
<p>Upon the event triggered by the JS level code in GeckoViewStartup and assuming a
CrashPullController.Delegate was registered, then its onCrashPull gets called to perform the rest
of the handling, i.e., notifying the user to ask for those crash submission.
|
3640 |
| CrashReporter.java |
Sends a crash report to the Mozilla <a href="https://wiki.mozilla.org/Socorro">Socorro</a> crash
report server.
|
15802 |
| DeprecationSchedule.java |
Additional metadata about a deprecation notice. |
1331 |
| doc-files |
|
|
| ExperimentalGeckoViewApi.java |
GeckoView APIs annotated with {@link ExperimentalGeckoViewApi} are subject to change or else
inherently more dangerous or unstable.
<p>This annotation covers:
<ul>
<li>API signatures that may change without notice or deprecation period.
<li>API behavior and interactions that may change without notice.
<li>Features that are under heavy development and are considered unstable.
<li>Features that have inherent risk or potentially destabilize other parts of GeckoView.
</ul>
<p>Only use an API annotated with this if you fully understand the API and accept the risks.
|
1581 |
| ExperimentDelegate.java |
This delegate is used to pass experiment information between the embedding application and
GeckoView.
<p>An experiment is used to give users different application behavior in order to learn and
improve upon what features users prefer the most. This is accomplished by providing users
different application experiences and collecting data about how the differing experiences
impacted user behavior.
|
7347 |
| GeckoDisplay.java |
Applications use a GeckoDisplay instance to provide {@link GeckoSession} with a {@link Surface}
for displaying content. To ensure drawing only happens on a valid {@link Surface}, {@link
GeckoSession} will only use the provided {@link Surface} after {@link
#surfaceChanged(SurfaceInfo)} is called and before {@link #surfaceDestroyed()} returns.
|
19909 |
| GeckoEditable.java |
GeckoEditable implements only some functions of Editable The field mText contains the actual
underlying SpannableStringBuilder/Editable that contains our text.
|
98876 |
| GeckoFontScaleListener.java |
A class that automatically adjusts font size settings for web content in Gecko in accordance with
the device's OS font scale setting.
@see android.provider.Settings.System#FONT_SCALE
|
5109 |
| GeckoInputConnection.java |
package |
31941 |
| GeckoInputStream.java |
This class provides an {@link InputStream} wrapper for a Gecko nsIChannel (or really,
nsIRequest).
|
5873 |
| GeckoPreferenceController.java |
Class is used to access and manipulate Gecko preferences through GeckoView.
<p>This API is experimental because manipulating Gecko preferences is risky and can interfere
with browser operation without special care.
|
28450 |
| GeckoResult.java |
|
38576 |
| GeckoRuntime.java |
Runtime environment for Gecko-based applications. |
44892 |
| GeckoRuntimeSettings.java |
Settings for configuring the Gecko runtime environment. |
88129 |
| GeckoSession.java |
A session for interacting with web content in Gecko.
<p>GeckoSession represents a single tab or browser window and provides APIs for loading content,
handling navigation, managing permissions, and interacting with web content through various
delegate interfaces.
|
304896 |
| GeckoSessionHandler.java |
package |
3086 |
| GeckoSessionSettings.java |
Configuration settings for a GeckoSession. |
24001 |
| GeckoView.java |
A view container that hosts Gecko rendering, manages its surface, and dispatches input/events.
|
45710 |
| GeckoViewInputStream.java |
This class provides a Gecko nsIInputStream wrapper for a Java {@link InputStream}. |
4174 |
| GeckoViewPrintDocumentAdapter.java |
Print document adapter for GeckoView content. |
8508 |
| GeckoVRManager.java |
Interface for registering the external VR context with WebVR. The context must be registered
before Gecko is started. This API is not intended for external consumption. To see an example of
how it is used please see the <a href="https://github.com/MozillaReality/FirefoxReality"
target="_blank">Firefox Reality browser</a>.
@see <a href="https://searchfox.org/mozilla-central/source/gfx/vr/external_api/moz_external_vr.h"
target="_blank">External VR Context</a>
|
1561 |
| GeckoWebExecutor.java |
GeckoWebExecutor is responsible for fetching a {@link WebRequest} and delivering a {@link
WebResponse} to the caller via {@link #fetch(WebRequest)}. Example:
<pre>
final GeckoWebExecutor executor = new GeckoWebExecutor();
final GeckoResult<WebResponse> result = executor.fetch(
new WebRequest.Builder("https://example.org/json")
.header("Accept", "application/json")
.build());
result.then(response -> {
// Do something with response
});
</pre>
|
7145 |
| Image.java |
Represents an Web API image resource as used in web app manifests and media session metadata. |
1943 |
| MediaSession.java |
The MediaSession API provides media controls and events for a GeckoSession. This includes support
for the DOM Media Session API and regular HTML media content.
@see <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaSession">Media Session
API</a>
|
22352 |
| OrientationController.java |
Controller for managing device orientation changes. |
1880 |
| OverscrollEdgeEffect.java |
Edge effect implementation for overscroll behavior. |
7091 |
| package-info.java |
This package contains the public interfaces for the library.
<ul>
<li>{@link org.mozilla.geckoview.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.
<li>{@link org.mozilla.geckoview.GeckoSession} is where most interesting work happens, such as
loading pages. It relies on {@link org.mozilla.geckoview.GeckoRuntime} to talk to Gecko.
<li>{@link org.mozilla.geckoview.GeckoView} is the embeddable {@link android.view.View}. This
is the most common way of getting a {@link org.mozilla.geckoview.GeckoSession} onto the
screen.
</ul>
<p><strong>Permissions</strong>
<p>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 {@link
android.Manifest.permission#CAMERA} and {@link android.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:
<ul>
<li>{@link android.Manifest.permission#ACCESS_COARSE_LOCATION}
<li>{@link android.Manifest.permission#ACCESS_FINE_LOCATION}
<li>{@link android.Manifest.permission#READ_EXTERNAL_STORAGE}
<li>{@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE}
<li>{@link android.Manifest.permission#CAMERA}
<li>{@link android.Manifest.permission#RECORD_AUDIO}
</ul>
For a detailed change log of the API see: <a href="./doc-files/CHANGELOG"
target="_blank">CHANGELOG</a>.
|
2060 |
| PanZoomController.java |
Manages panning, zooming, and input event handling for a GeckoSession.
<p>This controller processes touch, mouse, and scroll events to update the web content viewport,
supports fling and smooth scrolling behaviors, and reports input handling results.
|
35745 |
| ParcelableUtils.java |
|
617 |
| ProfilerController.java |
ProfilerController is used to manage GeckoProfiler related features.
<p>If you want to add a profiler marker to mark a point in time (without a duration) you can
directly use <code>profilerController.addMarker("marker name")</code>. Or if you want to provide
more information, you can use <code>
profilerController.addMarker("marker name", "extra information")</code> If you want to add a
profiler marker with a duration (with start and end time) you can use it like this: <code>
Double startTime = profilerController.getProfilerTime();
...some code you want to measure...
profilerController.addMarker("name", startTime);
</code> Or you can capture start and end time in somewhere, then add the marker in somewhere
else: <code>
Double startTime = profilerController.getProfilerTime();
...some code you want to measure (or end time can be collected in a callback)...
Double endTime = profilerController.getProfilerTime();
...somewhere else in the codebase...
profilerController.addMarker("name", startTime, endTime);
</code> Here's an <code>addMarker</code> example with all the possible parameters: <code>
Double startTime = profilerController.getProfilerTime();
...some code you want to measure...
Double endTime = profilerController.getProfilerTime();
...somewhere else in the codebase...
profilerController.addMarker("name", startTime, endTime, "extra information");
</code> <code>isProfilerActive</code> method is handy when you want to get more information to
add inside the marker, but you think it's going to be computationally heavy (and useless) when
profiler is not running:
<pre>
<code>
Double startTime = profilerController.getProfilerTime();
...some code you want to measure...
if (profilerController.isProfilerActive()) {
String info = aFunctionYouDoNotWantToCallWhenProfilerIsNotActive();
profilerController.addMarker("name", startTime, info);
}
</code>
</pre>
FIXME(bug 1618560): Currently only works in the main thread.
|
8184 |
| PromptController.java |
package |
30763 |
| RuntimeSettings.java |
Base class for (nested) runtime settings.
<p>Handles pref-based settings. Please extend this class when adding nested settings for
GeckoRuntimeSettings.
|
11364 |
| ScreenLength.java |
ScreenLength is a class that represents a length on the screen using different units. The default
unit is a pixel. However lengths may be also represented by a dimension of the visual viewport or
of the full scroll size of the root document.
|
5563 |
| SessionAccessibility.java |
Accessibility support for GeckoSession. |
32904 |
| SessionFinder.java |
{@code SessionFinder} instances returned by {@link GeckoSession#getFinder()} performs
find-in-page operations.
|
4754 |
| SessionPdfFileSaver.java |
{@code PdfFileSaver} instances returned by {@link GeckoSession#getPdfFileSaver()} performs save
operation.
|
3698 |
| SessionTextInput.java |
{@code SessionTextInput} handles text input for {@code GeckoSession} through key events or input
methods. It is typically used to implement certain methods in {@link android.view.View} such as
{@link android.view.View#onCreateInputConnection}, by forwarding such calls to corresponding
methods in {@code SessionTextInput}.
<p>For full functionality, {@code SessionTextInput} requires a {@link android.view.View} to be
set first through {@link #setView}. When a {@link android.view.View} is not set or set to null,
{@code SessionTextInput} will operate in a reduced functionality mode. See {@link
#onCreateInputConnection} and methods in {@link GeckoSession.TextInputDelegate} for changes in
behavior in this viewless mode.
|
16373 |
| SlowScriptResponse.java |
Used by a ContentDelegate to indicate what action to take on a slow script event.
@see GeckoSession.ContentDelegate#onSlowScript(GeckoSession,String)
|
693 |
| StorageController.java |
Manage runtime storage data.
<p>Retrieve an instance via {@link GeckoRuntime#getStorageController}.
|
16512 |
| TranslationsController.java |
The translations controller coordinates the session and runtime messaging between GeckoView and
the translations toolkit.
|
51191 |
| WebAuthnTokenManager.java |
package |
29523 |
| WebExtension.java |
Represents a WebExtension that may be used by GeckoView. |
113787 |
| WebExtensionController.java |
Controller for managing WebExtensions within a GeckoRuntime instance. Provides functionality for
installing, uninstalling, enabling, disabling, and managing delegates for WebExtensions.
|
72073 |
| WebMessage.java |
This is an abstract base class for HTTP request and response types. |
4206 |
| WebNotification.java |
This class represents a single <a
href="https://developer.mozilla.org/en-US/docs/Web/API/Notification">Web Notification</a>. These
can be received by connecting a {@link WebNotificationDelegate} to {@link GeckoRuntime} via
{@link GeckoRuntime#setWebNotificationDelegate(WebNotificationDelegate)}.
|
10143 |
| WebNotificationAction.java |
This class corresponds to nsIAlertAction in Gecko, which again largely corresponds to each member
of <a href="https://developer.mozilla.org/en-US/docs/Web/API/Notification/actions">
Notification.actions</a>. It's passed to {@link WebNotification} and can be retrieved from it.
|
2137 |
| WebNotificationDelegate.java |
Delegate for handling web notification events. |
1088 |
| WebPushController.java |
Controller for managing web push notifications. |
5301 |
| WebPushDelegate.java |
Delegate for handling web push subscription events. |
2544 |
| WebPushSubscription.java |
This class represents a single Web Push subscription, as described in the <a
href="https://www.w3.org/TR/push-api/">Web Push API</a> specification.
<p>This is a low-level interface, allowing applications to do all of the heavy lifting
themselves. It is recommended that consumers have a thorough understanding of the Web Push API,
especially <a href="https://tools.ietf.org/html/rfc8291">RFC 8291</a>.
<p>Only trivial sanity checks are performed on the values held here. The application must ensure
it is generating compliant keys/secrets itself.
|
6680 |
| WebRequest.java |
WebRequest represents an HTTP[S] request. The typical pattern is to create instances of this
class via {@link WebRequest.Builder}, and fetch responses via {@link
GeckoWebExecutor#fetch(WebRequest)}.
|
7759 |
| WebRequestError.java |
WebRequestError is simply a container for error codes and categories used by {@link
GeckoSession.NavigationDelegate#onLoadError(GeckoSession, String, WebRequestError)}.
|
13301 |
| WebResponse.java |
WebResponse represents an HTTP[S] response. It is normally created by {@link
GeckoWebExecutor#fetch(WebRequest)}.
|
7963 |