com.dff.cordova.plugin.common

Class CommonPlugin

java.lang.Object

org.apache.cordova.CordovaPlugin

com.dff.cordova.plugin.common.CommonPlugin

Direct Known Subclasses:

AlertPlugin, CameraPlugin, CommonServicePlugin, CrashReportPlugin, IpAddress, M3SM10Plugin, PackageManagerPlugin, TelephonyPlugin, WifiManagerPlugin

public class CommonPlugin
extends CordovaPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.Class<? extends CordovaAction>>	actions
protected static LogListener	logListener
protected static java.util.ArrayList<java.lang.String>	sPermissionsList

Fields inherited from class org.apache.cordova.CordovaPlugin

cordova, preferences, webView

Constructor Summary

Constructors

Constructor and Description
CommonPlugin()
CommonPlugin(java.lang.String childLogTag)

Method Summary

Modifier and Type	Method and Description
static void	addPermission(java.lang.String permission) allow subclass to add their permission to the local permissions list
boolean	execute(java.lang.String action, org.json.JSONArray args, CallbackContext callbackContext) Executes the request.
void	onActivityResult(int requestCode, int resultCode, android.content.Intent intent) Called when an activity you launched exits, giving you the requestCode you started it with, the resultCode it returned, and any additional data from it.
void	onDestroy() The final call you receive before your activity is destroyed.
java.lang.Object	onMessage(java.lang.String id, java.lang.Object data) Called when a message is sent to plugin.
void	onNewIntent(android.content.Intent intent) Called when the activity receives a new intent.
void	onPause(boolean multitasking) Called when the system is about to start resuming a previous activity.
void	onRequestPermissionResult(int requestCode, java.lang.String[] permissions, int[] grantResults) If permissions are denied log and error and leave method
void	onReset() Called when the WebView does a top-level navigation or refreshes.
void	onRestoreStateForActivityResult(android.os.Bundle state, CallbackContext callbackContext) Called when a plugin is the recipient of an Activity result after the CordovaActivity has been destroyed.
void	onResume(boolean multitasking) Called when the activity will start interacting with the user.
android.os.Bundle	onSaveInstanceState() Called when the Activity is being destroyed (e.g. if a plugin calls out to an external Activity and the OS kills the CordovaActivity in the background).
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.
void	pluginInitialize() Called after plugin construction and fields have been initialized.

Methods inherited from class org.apache.cordova.CordovaPlugin

execute, execute, fromPluginUri, getServiceName, handleOpenForRead, hasPermisssion, initialize, onConfigurationChanged, onOverrideUrlLoading, onReceivedClientCertRequest, onReceivedHttpAuthRequest, privateInitialize, remapUri, requestPermissions, shouldAllowBridgeAccess, shouldAllowNavigation, shouldAllowRequest, shouldOpenExternalUrl, toPluginUri

Methods inherited from class java.lang.Object

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

Field Detail

sPermissionsList

protected static java.util.ArrayList<java.lang.String> sPermissionsList

logListener

protected static LogListener logListener

actions

protected java.util.HashMap<java.lang.String,java.lang.Class<? extends CordovaAction>> actions

Constructor Detail

CommonPlugin

public CommonPlugin()

CommonPlugin

public CommonPlugin(java.lang.String childLogTag)

Method Detail

pluginInitialize

public void pluginInitialize()

Called after plugin construction and fields have been initialized.

Overrides:

pluginInitialize in class CordovaPlugin

addPermission

public static void addPermission(java.lang.String permission)

allow subclass to add their permission to the local permissions list

Parameters:

permission - - the permission to add

onRequestPermissionResult

public void onRequestPermissionResult(int requestCode,
                                      java.lang.String[] permissions,
                                      int[] grantResults)
                               throws org.json.JSONException

If permissions are denied log and error and leave method

Overrides:

onRequestPermissionResult in class CordovaPlugin

Parameters:

requestCode -

permissions -

grantResults -

Throws:

org.json.JSONException

onPause

public void onPause(boolean multitasking)

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

Overrides:

onPause in class CordovaPlugin

Parameters:

multitasking - Flag indicating if multitasking is turned on for app

onResume

public void onResume(boolean multitasking)

Called when the activity will start interacting with the user.

Overrides:

onResume in class CordovaPlugin

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.

Overrides:

onStart in class CordovaPlugin

onStop

public void onStop()

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

Overrides:

onStop in class CordovaPlugin

onNewIntent

public void onNewIntent(android.content.Intent intent)

Called when the activity receives a new intent.

Overrides:

onNewIntent in class CordovaPlugin

onDestroy

public void onDestroy()

The final call you receive before your activity is destroyed.

Overrides:

onDestroy in class CordovaPlugin

onSaveInstanceState

public android.os.Bundle onSaveInstanceState()

Called when the Activity is being destroyed (e.g. if a plugin calls out to an external Activity and the OS kills the CordovaActivity in the background). The plugin should save its state in this method only if it is awaiting the result of an external Activity and needs to preserve some information so as to handle that result; onRestoreStateForActivityResult() will only be called if the plugin is the recipient of an Activity result

Overrides:

onSaveInstanceState in class CordovaPlugin

Returns:

Bundle containing the state of the plugin or null if state does not need to be saved

onRestoreStateForActivityResult

public void onRestoreStateForActivityResult(android.os.Bundle state,
                                            CallbackContext callbackContext)

Called when a plugin is the recipient of an Activity result after the CordovaActivity has been destroyed. The Bundle will be the same as the one the plugin returned in onSaveInstanceState()

Overrides:

onRestoreStateForActivityResult in class CordovaPlugin

Parameters:

state - Bundle containing the state of the plugin

callbackContext - Replacement Context to return the plugin result to

onMessage

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

Called when a message is sent to plugin.

Overrides:

onMessage in class CordovaPlugin

Parameters:

id - The message id

data - The message data

Returns:

Object to stop propagation or null

onActivityResult

public void onActivityResult(int requestCode,
                             int resultCode,
                             android.content.Intent intent)

Called when an activity you launched exits, giving you the requestCode you started it with, the resultCode it returned, and any additional data from it.

Overrides:

onActivityResult in class CordovaPlugin

Parameters:

requestCode - The request code originally supplied to startActivityForResult(), allowing you to identify who this result came from.

resultCode - The integer result code returned by the child activity through its setResult().

intent - An Intent, which can return result data to the caller (various data can be attached to Intent "extras").

onReset

public void onReset()

Called when the WebView does a top-level navigation or refreshes.

Plugins should stop any long-running processes and clean up internal state.

Does nothing by default.

Overrides:

onReset in class CordovaPlugin

execute

public boolean execute(java.lang.String action,
                       org.json.JSONArray args,
                       CallbackContext callbackContext)
                throws org.json.JSONException

Executes the request.

This method is called from the WebView thread. To do a non-trivial amount of work, use: cordova.getThreadPool().execute(runnable);

To run on the UI thread, use: cordova.getActivity().runOnUiThread(runnable);

Overrides:

execute in class CordovaPlugin

Parameters:

action - The action to execute.

args - The exec() arguments.

callbackContext - The callback context used when calling back into JavaScript.

Returns:

Whether the action was valid.

Throws:

org.json.JSONException