WebChromeClient

getDefaultVideoPoster

open fun getDefaultVideoPoster(): Bitmap?

When not playing, video elements are represented by a 'poster' image. The image to use can be specified by the poster attribute of the video tag in HTML. If the attribute is absent, then a default poster will be used. This method allows the ChromeClient to provide that default image.

getVideoLoadingProgressView

open fun getVideoLoadingProgressView(): View?

Obtains a View to be displayed while buffering of full screen video is taking place. The host application can override this method to provide a View containing a spinner or similar.

getVisitedHistory

open fun getVisitedHistory(callback: ValueCallback<Array<String!>!>!): Unit

Obtains a list of all visited history items, used for link coloring

onCloseWindow

open fun onCloseWindow(window: WebView!): Unit

Notify the host application to close the given WebView and remove it from the view system if necessary. At this point, WebCore has stopped any loading in this window and has removed any cross-scripting ability in javascript.

As with onCreateWindow, the application should ensure that any URL or security indicator displayed is updated so that the user can tell that the page they were interacting with has been closed.

onConsoleMessage

open fun onConsoleMessage(consoleMessage: ConsoleMessage!): Boolean

Report a JavaScript console message to the host application. The ChromeClient should override this to process the log message as they see fit.

onConsoleMessage

open fun onConsoleMessage(
    message: String!, 
    lineNumber: Int, 
    sourceID: String!
): Unit

Deprecated: Use onConsoleMessage(ConsoleMessage) instead.

Report a JavaScript error message to the host application. The ChromeClient should override this to process the log message as they see fit.

onCreateWindow

open fun onCreateWindow(
    view: WebView!, 
    isDialog: Boolean, 
    isUserGesture: Boolean, 
    resultMsg: Message!
): Boolean

Request the host application to create a new window. If the host application chooses to honor this request, it should return true from this method, create a new WebView to host the window, insert it into the View system and send the supplied resultMsg message to its target with the new WebView as an argument. If the host application chooses not to honor the request, it should return false from this method. The default implementation of this method does nothing and hence returns false.

Applications should typically not allow windows to be created when the isUserGesture flag is false, as this may be an unwanted popup.

Applications should be careful how they display the new window: don't simply overlay it over the existing WebView as this may mislead the user about which site they are viewing. If your application displays the URL of the main page, make sure to also display the URL of the new window in a similar fashion. If your application does not display URLs, consider disallowing the creation of new windows entirely.

Note: There is no trustworthy way to tell which page requested the new window: the request might originate from a third-party iframe inside the WebView.

onExceededDatabaseQuota

open fun onExceededDatabaseQuota(
    url: String!, 
    databaseIdentifier: String!, 
    quota: Long, 
    estimatedDatabaseSize: Long, 
    totalQuota: Long, 
    quotaUpdater: WebStorage.QuotaUpdater!
): Unit

Deprecated: This method is no longer called; WebView now uses the HTML5 / JavaScript Quota Management API.

Tell the client that the quota has been exceeded for the Web SQL Database API for a particular origin and request a new quota. The client must respond by invoking the updateQuota(long) method of the supplied WebStorage.QuotaUpdater instance. The minimum value that can be set for the new quota is the current quota. The default implementation responds with the current quota, so the quota will not be increased.

onGeolocationPermissionsHidePrompt

open fun onGeolocationPermissionsHidePrompt(): Unit

Notify the host application that a request for Geolocation permissions, made with a previous call to onGeolocationPermissionsShowPrompt() has been canceled. Any related UI should therefore be hidden.

onGeolocationPermissionsShowPrompt

open fun onGeolocationPermissionsShowPrompt(
    origin: String!, 
    callback: GeolocationPermissions.Callback!
): Unit

Notify the host application that web content from the specified origin is attempting to use the Geolocation API, but no permission state is currently set for that origin. The host application should invoke the specified callback with the desired permission state. See GeolocationPermissions for details.

