H5AdsWebViewClient

Kotlin |Java

@RequiresApi(api = VERSION_CODES.LOLLIPOP)
public final class H5AdsWebViewClient extends WebViewClient

java.lang.Object
↳	android.webkit.WebViewClient
	↳	com.google.android.gms.ads.h5.H5AdsWebViewClient

A WebViewClient that intercepts and handles H5 ad requests. To use this, set this as the client of the WebView that contains the web apps that will be making H5 ad requests.

IMPORTANT: This WebViewClient cannot be used for multiple WebViews. Every new WebView that will support H5 ads must use a new H5AdsWebViewClient.

Example code:

public void onCreate(Bundle savedInstanceState) {
  ...

  // Initialize early to reduce latency on the session's first ad request.
  MobileAds.initialize(this);

  WebView myWebView = findViewById(R.id.my_webview);

  // JavaScript must be enabled.
  WebSettings settings = myWebView.getSettings();
  settings.setJavaScriptEnabled(true);

  H5AdsWebViewClient h5Client = new H5AdsWebViewClient(this, myWebView);

  // (Optional) any existing WebViewClient
  WebViewClient myClient = ...;
  h5Client.setDelegateWebViewClient(myClient);

  webView.setWebViewClient(h5Client);
}

Summary

Public constructors
`H5AdsWebViewClient(Context context, WebView webView)` Constructor for `H5AdsWebViewClient`.

Public methods
`void`	`clearAdObjects()` Destroys all ads being managed by H5 ads.
`void`	`doUpdateVisitedHistory(WebView view, String url, boolean isReload)`
`@Nullable WebViewClient`	`getDelegateWebViewClient()` Gets the delegate `WebViewClient`.
`void`	`onFormResubmission(WebView view, Message dontResend, Message resend)`
`void`	`onLoadResource(WebView view, String url)`
`void`	`@RequiresApi(api = VERSION_CODES.M) onPageCommitVisible(WebView view, String url)`
`void`	`onPageFinished(WebView view, String url)`
`void`	`onPageStarted(WebView view, String url, Bitmap favicon)`
`void`	`onReceivedClientCertRequest(WebView view, ClientCertRequest request)`
`void`	`@RequiresApi(api = VERSION_CODES.M) onReceivedError( WebView view, WebResourceRequest request, WebResourceError error )`
`void`	`onReceivedError( WebView view, int errorCode, String description, String failingUrl )` This method is deprecated.
`void`	`onReceivedHttpAuthRequest( WebView view, HttpAuthHandler handler, String host, String realm )`
`void`	`@RequiresApi(api = VERSION_CODES.M) onReceivedHttpError( WebView view, WebResourceRequest request, WebResourceResponse errorResponse )`
`void`	`onReceivedLoginRequest( WebView view, String realm, @Nullable String account, String args )`
`void`	`onReceivedSslError( WebView view, SslErrorHandler handler, SslError error )`
`boolean`	`@RequiresApi(api = VERSION_CODES.O) onRenderProcessGone(WebView view, RenderProcessGoneDetail detail)`
`void`	`@RequiresApi(api = VERSION_CODES.O_MR1) onSafeBrowsingHit( WebView view, WebResourceRequest request, int threatType, SafeBrowsingResponse callback )`
`void`	`onScaleChanged(WebView view, float oldScale, float newScale)`
`void`	`onTooManyRedirects(WebView view, Message cancelMsg, Message continueMsg)` This method is deprecated.
`void`	`onUnhandledKeyEvent(WebView view, KeyEvent event)`
`void`	`setDelegateWebViewClient(@Nullable WebViewClient delegate)` Sets a `WebViewClient` to delegate methods not handled by `H5AdsWebViewClient`.
`@Nullable WebResourceResponse`	`shouldInterceptRequest(WebView view, WebResourceRequest request)`
`@Nullable WebResourceResponse`	`shouldInterceptRequest(WebView view, String url)` This method is deprecated.
`boolean`	`shouldOverrideKeyEvent(WebView view, KeyEvent event)`
`boolean`	`@RequiresApi(api = VERSION_CODES.N) shouldOverrideUrlLoading(WebView view, WebResourceRequest request)`
`boolean`	`shouldOverrideUrlLoading(WebView view, String url)` This method is deprecated.

Protected methods
`WebViewClient`	`getDelegate()`

Inherited Constants

From android.webkit.WebViewClient

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

Inherited methods

From android.webkit.WebViewClient

