Google is committed to advancing racial equity for Black communities. See how.

WebViewClientCompat

open class WebViewClientCompat : WebViewClient, WebViewClientBoundaryInterface
kotlin.Any
   ↳ android.webkit.WebViewClient
   ↳ androidx.webkit.WebViewClientCompat

Compatibility version of android.webkit.WebViewClient.

Summary

Public constructors

Compatibility version of android.webkit.WebViewClient.
Public methods
open Unit
onPageCommitVisible(@NonNull view: WebView, @NonNull url: String)

Notify the host application that android.webkit.WebView content left over from previous page navigations will no longer be drawn.
Unit
onReceivedError(@NonNull view: WebView, @NonNull request: WebResourceRequest, @NonNull error: WebResourceError)

Applications are not meant to override this, and should instead override the non-final method.
open Unit
onReceivedError(@NonNull view: WebView, @NonNull request: WebResourceRequest, @NonNull error: WebResourceErrorCompat)

Report web resource loading error to the host application.
open Unit
onReceivedHttpError(@NonNull view: WebView, @NonNull request: WebResourceRequest, @NonNull errorResponse: WebResourceResponse)

Notify the host application that an HTTP error has been received from the server while loading a resource.
Unit
onSafeBrowsingHit(@NonNull view: WebView, @NonNull request: WebResourceRequest, threatType: Int, @NonNull response: SafeBrowsingResponse)

Applications are not meant to override this, and should instead override the non-final method.
open Unit
onSafeBrowsingHit(@NonNull view: WebView, @NonNull request: WebResourceRequest, threatType: Int, @NonNull callback: SafeBrowsingResponseCompat)

Notify the host application that a loading URL has been flagged by Safe Browsing.
open Boolean
shouldOverrideUrlLoading(@NonNull view: WebView, @NonNull request: WebResourceRequest)

Give the host application a chance to take over the control when a new url is about to be loaded in the current WebView.

Public constructors

<init>

WebViewClientCompat()

Compatibility version of android.webkit.WebViewClient.

Public methods

onPageCommitVisible

@UiThread open fun onPageCommitVisible(
    @NonNull view: WebView, 
    @NonNull url: String
): Unit

Notify the host application that android.webkit.WebView content left over from previous page navigations will no longer be drawn.

This callback can be used to determine the point at which it is safe to make a recycled android.webkit.WebView visible, ensuring that no stale content is shown. It is called at the earliest point at which it can be guaranteed that WebView#onDraw will no longer draw any content from previous navigations. The next draw will display either the background color of the WebView, or some of the contents of the newly loaded page.

This method is called when the body of the HTTP response has started loading, is reflected in the DOM, and will be visible in subsequent draws. This callback occurs early in the document loading process, and as such you should expect that linked resources (for example, CSS and images) may not be available.

For more fine-grained notification of visual state updates, see .

Please note that all the conditions and recommendations applicable to WebViewCompat#postVisualStateCallback also apply to this API.

This callback is only called for main frame navigations.

This method is called only if WebViewFeature#VISUAL_STATE_CALLBACK is supported. You can check whether that flag is supported using .

Parameters
view WebView: The android.webkit.WebView for which the navigation occurred.
url String: The URL corresponding to the page navigation that triggered this callback.

onReceivedError

@RequiresApi(23) fun onReceivedError(
    @NonNull view: WebView, 
    @NonNull request: WebResourceRequest, 
    @NonNull error: WebResourceError
): Unit

Applications are not meant to override this, and should instead override the non-final method.

onReceivedError

@RequiresApi(21) @UiThread open fun onReceivedError(
    @NonNull view: WebView, 
    @NonNull request: WebResourceRequest, 
    @NonNull error: WebResourceErrorCompat
): Unit

Report web resource loading error to the host application. These errors usually indicate inability to connect to the server. Note that unlike the deprecated version of the callback, the new version will be called for any resource (iframe, image, etc.), not just for the main page. Thus, it is recommended to perform minimum required work in this callback.

This method is called only if WebViewFeature#RECEIVE_WEB_RESOURCE_ERROR is supported. You can check whether that flag is supported using .

Parameters
view WebView: The WebView that is initiating the callback.
request WebResourceRequest: The originating request.
error WebResourceErrorCompat: Information about the error occurred.

onReceivedHttpError

@UiThread open fun onReceivedHttpError(
    @NonNull view: WebView, 
    @NonNull request: WebResourceRequest, 
    @NonNull errorResponse: WebResourceResponse
): Unit

Notify the host application that an HTTP error has been received from the server while loading a resource. HTTP errors have status codes >= 400. This callback will be called for any resource (iframe, image, etc.), not just for the main page. Thus, it is recommended to perform minimum required work in this callback. Note that the content of the server response may not be provided within the errorResponse parameter.

This method is called only if WebViewFeature#RECEIVE_HTTP_ERROR is supported. You can check whether that flag is supported using .

Parameters
view WebView: The WebView that is initiating the callback.
request WebResourceRequest: The originating request.
errorResponse WebResourceResponse: Information about the error occurred.

onSafeBrowsingHit

@RequiresApi(27) fun onSafeBrowsingHit(
    @NonNull view: WebView, 
    @NonNull request: WebResourceRequest, 
    threatType: Int, 
    @NonNull response: SafeBrowsingResponse
): Unit

Applications are not meant to override this, and should instead override the non-final method.

onSafeBrowsingHit

@UiThread open fun onSafeBrowsingHit(
    @NonNull view: WebView, 
    @NonNull request: WebResourceRequest, 
    threatType: Int, 
    @NonNull callback: SafeBrowsingResponseCompat
): Unit

Notify the host application that a loading URL has been flagged by Safe Browsing. The application must invoke the callback to indicate the preferred response. The default behavior is to show an interstitial to the user, with the reporting checkbox visible. If the application needs to show its own custom interstitial UI, the callback can be invoked asynchronously with SafeBrowsingResponseCompat#backToSafety or , depending on user response.

Parameters
view WebView: The WebView that hit the malicious resource.
request WebResourceRequest: Object containing the details of the request.
threatType Int: The reason the resource was caught by Safe Browsing, corresponding to a SAFE_BROWSING_THREAT_* value.
callback SafeBrowsingResponseCompat: Applications must invoke one of the callback methods.

shouldOverrideUrlLoading

@RequiresApi(21) @UiThread open fun shouldOverrideUrlLoading(
    @NonNull view: WebView, 
    @NonNull request: WebResourceRequest
): Boolean

Give the host application a chance to take over the control when a new url is about to be loaded in the current WebView. If WebViewClient is not provided, by default WebView will ask Activity Manager to choose the proper handler for the url. If WebViewClient is provided, return true means the host application handles the url, while return false means the current WebView handles the url.

Notes:

  • This method is not called for