Note that for applications targeting Android N and later SDKs (API level > android.os.Build.VERSION_CODES#M) this method is only called for requests originating from secure origins such as https. On non-secure origins geolocation requests are automatically denied.

onHideCustomView

open fun onHideCustomView(): Unit

Notify the host application that the current page has exited full screen mode. The host application must hide the custom View (the View which was previously passed to onShowCustomView()). After this call, web content will render in the original WebView again.

Note: if overriding this method, the application must also override onShowCustomView().

onJsAlert

open fun onJsAlert(
    view: WebView!, 
    url: String!, 
    message: String!, 
    result: JsResult!
): Boolean

Notify the host application that the web page wants to display a JavaScript alert() dialog.

The default behavior if this method returns false or is not overridden is to show a dialog containing the alert message and suspend JavaScript execution until the dialog is dismissed.

To show a custom dialog, the app should return true from this method, in which case the default dialog will not be shown and JavaScript execution will be suspended. The app should call JsResult.confirm() when the custom dialog is dismissed such that JavaScript execution can be resumed.

To suppress the dialog and allow JavaScript execution to continue, call JsResult.confirm() immediately and then return true.

Note that if the WebChromeClient is set to be null, or if WebChromeClient is not set at all, the default dialog will be suppressed and Javascript execution will continue immediately.

Note that the default dialog does not inherit the android.view.Display#FLAG_SECURE flag from the parent window.

onJsBeforeUnload

open fun onJsBeforeUnload(
    view: WebView!, 
    url: String!, 
    message: String!, 
    result: JsResult!
): Boolean

Notify the host application that the web page wants to confirm navigation from JavaScript onbeforeunload.

The default behavior if this method returns false or is not overridden is to show a dialog containing the message and suspend JavaScript execution until the dialog is dismissed. The default dialog will continue the navigation if the user confirms the navigation, and will stop the navigation if the user wants to stay on the current page.

To show a custom dialog, the app should return true from this method, in which case the default dialog will not be shown and JavaScript execution will be suspended. When the custom dialog is dismissed, the app should call JsResult.confirm() to continue the navigation or, JsResult.cancel() to stay on the current page.

To suppress the dialog and allow JavaScript execution to continue, call JsResult.confirm() or JsResult.cancel() immediately and then return true.

Note that if the WebChromeClient is set to be null, or if WebChromeClient is not set at all, the default dialog will be suppressed and the navigation will be resumed immediately.

Note that the default dialog does not inherit the android.view.Display#FLAG_SECURE flag from the parent window.

onJsConfirm

open fun onJsConfirm(
    view: WebView!, 
    url: String!, 
    message: String!, 
    result: JsResult!
): Boolean

Notify the host application that the web page wants to display a JavaScript confirm() dialog.

The default behavior if this method returns false or is not overridden is to show a dialog containing the message and suspend JavaScript execution until the dialog is dismissed. The default dialog will return true to the JavaScript confirm() code when the user presses the 'confirm' button, and will return false to the JavaScript code when the user presses the 'cancel' button or dismisses the dialog.

To show a custom dialog, the app should return true from this method, in which case the default dialog will not be shown and JavaScript execution will be suspended. The app should call JsResult.confirm() or JsResult.cancel() when the custom dialog is dismissed.

To suppress the dialog and allow JavaScript execution to continue, call JsResult.confirm() or JsResult.cancel() immediately and then return true.

Note that if the WebChromeClient is set to be null, or if WebChromeClient is not set at all, the default dialog will be suppressed and the default value of false will be returned to the JavaScript code immediately.

Note that the default dialog does not inherit the android.view.Display#FLAG_SECURE flag from the parent window.

onJsPrompt

open fun onJsPrompt(
    view: WebView!, 
    url: String!, 
    message: String!, 
    defaultValue: String!, 
    result: JsPromptResult!
): Boolean

Notify the host application that the web page wants to display a JavaScript prompt() dialog.

The default behavior if this method returns false or is not overridden is to show a dialog containing the message and suspend JavaScript execution until the dialog is dismissed. Once the dialog is dismissed, JavaScript prompt() will return the string that the user typed in, or null if the user presses the 'cancel' button.

To show a custom dialog, the app should return true from this method, in which case the default dialog will not be shown and JavaScript execution will be suspended. The app should call JsPromptResult.confirm(result) when the custom dialog is dismissed.

To suppress the dialog and allow JavaScript execution to continue, call JsPromptResult.confirm(result) immediately and then return true.

Note that if the WebChromeClient is set to be null, or if WebChromeClient is not set at all, the default dialog will be suppressed and null will be returned to the JavaScript code immediately.

Note that the default dialog does not inherit the android.view.Display#FLAG_SECURE flag from the parent window.

onJsTimeout

open fun onJsTimeout(): Boolean

Deprecated: This method is no longer supported and will not be invoked.

Tell the client that a JavaScript execution timeout has occured. And the client may decide whether or not to interrupt the execution. If the client returns true, the JavaScript will be interrupted. If the client returns false, the execution will continue. Note that in the case of continuing execution, the timeout counter will be reset, and the callback will continue to occur if the script does not finish at the next check point.

onPermissionRequest

open fun onPermissionRequest(request: PermissionRequest!): Unit

Notify the host application that web content is requesting permission to access the specified resources and the permission currently isn't granted or denied. The host application must invoke PermissionRequest.grant(String[]) or PermissionRequest.deny(). If this method isn't overridden, the permission is denied.

onPermissionRequestCanceled

open fun onPermissionRequestCanceled(request: PermissionRequest!): Unit

Notify the host application that the given permission request has been canceled. Any related UI should therefore be hidden.

onProgressChanged

open fun onProgressChanged(
    view: WebView!, 
    newProgress: Int
): Unit

Tell the host application the current progress of loading a page.

onReceivedIcon

open fun onReceivedIcon(
    view: WebView!, 
    icon: Bitmap!
): Unit

Notify the host application of a new favicon for the current page.

onReceivedTitle

open fun onReceivedTitle(
    view: WebView!, 
    title: String!
): Unit

Notify the host application of a change in the document title.

onReceivedTouchIconUrl

open fun onReceivedTouchIconUrl(
    view: WebView!, 
    url: String!, 
    precomposed: Boolean
): Unit

Notify the host application of the url for an apple-touch-icon.

onRequestFocus

open fun onRequestFocus(view: WebView!): Unit

Request display and focus for this WebView. This may happen due to another WebView opening a link in this WebView and requesting that this WebView be displayed.

onShowCustomView

open fun onShowCustomView(
    view: View!, 
    callback: WebChromeClient.CustomViewCallback!
): Unit

Notify the host application that the current page has entered full screen mode. After this call, web content will no longer be rendered in the WebView, but will instead be rendered in view. The host application should add this View to a Window which is configured with android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN flag in order to actually display this web content full screen.

The application may explicitly exit fullscreen mode by invoking callback (ex. when the user presses the back button). However, this is generally not necessary as the web page will often show its own UI to close out of fullscreen. Regardless of how the WebView exits fullscreen mode, WebView will invoke onHideCustomView(), signaling for the application to remove the custom View.

If this method is not overridden, WebView will report to the web page it does not support fullscreen mode and will not honor the web page's request to run in fullscreen mode.

Note: if overriding this method, the application must also override onHideCustomView().

onShowCustomView

open fun onShowCustomView(
    view: View!, 
    requestedOrientation: Int, 
    callback: WebChromeClient.CustomViewCallback!
): Unit

Deprecated: This method supports the obsolete plugin mechanism, and will not be invoked in future

Notify the host application that the current page would like to show a custom View in a particular orientation.

onShowFileChooser

open fun onShowFileChooser(
    webView: WebView!, 
    filePathCallback: ValueCallback<Array<Uri!>!>!, 
    fileChooserParams: WebChromeClient.FileChooserParams!
): Boolean

Tell the client to show a file chooser. This is called to handle HTML forms with 'file' input type, in response to the user pressing the "Select File" button. To cancel the request, call filePathCallback.onReceiveValue(null) and return true.

Note: WebView does not enforce any restrictions on the chosen file(s). WebView can access all files that your app can access. In case the file(s) are chosen through an untrusted source such as a third-party app, it is your own app's responsibility to check what the returned Uris refer to before calling the filePathCallback. See #createIntent and #parseResult for more details.