added in version 1.0.0
belongs to Maven artifact androidx.webkit:webkit:1.0.0-beta01

Summary: Inherited Constants | Ctors | Methods | Inherited Methods

WebViewClientCompat

public class WebViewClientCompat
extends WebViewClient

java.lang.Object
↳	android.webkit.WebViewClient
	↳	androidx.webkit.WebViewClientCompat

Compatibility version of WebViewClient.

Summary

Inherited constants

From class android.webkit.WebViewClient

`int`	`ERROR_AUTHENTICATION`
`int`	`ERROR_BAD_URL`
`int`	`ERROR_CONNECT`
`int`	`ERROR_FAILED_SSL_HANDSHAKE`
`int`	`ERROR_FILE`
`int`	`ERROR_FILE_NOT_FOUND`
`int`	`ERROR_HOST_LOOKUP`
`int`	`ERROR_IO`
`int`	`ERROR_PROXY_AUTHENTICATION`
`int`	`ERROR_REDIRECT_LOOP`
`int`	`ERROR_TIMEOUT`
`int`	`ERROR_TOO_MANY_REQUESTS`
`int`	`ERROR_UNKNOWN`
`int`	`ERROR_UNSAFE_RESOURCE`
`int`	`ERROR_UNSUPPORTED_AUTH_SCHEME`
`int`	`ERROR_UNSUPPORTED_SCHEME`
`int`	`SAFE_BROWSING_THREAT_MALWARE`
`int`	`SAFE_BROWSING_THREAT_PHISHING`
`int`	`SAFE_BROWSING_THREAT_UNKNOWN`
`int`	`SAFE_BROWSING_THREAT_UNWANTED_SOFTWARE`

Public constructors
`WebViewClientCompat()`

Public methods
`void`	`onPageCommitVisible(WebView view, String url)` Notify the host application that `WebView` content left over from previous page navigations will no longer be drawn.
`void`	`onReceivedError(WebView view, WebResourceRequest request, WebResourceErrorCompat error)` Report web resource loading error to the host application.
`final void`	`onReceivedError(WebView view, WebResourceRequest request, WebResourceError error)` Applications are not meant to override this, and should instead override the non-final `onReceivedError(WebView, WebResourceRequest, WebResourceErrorCompat)` method.
`void`	`onReceivedHttpError(WebView view, WebResourceRequest request, WebResourceResponse errorResponse)` Notify the host application that an HTTP error has been received from the server while loading a resource.
`final void`	`onSafeBrowsingHit(WebView view, WebResourceRequest request, int threatType, SafeBrowsingResponse response)` Applications are not meant to override this, and should instead override the non-final `onSafeBrowsingHit(WebView, WebResourceRequest, int, SafeBrowsingResponseCompat)` method.
`void`	`onSafeBrowsingHit(WebView view, WebResourceRequest request, int threatType, SafeBrowsingResponseCompat callback)` Notify the host application that a loading URL has been flagged by Safe Browsing.
`boolean`	`shouldOverrideUrlLoading(WebView view, WebResourceRequest request)` Give the host application a chance to take over the control when a new url is about to be loaded in the current WebView.

Inherited methods

From class


        
          android.webkit.WebViewClient