`void`	`doUpdateVisitedHistory(WebView p, String p1, boolean p2)`
`void`	`onFormResubmission(WebView p, Message p1, Message p2)`
`void`	`onLoadResource(WebView p, String p1)`
`void`	`onPageCommitVisible(WebView p, String p1)`
`void`	`onPageFinished(WebView p, String p1)`
`void`	`onPageStarted(WebView p, String p1, Bitmap p2)`
`void`	`onReceivedClientCertRequest(WebView p, ClientCertRequest p1)`
`void`	`onReceivedError(WebView p, WebResourceRequest p1, WebResourceError p2)`
`void`	`onReceivedHttpAuthRequest( WebView p, HttpAuthHandler p1, String p2, String p3 )`
`void`	`onReceivedHttpError( WebView p, WebResourceRequest p1, WebResourceResponse p2 )`
`void`	`onReceivedLoginRequest(WebView p, String p1, String p2, String p3)`
`void`	`onReceivedSslError(WebView p, SslErrorHandler p1, SslError p2)`
`boolean`	`onRenderProcessGone(WebView p, RenderProcessGoneDetail p1)`
`void`	`onSafeBrowsingHit( WebView p, WebResourceRequest p1, int p2, SafeBrowsingResponse p3 )`
`void`	`onScaleChanged(WebView p, float p1, float p2)`
`void`	`onTooManyRedirects(WebView p, Message p1, Message p2)` This method is deprecated.
`void`	`onUnhandledKeyEvent(WebView p, KeyEvent p1)`
`WebResourceResponse`	`shouldInterceptRequest(WebView p, WebResourceRequest p1)`
`boolean`	`shouldOverrideKeyEvent(WebView p, KeyEvent p1)`
`boolean`	`shouldOverrideUrlLoading(WebView p, WebResourceRequest p1)`

Public constructors

H5AdsWebViewClient

public H5AdsWebViewClient(Context context, WebView webView)

Constructor for H5AdsWebViewClient.

Parameters
`Context context`	An activity or application context.
`WebView webView`	The `WebView` that will be associated with this `H5AdsWebViewClient`. JavaScript must be enabled on the WebView.

Public methods

clearAdObjects

public void clearAdObjects()

Destroys all ads being managed by H5 ads.

Note: This method has no effect on any ads created by the non-H5 AdMob API, such as and .

doUpdateVisitedHistory

public void doUpdateVisitedHistory(WebView view, String url, boolean isReload)

getDelegateWebViewClient

public @Nullable WebViewClient getDelegateWebViewClient()

Gets the delegate WebViewClient.

onFormResubmission

public void onFormResubmission(WebView view, Message dontResend, Message resend)

onLoadResource

public void onLoadResource(WebView view, String url)

onPageCommitVisible

@RequiresApi(api = VERSION_CODES.M)
public void onPageCommitVisible(WebView view, String url)

onPageFinished

public void onPageFinished(WebView view, String url)

onPageStarted

public void onPageStarted(WebView view, String url, Bitmap favicon)

onReceivedClientCertRequest

public void onReceivedClientCertRequest(WebView view, ClientCertRequest request)

onReceivedError

@RequiresApi(api = VERSION_CODES.M)
public void onReceivedError(
    WebView view,
    WebResourceRequest request,
    WebResourceError error
)

onReceivedError

public void onReceivedError(
    WebView view,
    int errorCode,
    String description,
    String failingUrl
)

onReceivedHttpAuthRequest

public void onReceivedHttpAuthRequest(
    WebView view,
    HttpAuthHandler handler,
    String host,
    String realm
)

onReceivedHttpError

@RequiresApi(api = VERSION_CODES.M)
public void onReceivedHttpError(
    WebView view,
    WebResourceRequest request,
    WebResourceResponse errorResponse
)

onReceivedLoginRequest

public void onReceivedLoginRequest(
    WebView view,
    String realm,
    @Nullable String account,
    String args
)

onReceivedSslError

public void onReceivedSslError(
    WebView view,
    SslErrorHandler handler,
    SslError error
)

onRenderProcessGone

@RequiresApi(api = VERSION_CODES.O)
public boolean onRenderProcessGone(WebView view, RenderProcessGoneDetail detail)

onSafeBrowsingHit

@RequiresApi(api = VERSION_CODES.O_MR1)
public void onSafeBrowsingHit(
    WebView view,
    WebResourceRequest request,
    int threatType,
    SafeBrowsingResponse callback
)

onScaleChanged

public void onScaleChanged(WebView view, float oldScale, float newScale)

onTooManyRedirects

public void onTooManyRedirects(WebView view, Message cancelMsg, Message continueMsg)

onUnhandledKeyEvent

public void onUnhandledKeyEvent(WebView view, KeyEvent event)

setDelegateWebViewClient

public void setDelegateWebViewClient(@Nullable WebViewClient delegate)

Sets a WebViewClient to delegate methods not handled by H5AdsWebViewClient.

shouldInterceptRequest

public @Nullable WebResourceResponse shouldInterceptRequest(WebView view, WebResourceRequest request)

shouldInterceptRequest

public @Nullable WebResourceResponse shouldInterceptRequest(WebView view, String url)

shouldOverrideKeyEvent

public boolean shouldOverrideKeyEvent(WebView view, KeyEvent event)

shouldOverrideUrlLoading

@RequiresApi(api = VERSION_CODES.N)
public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request)

shouldOverrideUrlLoading

public boolean shouldOverrideUrlLoading(WebView view, String url)

Protected methods

getDelegate

protected WebViewClient getDelegate()