WebViewClientCompat

Added in 1.1.0

Kotlin |Java

class WebViewClientCompat : WebViewClient

kotlin.Any
↳	android.webkit.WebViewClient
	↳	androidx.webkit.WebViewClientCompat

Compatibility version of android.webkit.WebViewClient.

Summary

Public constructors
`WebViewClientCompat()`

Public functions
`Unit`	`@UiThread onPageCommitVisible(view: WebView, url: String)` Notify the host application that `android.webkit.WebView` content left over from previous page navigations will no longer be drawn.
`Unit`	`@RequiresApi(value = Build.VERSION_CODES.M) onReceivedError( view: WebView, request: WebResourceRequest, error: WebResourceError )` Applications are not meant to override this, and should instead override the non-final `onReceivedError` method.
`Unit`	`@UiThread onReceivedError( view: WebView, request: WebResourceRequest, error: WebResourceErrorCompat )` Report web resource loading error to the host application.
`Unit`	`@UiThread onReceivedHttpError( view: WebView, request: WebResourceRequest, errorResponse: WebResourceResponse )` Notify the host application that an HTTP error has been received from the server while loading a resource.
`Unit`	`@UiThread onSafeBrowsingHit( view: WebView, request: WebResourceRequest, threatType: Int, callback: SafeBrowsingResponseCompat )` Notify the host application that a loading URL has been flagged by Safe Browsing.
`Unit`	`@RequiresApi(value = Build.VERSION_CODES.O_MR1) onSafeBrowsingHit( view: WebView, request: WebResourceRequest, threatType: Int, response: SafeBrowsingResponse )` Applications are not meant to override this, and should instead override the non-final `onSafeBrowsingHit` method.
`Boolean`	`@UiThread shouldOverrideUrlLoading(view: WebView, 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.

Inherited Constants

From android.webkit.WebViewClient

`const Int`	`ERROR_AUTHENTICATION = -4`
`const Int`	`ERROR_BAD_URL = -12`
`const Int`	`ERROR_CONNECT = -6`
`const Int`	`ERROR_FAILED_SSL_HANDSHAKE = -11`
`const Int`	`ERROR_FILE = -13`
`const Int`	`ERROR_FILE_NOT_FOUND = -14`
`const Int`	`ERROR_HOST_LOOKUP = -2`
`const Int`	`ERROR_IO = -7`
`const Int`	`ERROR_PROXY_AUTHENTICATION = -5`
`const Int`	`ERROR_REDIRECT_LOOP = -9`
`const Int`	`ERROR_TIMEOUT = -8`
`const Int`	`ERROR_TOO_MANY_REQUESTS = -15`
`const Int`	`ERROR_UNKNOWN = -1`
`const Int`	`ERROR_UNSAFE_RESOURCE = -16`
`const Int`	`ERROR_UNSUPPORTED_AUTH_SCHEME = -3`
`const Int`	`ERROR_UNSUPPORTED_SCHEME = -10`
`const Int`	`SAFE_BROWSING_THREAT_BILLING = 4`
`const Int`	`SAFE_BROWSING_THREAT_MALWARE = 1`
`const Int`	`SAFE_BROWSING_THREAT_PHISHING = 2`
`const Int`	`SAFE_BROWSING_THREAT_UNKNOWN = 0`
`const Int`	`SAFE_BROWSING_THREAT_UNWANTED_SOFTWARE = 3`

Inherited functions

From android.webkit.WebViewClient

`Unit`	`doUpdateVisitedHistory(view: WebView!, url: String!, isReload: Boolean)`
`Unit`	`onFormResubmission(view: WebView!, dontResend: Message!, resend: Message!)`
`Unit`	`onLoadResource(view: WebView!, url: String!)`
`Unit`	`onPageFinished(view: WebView!, url: String!)`
`Unit`	`onPageStarted(view: WebView!, url: String!, favicon: Bitmap!)`
`Unit`	`onReceivedClientCertRequest(view: WebView!, request: ClientCertRequest!)`
`Unit`	`onReceivedHttpAuthRequest( view: WebView!, handler: HttpAuthHandler!, host: String!, realm: String! )`
`Unit`	`onReceivedLoginRequest( view: WebView!, realm: String!, account: String!, args: String! )`
`Unit`	`onReceivedSslError( view: WebView!, handler: SslErrorHandler!, error: SslError! )`
`Boolean`	`onRenderProcessGone(view: WebView!, detail: RenderProcessGoneDetail!)`
`Unit`	`onScaleChanged(view: WebView!, oldScale: Float, newScale: Float)`
`Unit`	`onTooManyRedirects(view: WebView!, cancelMsg: Message!, continueMsg: Message!)` This function is deprecated.
`Unit`	`onUnhandledKeyEvent(view: WebView!, event: KeyEvent!)`
`WebResourceResponse!`	`shouldInterceptRequest(view: WebView!, request: WebResourceRequest!)`
`Boolean`	`shouldOverrideKeyEvent(view: WebView!, event: KeyEvent!)`

Public constructors

WebViewClientCompat

Added in 1.1.0

WebViewClientCompat()

Public functions

onPageCommitVisible

@UiThread
fun onPageCommitVisible(view: WebView, 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 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 postVisualStateCallback.

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

This callback is only called for main frame navigations.

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

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

Added in 1.1.0

@RequiresApi(value = Build.VERSION_CODES.M)
fun onReceivedError(
    view: WebView,
    request: WebResourceRequest,
    error: WebResourceError
): Unit

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

onReceivedError

Added in 1.1.0

@UiThread
fun onReceivedError(
    view: WebView,
    request: WebResourceRequest,
    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 RECEIVE_WEB_RESOURCE_ERROR is supported. You can check whether that flag is supported using isFeatureSupported.

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

onReceivedHttpError

@UiThread
fun onReceivedHttpError(
    view: WebView,
    request: WebResourceRequest,
    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 RECEIVE_HTTP_ERROR is supported. You can check whether that flag is supported using isFeatureSupported.

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 1.1.0

@UiThread
fun onSafeBrowsingHit(
    view: WebView,
    request: WebResourceRequest,
    threatType: Int,
    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 backToSafety or proceed, 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.

onSafeBrowsingHit

Added in 1.1.0

@RequiresApi(value = Build.VERSION_CODES.O_MR1)
fun onSafeBrowsingHit(
    view: WebView,
    request: WebResourceRequest,
    threatType: Int,
    response: SafeBrowsingResponse
): Unit

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

shouldOverrideUrlLoading

@UiThread
fun shouldOverrideUrlLoading(view: WebView, 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 requests using the POST "method".
This method is also called for subframes with non-http schemes, thus it is strongly disadvised to unconditionally call loadUrl 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 SHOULD_OVERRIDE_WITH_REDIRECTS is supported. You can check whether that flag is supported using isFeatureSupported.

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`.