`void`	`doUpdateVisitedHistory(WebView arg0, String arg1, boolean arg2)`
`void`	`onFormResubmission(WebView arg0, Message arg1, Message arg2)`
`void`	`onLoadResource(WebView arg0, String arg1)`
`void`	`onPageCommitVisible(WebView arg0, String arg1)`
`void`	`onPageFinished(WebView arg0, String arg1)`
`void`	`onPageStarted(WebView arg0, String arg1, Bitmap arg2)`
`void`	`onReceivedClientCertRequest(WebView arg0, ClientCertRequest arg1)`
`void`	`onReceivedError(WebView arg0, int arg1, String arg2, String arg3)`
`void`	`onReceivedError(WebView arg0, WebResourceRequest arg1, WebResourceError arg2)`
`void`	`onReceivedHttpAuthRequest(WebView arg0, HttpAuthHandler arg1, String arg2, String arg3)`
`void`	`onReceivedHttpError(WebView arg0, WebResourceRequest arg1, WebResourceResponse arg2)`
`void`	`onReceivedLoginRequest(WebView arg0, String arg1, String arg2, String arg3)`
`void`	`onReceivedSslError(WebView arg0, SslErrorHandler arg1, SslError arg2)`
`boolean`	`onRenderProcessGone(WebView arg0, RenderProcessGoneDetail arg1)`
`void`	`onSafeBrowsingHit(WebView arg0, WebResourceRequest arg1, int arg2, SafeBrowsingResponse arg3)`
`void`	`onScaleChanged(WebView arg0, float arg1, float arg2)`
`void`	`onTooManyRedirects(WebView arg0, Message arg1, Message arg2)`
`void`	`onUnhandledKeyEvent(WebView arg0, KeyEvent arg1)`
`WebResourceResponse`	`shouldInterceptRequest(WebView arg0, WebResourceRequest arg1)`
`WebResourceResponse`	`shouldInterceptRequest(WebView arg0, String arg1)`
`boolean`	`shouldOverrideKeyEvent(WebView arg0, KeyEvent arg1)`
`boolean`	`shouldOverrideUrlLoading(WebView arg0, WebResourceRequest arg1)`
`boolean`	`shouldOverrideUrlLoading(WebView arg0, String arg1)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

WebViewClientCompat

added in version 1.0.0

public WebViewClientCompat ()

Public methods

onPageCommitVisible

public void onPageCommitVisible (WebView view, 
                String url)

Notify the host application that 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 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(Canvas) 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 WebViewCompat.postVisualStateCallback(WebView, long, WebViewCompat.VisualStateCallback).

Please note that all the conditions and recommendations applicable to WebViewCompat.postVisualStateCallback(WebView, long, WebViewCompat.VisualStateCallback) 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 WebViewFeature.isFeatureSupported(String).

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

onReceivedError

added in version 1.0.0

public void onReceivedError (WebView view, 
                WebResourceRequest request, 
                WebResourceErrorCompat error)

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 WebViewFeature.isFeatureSupported(String).

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

onReceivedError

added in version 1.0.0

public final void onReceivedError (WebView view, 
                WebResourceRequest request, 
                WebResourceError error)

Applications are not meant to override this, and should instead override the non-final onReceivedError(WebView, WebResourceRequest, WebResourceErrorCompat) method.

Parameters
`view`	`WebView`
`request`	`WebResourceRequest`
`error`	`WebResourceError`

onReceivedHttpError

public void onReceivedHttpError (WebView view, 
                WebResourceRequest request, 
                WebResourceResponse errorResponse)

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 WebViewFeature.isFeatureSupported(String).

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

onSafeBrowsingHit

added in version 1.0.0

public final void onSafeBrowsingHit (WebView view, 
                WebResourceRequest request, 
                int threatType, 
                SafeBrowsingResponse response)

Applications are not meant to override this, and should instead override the non-final onSafeBrowsingHit(WebView, WebResourceRequest, int, SafeBrowsingResponseCompat) method.

Parameters
`view`	`WebView`
`request`	`WebResourceRequest`
`threatType`	`int`
`response`	`SafeBrowsingResponse`

onSafeBrowsingHit

added in version 1.0.0

public void onSafeBrowsingHit (WebView view, 
                WebResourceRequest request, 
                int threatType, 
                SafeBrowsingResponseCompat callback)

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(boolean) or SafeBrowsingResponseCompat.proceed(boolean), 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

public boolean shouldOverrideUrlLoading (WebView view, 
                WebResourceRequest request)

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 requests using the POST "method".
This method is also called for subframes with non-http schemes, thus it is strongly disadvised to unconditionally call WebView.loadUrl(String) with the request's url from inside the method and then return true, as this will make WebView to attempt loading a non-http url, and thus fail.

This method is called only if WebViewFeature.SHOULD_OVERRIDE_WITH_REDIRECTS is supported. You can check whether that flag is supported using WebViewFeature.isFeatureSupported(String).

Parameters
`view`	`WebView`: The WebView that is initiating the callback.
`request`	`WebResourceRequest`: Object containing the details of the request.

Returns
`boolean`	`true` if the host application wants to leave the current WebView and handle the url itself, otherwise return `false`.

WebViewClientCompat

Summary

Inherited constants

Public constructors

Public methods

Inherited methods

Public constructors

WebViewClientCompat

Public methods

onPageCommitVisible

onReceivedError

onReceivedError

onReceivedHttpError

onSafeBrowsingHit

onSafeBrowsingHit

shouldOverrideUrlLoading

Interfaces

Classes