com.braze.ui.inappmessage.utils

Class InAppMessageWebViewClient

java.lang.Object

android.webkit.WebViewClient

com.braze.ui.inappmessage.utils.InAppMessageWebViewClient

public class InAppMessageWebViewClient
extends android.webkit.WebViewClient

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JAVASCRIPT_PREFIX
static java.lang.String	QUERY_NAME_BUTTON_ID The query key for the button id for tracking
static java.lang.String	QUERY_NAME_DEEPLINK Query key for directing Braze to open Url intents using the INTENT.ACTION_VIEW.
static java.lang.String	QUERY_NAME_EXTERNAL_OPEN The query key for opening links externally (i.e.

Fields inherited from class android.webkit.WebViewClient

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

Constructor Summary

Constructors

Constructor and Description
InAppMessageWebViewClient(android.content.Context context, IInAppMessage inAppMessage, IInAppMessageWebViewClientListener inAppMessageWebViewClientListener)

Method Summary

Modifier and Type	Method and Description
void	onPageFinished(android.webkit.WebView view, java.lang.String url)
void	setWebViewClientStateListener(IWebViewClientStateListener listener)
boolean	shouldOverrideUrlLoading(android.webkit.WebView view, java.lang.String url)
boolean	shouldOverrideUrlLoading(android.webkit.WebView view, android.webkit.WebResourceRequest request) Handles `appboy` schemed ("appboy://") urls in the HTML content WebViews.

Methods inherited from class android.webkit.WebViewClient

doUpdateVisitedHistory, onFormResubmission, onLoadResource, onPageCommitVisible, onPageStarted, onReceivedClientCertRequest, onReceivedError, onReceivedError, onReceivedHttpAuthRequest, onReceivedHttpError, onReceivedLoginRequest, onReceivedSslError, onRenderProcessGone, onSafeBrowsingHit, onScaleChanged, onTooManyRedirects, onUnhandledKeyEvent, shouldInterceptRequest, shouldInterceptRequest, shouldOverrideKeyEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

QUERY_NAME_BUTTON_ID

public static final java.lang.String QUERY_NAME_BUTTON_ID

The query key for the button id for tracking

See Also:

Constant Field Values

QUERY_NAME_EXTERNAL_OPEN

public static final java.lang.String QUERY_NAME_EXTERNAL_OPEN

The query key for opening links externally (i.e. outside your app). Url intents will be opened with the INTENT.ACTION_VIEW intent. Links beginning with the appboy:// scheme are unaffected by this query key.

See Also:

Constant Field Values

QUERY_NAME_DEEPLINK

public static final java.lang.String QUERY_NAME_DEEPLINK

Query key for directing Braze to open Url intents using the INTENT.ACTION_VIEW.

See Also:

Constant Field Values

JAVASCRIPT_PREFIX

public static final java.lang.String JAVASCRIPT_PREFIX

See Also:

Constant Field Values

Constructor Detail

InAppMessageWebViewClient

public InAppMessageWebViewClient(android.content.Context context,
                                 IInAppMessage inAppMessage,
                                 IInAppMessageWebViewClientListener inAppMessageWebViewClientListener)

Parameters:

inAppMessage - the In-App Message being displayed in this WebView

inAppMessageWebViewClientListener - the client listener. Should be non-null.

Method Detail

onPageFinished

public void onPageFinished(android.webkit.WebView view,
                           java.lang.String url)

Overrides:

onPageFinished in class android.webkit.WebViewClient

shouldOverrideUrlLoading

public boolean shouldOverrideUrlLoading(android.webkit.WebView view,
                                        android.webkit.WebResourceRequest request)

Handles `appboy` schemed ("appboy://") urls in the HTML content WebViews. If the url isn't `appboy` schemed, then the url is passed to the attached IInAppMessageWebViewClientListener.

We expect the URLs to be hierarchical and have `appboy` equal the scheme. For example, `appboy://close` is one such URL.

Overrides:

shouldOverrideUrlLoading in class android.webkit.WebViewClient

Returns:

true since all actions in Html In-App Messages are handled outside of the In-App Message itself.

shouldOverrideUrlLoading

public boolean shouldOverrideUrlLoading(android.webkit.WebView view,
                                        java.lang.String url)

Overrides:

shouldOverrideUrlLoading in class android.webkit.WebViewClient

setWebViewClientStateListener

public void setWebViewClientStateListener(IWebViewClientStateListener listener)