org.apache.cordova

Class PluginManager

java.lang.Object

org.apache.cordova.PluginManager

public class PluginManager
extends java.lang.Object

PluginManager is exposed to JavaScript in the Cordova WebView. Calling native plugin code can be done by calling PluginManager.exec(...) from JavaScript.

Constructor Summary

Constructors

Constructor and Description
PluginManager(CordovaWebView cordovaWebView, CordovaInterface cordova, java.util.Collection<PluginEntry> pluginEntries)

Method Summary

Modifier and Type	Method and Description
void	addService(PluginEntry entry) Add a plugin classes that implements a service to the service entry table.
void	addService(java.lang.String service, java.lang.String className) Add a plugin classes that implements a service to the service entry table.
void	exec(java.lang.String service, java.lang.String action, java.lang.String callbackId, java.lang.String rawArgs) Receives a request for execution and fulfills it by finding the appropriate Java classes and calling it's execute method.
CordovaPlugin	getPlugin(java.lang.String service) Get the plugin object that implements the service.
java.util.Collection<PluginEntry>	getPluginEntries()
void	init() Init when loading a new HTML page into webview.
void	onConfigurationChanged(android.content.res.Configuration newConfig) Called by the system when the device configuration changes while your activity is running.
void	onDestroy() The final call you receive before your activity is destroyed.
void	onNewIntent(android.content.Intent intent) Called when the activity receives a new intent.
boolean	onOverrideUrlLoading(java.lang.String url) Called when the URL of the webview changes.
void	onPause(boolean multitasking) Called when the system is about to start resuming a previous activity.
boolean	onReceivedClientCertRequest(CordovaWebView view, ICordovaClientCertRequest request) Called when he system received an SSL client certificate request.
boolean	onReceivedHttpAuthRequest(CordovaWebView view, ICordovaHttpAuthHandler handler, java.lang.String host, java.lang.String realm) Called when the system received an HTTP authentication request.
void	onReset() Called when the app navigates or refreshes.
void	onResume(boolean multitasking) Called when the activity will start interacting with the user.
android.os.Bundle	onSaveInstanceState()
void	onStart() Called when the activity is becoming visible to the user.
void	onStop() Called when the activity is no longer visible to the user.
java.lang.Object	postMessage(java.lang.String id, java.lang.Object data) Send a message to all plugins.
void	setPluginEntries(java.util.Collection<PluginEntry> pluginEntries)
boolean	shouldAllowBridgeAccess(java.lang.String url) Called when the webview is requesting the exec() bridge be enabled.
boolean	shouldAllowNavigation(java.lang.String url) Called when the webview is going to change the URL of the loaded content.
boolean	shouldAllowRequest(java.lang.String url) Called when the webview is going to request an external resource.
java.lang.Boolean	shouldOpenExternalUrl(java.lang.String url) Called when the webview is going not going to navigate, but may launch an Intent for an URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManager

public PluginManager(CordovaWebView cordovaWebView,
                     CordovaInterface cordova,
                     java.util.Collection<PluginEntry> pluginEntries)

Method Detail

getPluginEntries

public java.util.Collection<PluginEntry> getPluginEntries()

setPluginEntries

public void setPluginEntries(java.util.Collection<PluginEntry> pluginEntries)

init

public void init()

Init when loading a new HTML page into webview.

exec

public void exec(java.lang.String service,
                 java.lang.String action,
                 java.lang.String callbackId,
                 java.lang.String rawArgs)

Receives a request for execution and fulfills it by finding the appropriate Java classes and calling it's execute method. PluginManager.exec can be used either synchronously or async. In either case, a JSON encoded string is returned that will indicate if any errors have occurred when trying to find or execute the classes denoted by the clazz argument.

Parameters:

service - String containing the service to run

action - String containing the action that the classes is supposed to perform. This is passed to the plugin execute method and it is up to the plugin developer how to deal with it.

callbackId - String containing the id of the callback that is execute in JavaScript if this is an async plugin call.

rawArgs - An Array literal string containing any arguments needed in the plugin execute method.

getPlugin

public CordovaPlugin getPlugin(java.lang.String service)

Get the plugin object that implements the service. If the plugin object does not already exist, then create it. If the service doesn't exist, then return null.

Parameters:

