package

androidx.webkit

Overview

The androidx.webkit library is a static library you can add to your Android application in order to use android.webkit APIs that are not available for older platform versions.

Requirements

The minimum sdk version to use this library is 14.

How to declare the dependencies to use the library

Inside your app's build.gradle file, include this line in dependencies:

dependencies {
    ...
    implementation 'androidx.webkit:webkit:1.0.0'
}

Migrating to androidx.webkit

For static methods:

Old code:

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O_MR1) {
    WebView.startSafeBrowsing(appContext, callback);
}

New code:

if (WebViewFeature.isFeatureSupported(WebViewFeature.START_SAFE_BROWSING)) {
    WebViewCompat.startSafeBrowsing(appContext, callback);
}

Or, if you are using a non-static method:

Old code:

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    myWebView.postVisualStateCallback(requestId, callback);
}

New code:

if (WebViewFeature.isFeatureSupported(WebViewFeature.VISUAL_STATE_CALLBACK)) {
    WebViewCompat.postVisualStateCallback(myWebView, requestId, callback);
}

Interfaces

WebViewAssetLoader.PathHandlerA handler that produces responses for a registered path.
WebViewCompat.VisualStateCallbackCallback interface supplied to WebViewCompat.postVisualStateCallback(WebView, long, WebViewCompat.VisualStateCallback) for receiving notifications about the visual state.

Classes

ProxyConfigConfig for ProxyController.setProxyOverride(ProxyConfig, Executor, Runnable).
ProxyConfig.BuilderProxyConfig builder.
ProxyConfig.ProxyRuleClass that holds a scheme filter and a proxy URL.
ProxyControllerManages setting and clearing a process-specific override for the Android system-wide proxy settings that govern network requests made by .
SafeBrowsingResponseCompatCompatibility version of .
ServiceWorkerClientCompatBase class for clients to capture Service Worker related callbacks, see ServiceWorkerControllerCompat for usage example.
ServiceWorkerControllerCompatManages Service Workers used by WebView.
ServiceWorkerWebSettingsCompatManages settings state for all Service Workers.
TracingConfigHolds tracing configuration information and predefined settings for TracingController.
TracingConfig.BuilderBuilder used to create TracingConfig objects.
TracingControllerManages tracing of WebViews.
WebMessageCompatThe Java representation of the HTML5 PostMessage event.
WebMessagePortCompat

The Java representation of the HTML5 message ports.

WebMessagePortCompat.WebMessageCallbackCompatThe listener for handling MessagePort events.
WebResourceErrorCompatCompatibility version of .
WebResourceRequestCompatCompatibility version of .
WebSettingsCompatCompatibility version of
WebViewAssetLoaderHelper class to load local files including application's static assets and resources using http(s):// URLs inside a class.
WebViewAssetLoader.AssetsPathHandlerHandler class to open a file from assets directory in the application APK.
WebViewAssetLoader.BuilderA builder class for constructing WebViewAssetLoader objects.
WebViewAssetLoader.InternalStoragePathHandlerHandler class to open files from application internal storage.
WebViewAssetLoader.ResourcesPathHandlerHandler class to open a file from resources directory in the application APK.
WebViewClientCompatCompatibility version of .
WebViewCompatCompatibility version of
WebViewFeatureUtility class for checking which WebView Support Library features are supported on the device.
WebViewRenderProcessWebViewRenderProcess provides an opaque handle to a WebView renderer.
WebViewRenderProcessClientUsed to receive callbacks on renderer events.

Annotation Types

ProxyConfig.ProxyScheme
ServiceWorkerWebSettingsCompat.CacheMode
TracingConfig.PredefinedCategories
TracingConfig.TracingMode
WebResourceErrorCompat.NetErrorCode
WebSettingsCompat.ForceDark
WebSettingsCompat.MenuItemFlags
WebViewClientCompat.SafeBrowsingThreat
WebViewFeature.WebViewSupportFeature