Package org.mozilla.geckoview

Class GeckoRuntimeSettings

Object
org.mozilla.geckoview.RuntimeSettings
org.mozilla.geckoview.GeckoRuntimeSettings
All Implemented Interfaces:
Parcelable
@AnyThread public final class GeckoRuntimeSettings extends RuntimeSettings

  • Field Details

    • COLOR_SCHEME_LIGHT

      public static final int COLOR_SCHEME_LIGHT
      A light theme for web content is preferred.
      See Also:

    • COLOR_SCHEME_DARK

      public static final int COLOR_SCHEME_DARK
      A dark theme for web content is preferred.
      See Also:

    • COLOR_SCHEME_SYSTEM

      public static final int COLOR_SCHEME_SYSTEM
      The preferred color scheme will be based on system settings.
      See Also:

    • STRATEGY_ISOLATE_NOTHING

      public static final int STRATEGY_ISOLATE_NOTHING
      All web content is loaded into a shared `web` content process. This is similar to the non-Fission behaviour, however remote subframes may still be used for sites with special isolation behaviour, such as extension or mozillaweb content processes.
      See Also:

    • STRATEGY_ISOLATE_EVERYTHING

      public static final int STRATEGY_ISOLATE_EVERYTHING
      Web content is always isolated into its own `webIsolated` content process based on site-origin, and will only load in a shared `web` content process if site-origin could not be determined.
      See Also:

    • STRATEGY_ISOLATE_HIGH_VALUE

      public static final int STRATEGY_ISOLATE_HIGH_VALUE
      Only isolates web content loaded by sites which are considered "high value". A site is considered "high value" if it has been granted a `highValue*` permission by the permission manager, which is done in response to certain actions.
      See Also:

    • ALLOW_ALL

      public static final int ALLOW_ALL
      Allow all insecure connections
      See Also:

    • HTTPS_ONLY_PRIVATE

      public static final int HTTPS_ONLY_PRIVATE
      Allow insecure connections in normal browsing, but only HTTPS in private browsing.
      See Also:

    • HTTPS_ONLY

      public static final int HTTPS_ONLY
      Only allow HTTPS connections.
      See Also:

    • TRR_MODE_OFF

      public static final int TRR_MODE_OFF
      Off (default). Use native DNS resolution by default.
      See Also:

    • TRR_MODE_FIRST

      public static final int TRR_MODE_FIRST
      First. Use TRR first, and only if the name resolve fails use the native resolver as a fallback.
      See Also:

    • TRR_MODE_ONLY

      public static final int TRR_MODE_ONLY
      Only. Only use TRR, never use the native resolver.
      See Also:

    • TRR_MODE_DISABLED

      public static final int TRR_MODE_DISABLED
      Off by choice. This is the same as 0 but marks it as done by choice and not done by default.
      See Also:

    • CREATOR

      public static final Parcelable.Creator<GeckoRuntimeSettings> CREATOR

  • Method Details

    • getContentBlocking

      @NonNull public ContentBlocking.Settings getContentBlocking()

    • getRuntime

      @Nullable public GeckoRuntime getRuntime()

    • getArguments

      @NonNull public String[] getArguments()
      Get the custom Gecko process arguments.
      Returns:
      The Gecko process arguments.

    • getExtras

      @NonNull public Bundle getExtras()
      Get the custom Gecko intent extras.
      Returns:
      The Gecko intent extras.

    • getConfigFilePath

      @Nullable public String getConfigFilePath()
      Path to configuration file from which GeckoView will read configuration options such as Gecko process arguments, environment variables, and preferences.

      Note: this feature is only available for Build.VERSION.SDK_INT > 21.

      Returns:
      Path to configuration file from which GeckoView will read configuration options, or null for default location /data/local/tmp/$PACKAGE-geckoview-config.yaml .

    • getJavaScriptEnabled

      public boolean getJavaScriptEnabled()
      Get whether JavaScript support is enabled.
      Returns:
      Whether JavaScript support is enabled.

    • setJavaScriptEnabled

      @NonNull public GeckoRuntimeSettings setJavaScriptEnabled(boolean flag)
      Set whether JavaScript support should be enabled.
      Parameters:
      flag - A flag determining whether JavaScript should be enabled.
      Returns:
      This GeckoRuntimeSettings instance.

    • setGlobalPrivacyControl

      @NonNull public GeckoRuntimeSettings setGlobalPrivacyControl(boolean enabled)
      Enable the Global Privacy Control Feature.

      Note: Global Privacy Control is always enabled in private mode.

      Parameters:
      enabled - A flag determining whether GPC should be enabled.
      Returns:
      This GeckoRuntimeSettings instance

    • setFingerprintingProtection

      @NonNull public GeckoRuntimeSettings setFingerprintingProtection(boolean enabled)
      Set the Fingerprint protection in all tabs.
      Parameters:
      enabled - Whether we set the pref to true or false
      Returns:
      This GeckoRuntimeSettings instance

    • setFingerprintingProtectionPrivateBrowsing

      @NonNull public GeckoRuntimeSettings setFingerprintingProtectionPrivateBrowsing(boolean enabled)
      Set the Fingerprint protection in private tabs.
      Parameters:
      enabled - Whether we set the pref to true or false
      Returns:
      This GeckoRuntimeSettings instance

    • setFingerprintingProtectionOverrides

      @NonNull public GeckoRuntimeSettings setFingerprintingProtectionOverrides(@NonNull String overrides)
      Set the Fingerprint protection overrides
      Parameters:
      overrides - The overrides value to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string.
      Returns:
      This GeckoRuntimeSettings instance

    • setFdlibmMathEnabled

      @NonNull public GeckoRuntimeSettings setFdlibmMathEnabled(boolean enabled)
      Set the pref to control whether to use fdlibm for Math.sin, Math.cos, and Math.tan.
      Parameters:
      enabled - Whether we set the pref to true or false
      Returns:
      This GeckoRuntimeSettings instance

    • getFingerprintingProtection

      @Nullable public Boolean getFingerprintingProtection()
      Get whether Fingerprint protection is enabled in all tabs.
      Returns:
      Whether Fingerprint protection is enabled in all tabs.

    • getFingerprintingProtectionPrivateBrowsing

      @Nullable public Boolean getFingerprintingProtectionPrivateBrowsing()
      Get whether Fingerprint protection is enabled private browsing mode.
      Returns:
      Whether Fingerprint protection is enabled private browsing mode.

    • getFingerprintingProtectionOverrides

      @NonNull public String getFingerprintingProtectionOverrides()
      Get Fingerprint protection overrides.
      Returns:
      The string of the fingerprinting protection overrides.

    • getFdlibmMathEnabled

      public boolean getFdlibmMathEnabled()
      Get whether to use fdlibm for Math.sin, Math.cos, and Math.tan.
      Returns:
      Whether the fdlibm is used

    • setBaselineFingerprintingProtection

      @NonNull public GeckoRuntimeSettings setBaselineFingerprintingProtection(boolean enabled)
      Set the Baseline fingerprint protection.
      Parameters:
      enabled - Whether we set the pref to true or false
      Returns:
      This GeckoRuntimeSettings instance

    • setBaselineFingerprintingProtectionOverrides

      @NonNull public GeckoRuntimeSettings setBaselineFingerprintingProtectionOverrides(@NonNull String overrides)
      Set the Baseline fingerprint protection overrides
      Parameters:
      overrides - The overrides value to add or remove fingerprinting protection targets. Please check RFPTargets.inc for all supported targets. The format of the overrides is +Target1,-Target2,+Target3 where + means add and - means remove. The targets are separated by commas. The default value is empty string.
      Returns:
      This GeckoRuntimeSettings instance

    • getBaselineFingerprintingProtection

      @Nullable public Boolean getBaselineFingerprintingProtection()
      Get whether Fingerprint protection is enabled private browsing mode.
      Returns:
      Whether Fingerprint protection is enabled private browsing mode.

    • getBaselineFingerprintingProtectionOverrides

      @Nullable public String getBaselineFingerprintingProtectionOverrides()
      Get Fingerprint protection overrides.
      Returns:
      The string of the fingerprinting protection overrides.

    • setCookieBehaviorOptInPartitioning

      @NonNull public GeckoRuntimeSettings setCookieBehaviorOptInPartitioning(boolean enabled)
      Set the pref to control the cookie behavior opt-in partitioning.
      Parameters:
      enabled - Whether we set the pref to true or false
      Returns:
      This GeckoRuntimeSettings instance

    • setCookieBehaviorOptInPartitioningPBM

      @NonNull public GeckoRuntimeSettings setCookieBehaviorOptInPartitioningPBM(boolean enabled)
      Set the pref to control the cookie behavior opt-in partitioning in private browsing mode.
      Parameters:
      enabled - Whether we set the pref to true or false
      Returns:
      This GeckoRuntimeSettings instance

    • setRemoteSettingCrashPullNeverShowAgain

      @NonNull public GeckoRuntimeSettings setRemoteSettingCrashPullNeverShowAgain(boolean enabled)
      Set the pref to control whether the CrashPullController.Delegate may show the crash pull notification.
      Parameters:
      enabled - Whether we set the pref to true or false
      Returns:
      This GeckoRuntimeSettings instance

    • getCookieBehaviorOptInPartitioning

      public boolean getCookieBehaviorOptInPartitioning()
      Get whether the cookie behavior opt-in partitioning is enabled.
      Returns:
      Whether the cookie behavior opt-in partitioning is enabled.

    • getCookieBehaviorOptInPartitioningPBM

      public boolean getCookieBehaviorOptInPartitioningPBM()
      Get whether the cookie behavior opt-in partitioning in private browsing mode is enabled.
      Returns:
      Whether the cookie behavior opt-in partitioning in private browsing mode is enabled.

    • getExtensionsProcessEnabled

      @Nullable public Boolean getExtensionsProcessEnabled()
      Get whether Extensions Process support is enabled.
      Returns:
      Whether Extensions Process support is enabled.

    • setExtensionsProcessEnabled

      @NonNull public GeckoRuntimeSettings setExtensionsProcessEnabled(boolean flag)
      Set whether Extensions Process support should be enabled.
      Parameters:
      flag - A flag determining whether Extensions Process support should be enabled.
      Returns:
      This GeckoRuntimeSettings instance.

    • getExtensionsProcessCrashThreshold

      @Nullable public Integer getExtensionsProcessCrashThreshold()
      Get the crash threshold before spawning is disabled for the remote extensions process.
      Returns:
      the crash threshold

    • getExtensionsProcessCrashTimeframe

      @Nullable public Long getExtensionsProcessCrashTimeframe()
      Get the timeframe in milliseconds for the threshold before spawning is disabled for the remote extensions process.
      Returns:
      the timeframe in milliseconds for the crash threshold

    • setExtensionsProcessCrashThreshold

      @NonNull public GeckoRuntimeSettings setExtensionsProcessCrashThreshold(@NonNull Integer crashThreshold)
      Set the crash threshold before disabling spawning of the extensions remote process.
      Parameters:
      crashThreshold - max crashes allowed
      Returns:
      This GeckoRuntimeSettings instance.

    • setExtensionsProcessCrashTimeframe

      @NonNull public GeckoRuntimeSettings setExtensionsProcessCrashTimeframe(@NonNull Long timeframeMs)
      Set the timeframe for the extensions process crash threshold. Any crashes older than the current time minus the timeframe are not included in the crash count.
      Parameters:
      timeframeMs - time in milliseconds
      Returns:
      This GeckoRuntimeSettings instance.

    • setFetchPriorityEnabled

      @NonNull public GeckoRuntimeSettings setFetchPriorityEnabled(boolean enabled)
      Set the pref to control whether network.fetchpriority.enabled is enabled.
      Parameters:
      enabled - Whether to enable the Fetch Priority feature
      Returns:
      This GeckoRuntimeSettings instance

    • getFetchPriorityEnabled

      public boolean getFetchPriorityEnabled()
      Get whether network.fetchpriority.enabled is enabled.
      Returns:
      Whether Fetch Priority is enabled

    • setCertificateTransparencyMode

      @NonNull public GeckoRuntimeSettings setCertificateTransparencyMode(int mode)
      Set the pref to control security.pki.certificate_transparency.mode.
      Parameters:
      mode - What to set the certificate transparency mode to. 0 disables certificate transparency entirely. 1 enables certificate transparency, but only collects telemetry. 2 enforces certificate transparency.
      Returns:
      This GeckoRuntimeSettings instance

    • getCertificateTransparencyMode

      @NonNull public int getCertificateTransparencyMode()
      Get the value of security.pki.certificate_transparency.mode.
      Returns:
      What certificate transparency mode has been set.

    • setParallelMarkingEnabled

      @NonNull public GeckoRuntimeSettings setParallelMarkingEnabled(boolean enabled)
      Set the pref to control whether javascript.options.mem.gc_parallel_marking is enabled.
      Parameters:
      enabled - Whether to enable the JS GC Parallel Marking feature. This feature is purely a performance feature and should have no noticeable behavior change for the user.
      Returns:
      This GeckoRuntimeSettings instance

    • getParallelMarkingEnabled

      public boolean getParallelMarkingEnabled()
      Get whether javascript.options.mem.gc_parallel_marking is enabled.
      Returns:
      Whether Parallel Marking is enabled

    • getRemoteDebuggingEnabled

      public boolean getRemoteDebuggingEnabled()
      Get whether remote debugging support is enabled.
      Returns:
      True if remote debugging support is enabled.

    • setRemoteDebuggingEnabled

      @NonNull public GeckoRuntimeSettings setRemoteDebuggingEnabled(boolean enabled)
      Set whether remote debugging support should be enabled.
      Parameters:
      enabled - True if remote debugging should be enabled.
      Returns:
      This GeckoRuntimeSettings instance.

    • getWebFontsEnabled

      public boolean getWebFontsEnabled()
      Get whether web fonts support is enabled.
      Returns:
      Whether web fonts support is enabled.

    • setWebFontsEnabled

      @NonNull public GeckoRuntimeSettings setWebFontsEnabled(boolean flag)
      Set whether support for web fonts should be enabled.
      Parameters:
      flag - A flag determining whether web fonts should be enabled.
      Returns:
      This GeckoRuntimeSettings instance.

    • getPauseForDebuggerEnabled

      public boolean getPauseForDebuggerEnabled()
      Gets whether the pause-for-debugger is enabled or not.
      Returns:
      True if the pause is enabled.

    • getForceEnableAccessibility

      public boolean getForceEnableAccessibility()
      Gets whether accessibility is force enabled or not.
      Returns:
      true if accessibility is force enabled.

    • setForceEnableAccessibility

      @NonNull public GeckoRuntimeSettings setForceEnableAccessibility(boolean value)
      Sets whether accessibility is force enabled or not.

      Useful when testing accessibility.

      Parameters:
      value - whether accessibility is force enabled or not
      Returns:
      this GeckoRuntimeSettings instance.

    • getUseMaxScreenDepth

      public boolean getUseMaxScreenDepth()
      Gets whether the compositor should use the maximum screen depth when rendering.
      Returns:
      True if the maximum screen depth should be used.

    • getLowMemoryDetection

      public boolean getLowMemoryDetection()
      Gets whether the runtime should detect low-memory conditions.
      Returns:
      True if low-memory detection should be enabled.

    • getDisplayDensityOverride

      @Nullable public Float getDisplayDensityOverride()
      Gets the display density override value.
      Returns:
      Returns a positive number. Will return null if not set.

    • getDisplayDpiOverride

      @Nullable public Integer getDisplayDpiOverride()
      Gets the display DPI override value.
      Returns:
      Returns a positive number. Will return null if not set.

    • getCrashHandler

      @Nullable public Class<? extends Service> getCrashHandler()

    • getScreenSizeOverride

      @Nullable public Rect getScreenSizeOverride()
      Gets the screen size override value.
      Returns:
      Returns a Rect containing the dimensions to use for the window size. Will return null if not set.

    • getLocales

      @Nullable public String[] getLocales()
      Gets the list of requested locales.
      Returns:
      A list of locale codes in Gecko format ("en" or "en-US").

    • setLocales

      public void setLocales(@Nullable String[] requestedLocales)
      Set the locale.
      Parameters:
      requestedLocales - An ordered list of locales in Gecko format ("en-US").

    • getExtensionsWebAPIEnabled

      public boolean getExtensionsWebAPIEnabled()
      Gets whether the Add-on Manager web API (`mozAddonManager`) is enabled.
      Returns:
      True when the web API is enabled, false otherwise.

    • getGlobalPrivacyControl

      public boolean getGlobalPrivacyControl()
      Get whether or not Global Privacy Control is currently enabled for normal tabs.
      Returns:
      True if GPC is enabled in normal tabs.

    • getGlobalPrivacyControlPrivateMode

      public boolean getGlobalPrivacyControlPrivateMode()
      Get whether or not Global Privacy Control is currently enabled for private tabs.
      Returns:
      True if GPC is enabled in private tabs.

    • setExtensionsWebAPIEnabled

      @NonNull public GeckoRuntimeSettings setExtensionsWebAPIEnabled(boolean flag)
      Sets whether the Add-on Manager web API (`mozAddonManager`) is enabled.
      Parameters:
      flag - True if the web API should be enabled, false otherwise.
      Returns:
      This GeckoRuntimeSettings instance.

    • setWebManifestEnabled

      @NonNull public GeckoRuntimeSettings setWebManifestEnabled(boolean enabled)
      Sets whether Web Manifest processing support is enabled.
      Parameters:
      enabled - A flag determining whether Web Manifest processing support is enabled.
      Returns:
      This GeckoRuntimeSettings instance.

    • getWebManifestEnabled

      public boolean getWebManifestEnabled()
      Get whether or not Web Manifest processing support is enabled.
      Returns:
      True if web manifest processing support is enabled.

    • setConsoleOutputEnabled

      @NonNull public GeckoRuntimeSettings setConsoleOutputEnabled(boolean enabled)
      Set whether or not web console messages should go to logcat.

      Note: If enabled, Gecko performance may be negatively impacted if content makes heavy use of the console API.

      Parameters:
      enabled - A flag determining whether or not web console messages should be printed to logcat.
      Returns:
      This GeckoRuntimeSettings instance.

    • getConsoleOutputEnabled

      public boolean getConsoleOutputEnabled()
      Get whether or not web console messages are sent to logcat.
      Returns:
      True if console output is enabled.

    • setAutomaticFontSizeAdjustment

      @NonNull public GeckoRuntimeSettings setAutomaticFontSizeAdjustment(boolean enabled)
      Set whether or not font sizes in web content should be automatically scaled according to the device's current system font scale setting. Enabling this will prevent modification of the font size factor. Disabling this setting will restore the previously used value for the font size factor.
      Parameters:
      enabled - A flag determining whether or not font sizes should be scaled automatically to match the device's system font scale.
      Returns:
      This GeckoRuntimeSettings instance.

    • getAutomaticFontSizeAdjustment

      public boolean getAutomaticFontSizeAdjustment()
      Get whether or not the font sizes for web content are automatically adjusted to match the device's system font scale setting.
      Returns:
      True if font sizes are automatically adjusted.

    • setFontSizeFactor

      @NonNull public GeckoRuntimeSettings setFontSizeFactor(float fontSizeFactor)
      Set a font size factor that will operate as a global text zoom. All font sizes will be multiplied by this factor.

      The default factor is 1.0.

      Currently, any changes only take effect after a reload of the session.

      This setting cannot be modified while automatic font size adjustment is enabled.

      Parameters:
      fontSizeFactor - The factor to be used for scaling all text. Setting a value of 0 disables both this feature and font inflation.
      Returns:
      This GeckoRuntimeSettings instance.

    • setEnterpriseRootsEnabled

      @NonNull public GeckoRuntimeSettings setEnterpriseRootsEnabled(boolean enabled)
      Enable the Enteprise Roots feature.

      When Enabled, GeckoView will fetch the third-party root certificates added to the Android OS CA store and will use them internally.

      Parameters:
      enabled - Whether to enable this feature or not.
      Returns:
      This GeckoRuntimeSettings instance.

    • getEnterpriseRootsEnabled

      public boolean getEnterpriseRootsEnabled()
      Gets whether the Enteprise Roots feature is enabled or not.
      Returns:
      true if the feature is enabled, false otherwise.

    • getFontSizeFactor

      public float getFontSizeFactor()
      Gets the currently applied font size factor.
      Returns:
      The currently applied font size factor.

    • setFontInflationEnabled

      @NonNull public GeckoRuntimeSettings setFontInflationEnabled(boolean enabled)
      Set whether or not font inflation for non mobile-friendly pages should be enabled. The default value of this setting is false.

      When enabled, font sizes will be increased on all pages that are lacking a <meta> viewport tag and have been loaded in a session using GeckoSessionSettings.VIEWPORT_MODE_MOBILE. To improve readability, the font inflation logic will attempt to increase font sizes for the main text content of the page only.

      The magnitude of font inflation applied depends on the font size factor currently in use.

      Currently, any changes only take effect after a reload of the session.

      Parameters:
      enabled - A flag determining whether or not font inflation should be enabled.
      Returns:
      This GeckoRuntimeSettings instance.

    • getFontInflationEnabled

      public boolean getFontInflationEnabled()
      Get whether or not font inflation for non mobile-friendly pages is currently enabled.
      Returns:
      True if font inflation is enabled.

    • getPreferredColorScheme

      public int getPreferredColorScheme()
      Gets the preferred color scheme override for web content.
      Returns:
      One of the COLOR_SCHEME_* constants.

    • setPreferredColorScheme

      @NonNull public GeckoRuntimeSettings setPreferredColorScheme(int scheme)
      Sets the preferred color scheme override for web content.
      Parameters:
      scheme - The preferred color scheme. Must be one of the COLOR_SCHEME_* constants.
      Returns:
      This GeckoRuntimeSettings instance.

    • getInputAutoZoomEnabled

      public boolean getInputAutoZoomEnabled()
      Gets whether auto-zoom to editable fields is enabled.
      Returns:
      True if auto-zoom is enabled, false otherwise.

    • setInputAutoZoomEnabled

      @NonNull public GeckoRuntimeSettings setInputAutoZoomEnabled(boolean flag)
      Set whether auto-zoom to editable fields should be enabled.
      Parameters:
      flag - True if auto-zoom should be enabled, false otherwise.
      Returns:
      This GeckoRuntimeSettings instance.

    • setDohAutoselectEnabled

      @NonNull public GeckoRuntimeSettings setDohAutoselectEnabled(boolean enabled)
      Set the pref to control whether network.android_doh.autoselect_enabled is enabled. When the pref is enabled the browser will automatically select a DoH provider from a region specific list provided by remote-settings if the browser is using the 'Default protection' mode for DNS over HTTPS. This means `network.trr.mode` was previously set to 0 by calling `setTrustedRecursiveResolverMode(TRR_MODE_OFF)`

      When automatic selection is enabled the browser will run heuristic checks to determine whether DoH can be enabled for the current network (checks for parental controls, split horizon DNS, canary domain, etc) and if these pass it will set the `doh-rollout.mode` pref to 2 (TRR_MODE_FIRST) and `doh-rollout.uri` to the URL of the automatically selected provider.

      Parameters:
      enabled - Whether to enable the DoHController component
      Returns:
      This GeckoRuntimeSettings instance

    • getDohAutoselectEnabled

      public boolean getDohAutoselectEnabled()
      Get whether network.trr.android_rollout_enabled is enabled.
      Returns:
      Whether the DoHController component will be initialized

    • getDoubleTapZoomingEnabled

      public boolean getDoubleTapZoomingEnabled()
      Gets whether double-tap zooming is enabled.
      Returns:
      True if double-tap zooming is enabled, false otherwise.

    • setDoubleTapZoomingEnabled

      @NonNull public GeckoRuntimeSettings setDoubleTapZoomingEnabled(boolean flag)
      Sets whether double tap zooming is enabled.
      Parameters:
      flag - true if double tap zooming should be enabled, false otherwise.
      Returns:
      This GeckoRuntimeSettings instance.

    • getGlMsaaLevel

      public int getGlMsaaLevel()
      Gets the current WebGL MSAA level.
      Returns:
      number of MSAA samples, 0 if MSAA is disabled.

    • setGlMsaaLevel

      @NonNull public GeckoRuntimeSettings setGlMsaaLevel(int level)
      Sets the WebGL MSAA level.
      Parameters:
      level - number of MSAA samples, 0 if MSAA should be disabled.
      Returns:
      This GeckoRuntimeSettings instance.

    • getExperimentDelegate

      @AnyThread @Nullable public ExperimentDelegate getExperimentDelegate()
      Get the ExperimentDelegate instance set on this runtime, if any,
      Returns:
      The ExperimentDelegate set on this runtime.

    • getAboutConfigEnabled

      public boolean getAboutConfigEnabled()
      Gets whether about:config is enabled or not.
      Returns:
      True if about:config is enabled, false otherwise.

    • setAboutConfigEnabled

      @NonNull public GeckoRuntimeSettings setAboutConfigEnabled(boolean flag)
      Sets whether or not about:config should be enabled. This is a page that allows users to directly modify Gecko preferences. Modification of some preferences may cause the app to break in unpredictable ways -- crashes, performance issues, security vulnerabilities, etc.
      Parameters:
      flag - True if about:config should be enabled, false otherwise.
      Returns:
      This GeckoRuntimeSettings instance.

    • getWebContentIsolationStrategy

      @Nullable public Integer getWebContentIsolationStrategy()
      Get the strategy used to control how sites are isolated into separate processes when Fission is enabled. This pref has no effect if Fission is disabled.

      Setting should conform to GeckoRuntimeSettings.WebContentIsolationStrategy, but is not automatically mapped.

      Returns:
      The web content isolation strategy.

    • setWebContentIsolationStrategy

      @NonNull public GeckoRuntimeSettings setWebContentIsolationStrategy(@NonNull Integer strategy)
      Set the strategy used to control how sites are isolated into separate processes when Fission is enabled. This pref has no effect if Fission is disabled.

      Setting must conform to GeckoRuntimeSettings.WebContentIsolationStrategy options.

      Parameters:
      strategy - The specified strategy defined by GeckoRuntimeSettings.WebContentIsolationStrategy.
      Returns:
      This GeckoRuntimeSettings instance.

    • getForceUserScalableEnabled

      public boolean getForceUserScalableEnabled()
      Gets whether or not force user scalable zooming should be enabled or not.
      Returns:
      True if force user scalable zooming should be enabled, false otherwise.

    • setForceUserScalableEnabled

      @NonNull public GeckoRuntimeSettings setForceUserScalableEnabled(boolean flag)
      Sets whether or not pinch-zooming should be enabled when user-scalable=no is set on the viewport.
      Parameters:
      flag - True if force user scalable zooming should be enabled, false otherwise.
      Returns:
      This GeckoRuntimeSettings instance.

    • getLoginAutofillEnabled

      public boolean getLoginAutofillEnabled()
      Get whether login form autofill is enabled.
      Returns:
      True if login autofill is enabled.

    • getFissionEnabled

      @Nullable public Boolean getFissionEnabled()
      Gets whether fission is enabled or not. Note: There is no setter after startup. See GeckoRuntimeSettings.Builder.fissionEnabled(boolean) for setting.
      Returns:
      True if fission is enabled or false otherwise.

    • setTranslationsOfferPopup

      @NonNull public GeckoRuntimeSettings setTranslationsOfferPopup(boolean enabled)
      Set whether automatic popups should appear for offering translations on candidate pages.
      Parameters:
      enabled - A flag determining whether automatic offer popups should be enabled for translations.
      Returns:
      The builder instance.

    • getTranslationsOfferPopup

      public boolean getTranslationsOfferPopup()
      Get whether automatic popups for translations is enabled.
      Returns:
      True if login automatic popups for translations are enabled.

    • setLoginAutofillEnabled

      @NonNull public GeckoRuntimeSettings setLoginAutofillEnabled(boolean enabled)
      Set whether login forms should be filled automatically if only one viable candidate is provided via onLoginFetch.
      Parameters:
      enabled - A flag determining whether login autofill should be enabled.
      Returns:
      The builder instance.

    • getAllowInsecureConnections

      public int getAllowInsecureConnections()
      Get whether and where insecure (non-HTTPS) connections are allowed.
      Returns:
      One of the HttpsOnlyMode constants.

    • setAllowInsecureConnections

      @NonNull public GeckoRuntimeSettings setAllowInsecureConnections(int level)
      Set whether and where insecure (non-HTTPS) connections are allowed.
      Parameters:
      level - One of the HttpsOnlyMode constants.
      Returns:
      This GeckoRuntimeSettings instance.

    • getTrustedRecusiveResolverMode

      public int getTrustedRecusiveResolverMode()
      Get whether and how DNS-over-HTTPS (Trusted Recursive Resolver) is configured.
      Returns:
      One of the TrustedRecursiveResolverMode constants.

    • getLargeKeepaliveFactor

      @NonNull public int getLargeKeepaliveFactor()
      Get the factor by which to increase the keepalive timeout when the NS_HTTP_LARGE_KEEPALIVE flag is used for a connection.
      Returns:
      An integer factor.

    • setTrustedRecursiveResolverMode

      @NonNull public GeckoRuntimeSettings setTrustedRecursiveResolverMode(int mode)
      Set whether and how DNS-over-HTTPS (Trusted Recursive Resolver) is configured.
      Parameters:
      mode - One of the TrustedRecursiveResolverMode constants.
      Returns:
      This GeckoRuntimeSettings instance.

    • setLargeKeepaliveFactor

      @NonNull public GeckoRuntimeSettings setLargeKeepaliveFactor(int factor)
      Set the factor by which to increase the keepalive timeout when the NS_HTTP_LARGE_KEEPALIVE flag is used for a connection.
      Parameters:
      factor - FACTOR by which to increase the keepalive timeout.
      Returns:
      This GeckoRuntimeSettings instance.

    • getTrustedRecursiveResolverUri

      @NonNull public String getTrustedRecursiveResolverUri()
      Get the DNS-over-HTTPS (DoH) server URI.
      Returns:
      URI of the DoH server.

    • setTrustedRecursiveResolverUri

      @NonNull public GeckoRuntimeSettings setTrustedRecursiveResolverUri(@NonNull String uri)
      Set the DNS-over-HTTPS server URI.
      Parameters:
      uri - URI of the DNS-over-HTTPS server.
      Returns:
      This GeckoRuntimeSettings instance.

    • getDefaultRecursiveResolverUri

      @Nullable public String getDefaultRecursiveResolverUri()
      Get the default DNS-over-HTTPS (DoH) server URI.
      Returns:
      default URI of the DoH server.

    • setDefaultRecursiveResolverUri

      @NonNull public GeckoRuntimeSettings setDefaultRecursiveResolverUri(@NonNull String uri)
      Set the default DNS-over-HTTPS server URI.
      Parameters:
      uri - default URI of the DNS-over-HTTPS server.
      Returns:
      This GeckoRuntimeSettings instance.

    • getTrustedRecursiveResolverExcludedDomains

      @NonNull public List<String> getTrustedRecursiveResolverExcludedDomains()
      Get the domains excluded from using DNS-over-HTTPS
      Returns:
      A list of strings containing the domains saved in the pref.

    • setTrustedRecursiveResolverExcludedDomains

      @NonNull public GeckoRuntimeSettings setTrustedRecursiveResolverExcludedDomains(@NonNull List<String> domains)
      Set the DNS-over-HTTPS excluded domains
      Parameters:
      domains - list of domains that will be excluded from using DoH. They will use platform DNS instead.
      Returns:
      This GeckoRuntimeSettings instance.

    • getUserCharacteristicPingCurrentVersion

      @NonNull public int getUserCharacteristicPingCurrentVersion()
      Get the current user characteristic ping version.
      Returns:
      The current version.

    • setUserCharacteristicPingCurrentVersion

      @NonNull public GeckoRuntimeSettings setUserCharacteristicPingCurrentVersion(int version)
      Set the current user characteristic ping version.
      Parameters:
      version - The version number.
      Returns:
      This GeckoRuntimeSettings instance.

    • getDisableShip

      @Nullable public Boolean getDisableShip()
      Retrieve the status of the disable session history in parent (SHIP) preference. May be null if the value hasn't been specifically initialized.

      Note, there is no conventional setter because this may only be set before Gecko is initialized.

      Set before initialization using GeckoRuntimeSettings.Builder.disableShip(boolean).

      Returns:
      True if SHIP is disabled, false if SHIP is enabled.

    • setPostQuantumKeyExchangeEnabled

      @NonNull public GeckoRuntimeSettings setPostQuantumKeyExchangeEnabled(boolean enable)
      Set the preferences that control the use of post-quantum key exchange mechanisms
      Parameters:
      enable - Whether to enable or disable the preferences.
      Returns:
      This GeckoRuntimeSettings instance

    • getPostQuantumKeyExchangeEnabled

      @NonNull public boolean getPostQuantumKeyExchangeEnabled()
      Get whether post-quantum key exchange mechanisms are enabled.
      Returns:
      Whether post-quantum key exchange mechanisms are enabled.

    • setBannedPorts

      @NonNull public GeckoRuntimeSettings setBannedPorts(@NonNull String portList)
      Set the preference that controls which destination ports Firefox should refuse to connect to.
      Parameters:
      portList - Comma separated list of ports
      Returns:
      This GeckoRuntimeSettings instance

    • getBannedPorts

      @NonNull public String getBannedPorts()
      Get the list of banned ports as a comma separated string
      Returns:
      a String containing the list of banned ports

    • setSameDocumentNavigationOverridesLoadType

      @NonNull public GeckoRuntimeSettings setSameDocumentNavigationOverridesLoadType(boolean value)
      Sets whether the same document navigation should override the load type or not.
      Parameters:
      value - A flag determining whether same document navigation should override the load type or not.
      Returns:
      This GeckoRuntimeSettings instance.

    • getSameDocumentNavigationOverridesLoadType

      @NonNull public boolean getSameDocumentNavigationOverridesLoadType()
      Gets whether the same document navigation should override the load type or not.
      Returns:
      Whether the same document navigation should override the load type or not.

    • setSameDocumentNavigationOverridesLoadTypeForceDisable

      @NonNull public GeckoRuntimeSettings setSameDocumentNavigationOverridesLoadTypeForceDisable(@NonNull String uri)
      Sets the uri to force-disable the same document navigation overriding the load type. If it is an empty string (default value), there's no specific domain that the same document navigation overriding the load type is disabled.
      Parameters:
      uri - URI that will be used to force-disable the same document navigation overriding the load type on a specific domain.
      Returns:
      This GeckoRuntimeSettings instance.

    • getSameDocumentNavigationOverridesLoadTypeForceDisable

      @NonNull public String getSameDocumentNavigationOverridesLoadTypeForceDisable()
      Gets the uri to force-disable the same document navigation overriding the load type. If it is an empty string (default value), there's no specific domain that the same document navigation overriding the load type is disabled.
      Returns:
      URI that will be used to force-disable the same document navigation overriding the load type on a specific domain.

    • writeToParcel

      public void writeToParcel(Parcel out, int flags)
      Specified by:
      writeToParcel in interface Parcelable
      Overrides:
      writeToParcel in class RuntimeSettings

    • readFromParcel

      public void readFromParcel(@NonNull Parcel source)
      Overrides:
      readFromParcel in class RuntimeSettings