service - The name of the service.

Returns:

CordovaPlugin or null

addService

public void addService(java.lang.String service,
                       java.lang.String className)

Add a plugin classes that implements a service to the service entry table. This does not create the plugin object instance.

Parameters:

service - The service name

className - The plugin classes name

addService

public void addService(PluginEntry entry)

Add a plugin classes that implements a service to the service entry table. This does not create the plugin object instance.

Parameters:

entry - The plugin entry

onPause

public void onPause(boolean multitasking)

Called when the system is about to start resuming a previous activity.

Parameters:

multitasking - Flag indicating if multitasking is turned on for app

onReceivedHttpAuthRequest

public boolean onReceivedHttpAuthRequest(CordovaWebView view,
                                         ICordovaHttpAuthHandler handler,
                                         java.lang.String host,
                                         java.lang.String realm)

Called when the system received an HTTP authentication request. Plugins can use the supplied HttpAuthHandler to process this auth challenge.

Parameters:

view - The WebView that is initiating the callback

handler - The HttpAuthHandler used to set the WebView's response

host - The host requiring authentication

realm - The realm for which authentication is required

Returns:

Returns True if there is a plugin which will resolve this auth challenge, otherwise False

onReceivedClientCertRequest

public boolean onReceivedClientCertRequest(CordovaWebView view,
                                           ICordovaClientCertRequest request)

Called when he system received an SSL client certificate request. Plugin can use the supplied ClientCertRequest to process this certificate challenge.

Parameters:

view - The WebView that is initiating the callback

request - The client certificate request

Returns:

Returns True if plugin will resolve this auth challenge, otherwise False

onResume

public void onResume(boolean multitasking)

Called when the activity will start interacting with the user.

Parameters:

multitasking - Flag indicating if multitasking is turned on for app

onStart

public void onStart()

Called when the activity is becoming visible to the user.

onStop

public void onStop()

Called when the activity is no longer visible to the user.

onDestroy

public void onDestroy()

The final call you receive before your activity is destroyed.

postMessage

public java.lang.Object postMessage(java.lang.String id,
                                    java.lang.Object data)

Send a message to all plugins.

Parameters:

id - The message id

data - The message data

Returns:

Object to stop propagation or null

onNewIntent

public void onNewIntent(android.content.Intent intent)

Called when the activity receives a new intent.

shouldAllowRequest

public boolean shouldAllowRequest(java.lang.String url)

Called when the webview is going to request an external resource. This delegates to the installed plugins, and returns true/false for the first plugin to provide a non-null result. If no plugins respond, then the default policy is applied.

Parameters:

url - The URL that is being requested.

Returns:

Returns true to allow the resource to load, false to block the resource.

shouldAllowNavigation

public boolean shouldAllowNavigation(java.lang.String url)

Called when the webview is going to change the URL of the loaded content. This delegates to the installed plugins, and returns true/false for the first plugin to provide a non-null result. If no plugins respond, then the default policy is applied.

Parameters:

url - The URL that is being requested.

Returns:

Returns true to allow the navigation, false to block the navigation.

shouldAllowBridgeAccess

public boolean shouldAllowBridgeAccess(java.lang.String url)

Called when the webview is requesting the exec() bridge be enabled.

shouldOpenExternalUrl

public java.lang.Boolean shouldOpenExternalUrl(java.lang.String url)

Called when the webview is going not going to navigate, but may launch an Intent for an URL. This delegates to the installed plugins, and returns true/false for the first plugin to provide a non-null result. If no plugins respond, then the default policy is applied.

Parameters:

url - The URL that is being requested.

Returns:

Returns true to allow the URL to launch an intent, false to block the intent.

onOverrideUrlLoading

public boolean onOverrideUrlLoading(java.lang.String url)

Called when the URL of the webview changes.

Parameters:

url - The URL that is being changed to.

Returns:

Return false to allow the URL to load, return true to prevent the URL from loading.

onReset

public void onReset()

Called when the app navigates or refreshes.

onConfigurationChanged

public void onConfigurationChanged(android.content.res.Configuration newConfig)

Called by the system when the device configuration changes while your activity is running.

Parameters:

newConfig - The new device configuration

onSaveInstanceState

public android.os.Bundle onSaveInstanceState()