WebViewBuilder

const val PRESET_LEGACY = 0: Int

Matches the configuration of a WebView created via the WebView constructor.

WebViewBuilder(preset: Int)

Create a new builder with settings initialized to the given preset Preset.

Currently, only the PRESET_LEGACY preset is supported.

fun addAllowlist(allowList: RestrictionAllowlist): WebViewBuilder

Add an allowlist of behaviors for a list of origin patterns. All allowlists will be merged together. A WebViewBuilderException will be thrown from build if a behavior is allowlisted that has not been restricted via the WebViewBuilder.

@UiThread
@RequiresFeature(name = WebViewFeature.WEBVIEW_BUILDER_EXPERIMENTAL_V2, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun <T : WebView?> applyTo(webview: T): T

Applies a builder config to an existing but unused WebView.

This allows the builder to be used in cases where build is not practical, including cases where WebView has been inflated from an XML layout or subclassed.

It is not permitted to call any other WebView APIs on the WebView before this. A WebView may only have a builder configuration applied at most once. This API may not be used with WebViews that were built with build.

This method should only be called if isFeatureSupported returns true for WEBVIEW_BUILDER_EXPERIMENTAL_V2.

@UiThread
@RequiresFeature(name = WebViewFeature.WEBVIEW_BUILDER_EXPERIMENTAL_V1, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun build(context: Context): WebView

Constructs a new WebView with all the properties defined.

This method should only be called if isFeatureSupported returns true for WEBVIEW_BUILDER_EXPERIMENTAL_V1.

fun restrictJavaScriptInterfaces(): WebViewBuilder

Restrict addJavascriptInterface and removeJavascriptInterface from being callable.

Opting into this restriction makes these methods throw a RuntimeException if called on the built WebView.

This needs to be called in order to allow specific origin patterns to inject JavaScript interfaces via addJavaScriptInterface.

@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun setProfile(profileName: String): WebViewBuilder

Set the profile for the WebView.

If the profile does not exist, it will be created when build is called, as per getOrCreateProfile.

This method should only be called if isFeatureSupported returns true for MULTI_PROFILE.