android-components / mozilla.components.concept.engine / Settings

# Settings

`abstract class Settings` (source)

Holds settings of an engine or session. Concrete engine implementations define how these settings are applied i.e. whether a setting is applied on an engine or session instance.

### Constructors

<init> | `Settings()` Holds settings of an engine or session. Concrete engine implementations define how these settings are applied i.e. whether a setting is applied on an engine or session instance.

### Properties

allowContentAccess | `open var allowContentAccess: Boolean` Setting to control whether or not the engine is allowed to load content from a content provider installed in the system.
allowFileAccess | `open var allowFileAccess: Boolean` Setting to control whether or not file access is allowed.
allowFileAccessFromFileURLs | `open var allowFileAccessFromFileURLs: Boolean` Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs.
allowUniversalAccessFromFileURLs | `open var allowUniversalAccessFromFileURLs: Boolean` Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from any origin.
displayZoomControls | `open var displayZoomControls: Boolean` Setting to control whether or not zoom controls should be displayed.
domStorageEnabled | `open var domStorageEnabled: Boolean` Setting to control whether or not DOM Storage is enabled.
historyTrackingDelegate | `open var historyTrackingDelegate: HistoryTrackingDelegate?` Setting to provide a history delegate to the engine.
horizontalScrollBarEnabled | `open var horizontalScrollBarEnabled: Boolean` Setting to control whether or not horizontal scrolling is enabled.
javaScriptCanOpenWindowsAutomatically | `open var javaScriptCanOpenWindowsAutomatically: Boolean` Setting to control whether or not window.open can be called from JavaScript.
javascriptEnabled | `open var javascriptEnabled: Boolean` Setting to control whether or not JavaScript is enabled.
loadWithOverviewMode | `open var loadWithOverviewMode: Boolean` Setting to control whether or not the engine zooms out the content to fit on screen by width.
mediaPlaybackRequiresUserGesture | `open var mediaPlaybackRequiresUserGesture: Boolean` Setting to control whether or not a user gesture is required to play media.
remoteDebuggingEnabled | `open var remoteDebuggingEnabled: Boolean` Setting to control whether or not remote debugging is enabled.
requestInterceptor | `open var requestInterceptor: RequestInterceptor?` Setting to intercept and override requests.
trackingProtectionPolicy | `open var trackingProtectionPolicy: TrackingProtectionPolicy?` Setting to control tracking protection.
userAgentString | `open var userAgentString: String?` Setting to control the user agent string.
verticalScrollBarEnabled | `open var verticalScrollBarEnabled: Boolean` Setting to control whether or not vertical scrolling is enabled.
webFontsEnabled | `open var webFontsEnabled: Boolean` Setting to control whether or not Web fonts are enabled.

### Inheritors

DefaultSettings | `data class DefaultSettings : Settings` Settings implementation used to set defaults for Engine and EngineSession.