fune/mobile/android/android-components/components/browser/engine-gecko
2024-02-22 16:31:21 -07:00
..
docs Bug 1825116 - Resolve many black, isort, and file-whitespace lint issues 2023-04-12 14:04:29 +00:00
src Bug 1875761 - disable release channel test in browser-engine-gecko component. r=geckoview-reviewers,gl 2024-01-24 10:47:35 +01:00
build.gradle Bug 1879660 - Relax geckoview version pinning on try builds. r=bhearsum,releng-reviewers 2024-02-22 16:31:21 -07:00
geckoview.fml.yaml Bug 1825116 - remove executable bit from yaml file. r=geckoview-reviewers,gl 2024-01-22 17:28:44 +01:00
metrics.yaml [components] Bug 1689162: Upgrade to new version of Glean metrics.yaml schema (https://github.com/mozilla-mobile/android-components/pull/9990) 2021-03-29 14:27:14 +00:00
proguard-rules.pro
README.md [components] Issue https://github.com/mozilla-mobile/android-components/issues/10070: Only keep one GeckoView component (tracking Nightly) 2021-04-20 18:51:39 +00:00

Android Components > Browser > Engine-Gecko

Engine implementation based on GeckoView.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:browser-engine-gecko:{latest-version}"

Integration with the Glean SDK

Before using this component

Products sending telemetry and using this component must request a data-review following this process.

The Glean SDK can be used to collect Gecko Telemetry. Applications using both this component and the Glean SDK should setup the Gecko Telemetry delegate as shown below:

    val builder = GeckoRuntimeSettings.Builder()
    val runtimeSettings = builder
        .telemetryDelegate(GeckoGleanAdapter()) // Sets up the delegate!
        .build()
    // Create the Gecko runtime.
    GeckoRuntime.create(context, runtimeSettings)

Adding new metrics

New Gecko metrics can be added as described in the Firefox Telemetry docs.

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/