system/pro.respawn.kmmutils.system.android/WebClient

WebClient

open class WebClient(allowedHosts: List<String?>) : WebViewClient, DownloadListener

A web client that solves many problems of WebViewClient and provides a nice API to use. This client automatically sets JS as enabled. You can override this behavior by calling WebSettings.setJavaScriptEnabled. Only domains in allowedHosts will be opened in the webview, others will trigger WebClientListener.onForeignUrlEncountered. Don't forget to attach the client in onViewCreated and detach it in onDestroyView.

Constructors

WebClient

constructor(allowedHosts: List<String?>)

Properties

canGoBack

open val canGoBack: Boolean

Whether the web history is not empty and the user can go back

url

val url: String?

Current webview URL, or null if nothing is loaded

Functions

attach

open fun attach(webView: WebView, listener: WebClientListener? = null, userAgent: String? = null, javaScriptEnabled: Boolean = true): WebClient

Call this in androidx.fragment.app.Fragment.onViewCreated

clearAllData

open fun clearAllData(forAllWebViews: Boolean = false)

Clear all data associated with web views on device. Clears cookies and localstorage as well if forAllWebViews is true

clearHistory

open fun clearHistory()

Clear the navigation history

detach

open fun detach()

Call this in androidx.fragment.app.Fragment.onDestroyView. If you do not call this, you will get crashes in runtime and a memory leak!

doUpdateVisitedHistory

open fun doUpdateVisitedHistory(p0: WebView, p1: String, p2: Boolean)

goBack

open fun goBack()

Go back through the browser history if possible

load

open fun load(uri: Uri)

Load an uri

onDownloadStart

open override fun onDownloadStart(url: String?, userAgent: String?, contentDisposition: String?, mimetype: String?, contentLength: Long)

onFormResubmission

open fun onFormResubmission(p0: WebView, p1: Message, p2: Message)

onLoadResource

open fun onLoadResource(p0: WebView, p1: String)

onPageCommitVisible

open fun onPageCommitVisible(p0: WebView, p1: String)

onPageFinished

open override fun onPageFinished(view: WebView?, url: String?)

onPageStarted

open override fun onPageStarted(view: WebView?, url: String?, favicon: Bitmap?)

onReceivedClientCertRequest

open fun onReceivedClientCertRequest(p0: WebView, p1: ClientCertRequest)

onReceivedError

open fun ~~onReceivedError~~(p0: WebView, p1: Int, p2: String, p3: String)

open override fun onReceivedError(view: WebView?, request: WebResourceRequest?, error: WebResourceError?)

onReceivedHttpAuthRequest

open fun onReceivedHttpAuthRequest(p0: WebView, p1: HttpAuthHandler, p2: String, p3: String)

onReceivedHttpError

open fun onReceivedHttpError(p0: WebView, p1: WebResourceRequest, p2: WebResourceResponse)

onReceivedLoginRequest

open fun onReceivedLoginRequest(p0: WebView, p1: String, p2: String?, p3: String)

onReceivedSslError

open fun onReceivedSslError(p0: WebView, p1: SslErrorHandler, p2: SslError)

onRenderProcessGone

open fun onRenderProcessGone(p0: WebView, p1: RenderProcessGoneDetail): Boolean

onSafeBrowsingHit

open fun onSafeBrowsingHit(p0: WebView, p1: WebResourceRequest, p2: Int, p3: SafeBrowsingResponse)

onScaleChanged

open fun onScaleChanged(p0: WebView, p1: Float, p2: Float)

onTooManyRedirects

open fun ~~onTooManyRedirects~~(p0: WebView, p1: Message, p2: Message)

onUnhandledKeyEvent

open fun onUnhandledKeyEvent(p0: WebView, p1: KeyEvent)

reload

open fun reload()

Refresh current page.

restoreState

open fun restoreState(inState: Bundle)

Call this in androidx.appcompat.app.AppCompatActivity.onSaveInstanceState state or androidx.fragment.app.Fragment.onViewStateRestored, if you do not save state, webView will not save it for you!

saveState

open fun saveState(outState: Bundle)

Call this in androidx.fragment.app.Fragment.onSaveInstanceState to save webview state. If you do not call this, webview won't save it for you!

shouldInterceptRequest

open fun shouldInterceptRequest(p0: WebView, p1: WebResourceRequest): WebResourceResponse?

open fun ~~shouldInterceptRequest~~(p0: WebView, p1: String): WebResourceResponse?

shouldOverrideKeyEvent

open fun shouldOverrideKeyEvent(p0: WebView, p1: KeyEvent): Boolean

shouldOverrideUrlLoading

open fun ~~shouldOverrideUrlLoading~~(p0: WebView, p1: String): Boolean

open override fun shouldOverrideUrlLoading(view: WebView?, request: WebResourceRequest): Boolean