me.adaptive.arp.api

Interface IAppContextWebview

All Known Implementing Classes:

AppContextWebviewBridge

public interface IAppContextWebview

Interface for webview context management purposes

Since:

v2.0

Method Summary

Modifier and Type	Method and Description
void	addWebview(java.lang.Object webView) Additional views may be added to an application - a separate activity - and if these will make calls to the ARP methods, they must be registered by adding them to the context.
void	executeJavaScript(java.lang.String javaScriptText) Evaluate the specified javascript on the main webview of the application.
void	executeJavaScript(java.lang.String javaScriptText, java.lang.Object webViewReference) Evaluate the specified javascript on the specified webview of the application.
java.lang.Object	getWebviewPrimary() Returns a reference to the main application webview.
java.lang.Object[]	getWebviews() Returns an array of webviews currently managed by the context - composed of primary and the list of those added.
void	removeWebview(java.lang.Object webView) When a webview is disposed - no longer in use from an external activity - the webview should be removed to unbind ARP functions and release resources.

Method Detail

addWebview

void addWebview(java.lang.Object webView)

Additional views may be added to an application - a separate activity - and if these will make calls to the ARP methods, they must be registered by adding them to the context. When they are added to the context, ARP methods are bound to the webview so that they're callable from the HTML application. The primary webview should not be added using this method.

Parameters:

webView - Platform specific webview reference (WebView, UIWebView, WKWebView,etc.)

Since:

v2.0

executeJavaScript

void executeJavaScript(java.lang.String javaScriptText)

Evaluate the specified javascript on the main webview of the application.

Parameters:

javaScriptText - The javascript expression to execute on the webview.

executeJavaScript

void executeJavaScript(java.lang.String javaScriptText,
                       java.lang.Object webViewReference)

Evaluate the specified javascript on the specified webview of the application.

Parameters:

javaScriptText - The javascript expression to execute on the webview.

webViewReference - The target webview on which to execute the expression.

getWebviewPrimary

java.lang.Object getWebviewPrimary()

Returns a reference to the main application webview. This is the first application webview and can not be removed with the removeWebview method. The object returned should be cast to the platform specific implementation WebView, WKWebView, etc.

Returns:

Object representing the specific and primary webview instance of the application.

Since:

v2.0

getWebviews

java.lang.Object[] getWebviews()

Returns an array of webviews currently managed by the context - composed of primary and the list of those added. This method will always return at least one element; the primary webview.

Returns:

Array with all the Webview instances being managed by ARP.

Since:

v2.0

removeWebview

void removeWebview(java.lang.Object webView)

When a webview is disposed - no longer in use from an external activity - the webview should be removed to unbind ARP functions and release resources. The primary webview can not be removed.

Parameters:

webView - The instance of the webview to be removed from the binding.

Since:

v2.0