org.apache.cordova

Class CordovaInterfaceImpl

java.lang.Object

org.apache.cordova.CordovaInterfaceImpl

All Implemented Interfaces:

CordovaInterface

public class CordovaInterfaceImpl
extends java.lang.Object
implements CordovaInterface

Default implementation of CordovaInterface.

Field Summary

Fields

Modifier and Type	Field and Description
protected android.app.Activity	activity
protected CordovaPlugin	activityResultCallback
protected int	activityResultRequestCode
protected boolean	activityWasDestroyed
protected java.lang.String	initCallbackService
protected CallbackMap	permissionResultCallbacks
protected PluginManager	pluginManager
protected android.os.Bundle	savedPluginState
protected org.apache.cordova.CordovaInterfaceImpl.ActivityResultHolder	savedResult
protected java.util.concurrent.ExecutorService	threadPool

Constructor Summary

Constructors

Constructor and Description
CordovaInterfaceImpl(android.app.Activity activity)
CordovaInterfaceImpl(android.app.Activity activity, java.util.concurrent.ExecutorService threadPool)

Method Summary

Modifier and Type	Method and Description
android.app.Activity	getActivity() Get the Android activity.
java.util.concurrent.ExecutorService	getThreadPool() Returns a shared thread pool that can be used for background tasks.
boolean	hasPermission(java.lang.String permission) Check for a permission.
boolean	onActivityResult(int requestCode, int resultCode, android.content.Intent intent) Routes the result to the awaiting plugin.
void	onCordovaInit(PluginManager pluginManager) Dispatches any pending onActivityResult callbacks and sends the resume event if the Activity was destroyed by the OS.
java.lang.Object	onMessage(java.lang.String id, java.lang.Object data) Called when a message is sent to plugin.
void	onRequestPermissionResult(int requestCode, java.lang.String[] permissions, int[] grantResults) Called by the system when the user grants permissions
void	onSaveInstanceState(android.os.Bundle outState) Saves parameters for startActivityForResult().
void	requestPermission(CordovaPlugin plugin, int requestCode, java.lang.String permission) Sends a permission request to the activity for one permission.
void	requestPermissions(CordovaPlugin plugin, int requestCode, java.lang.String[] permissions) Sends a permission request to the activity for a group of permissions
void	restoreInstanceState(android.os.Bundle savedInstanceState) Call this from onCreate() so that any saved startActivityForResult parameters will be restored.
void	setActivityResultCallback(CordovaPlugin plugin) Set the plugin to be called when a sub-activity exits.
void	setActivityResultRequestCode(int requestCode) Call this from your startActivityForResult() overload.
void	startActivityForResult(CordovaPlugin command, android.content.Intent intent, int requestCode) Launch an activity for which you would like a result when it finished.

Methods inherited from class java.lang.Object

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

Field Detail

activity

protected android.app.Activity activity

threadPool

protected java.util.concurrent.ExecutorService threadPool

pluginManager

protected PluginManager pluginManager

savedResult

protected org.apache.cordova.CordovaInterfaceImpl.ActivityResultHolder savedResult

permissionResultCallbacks

protected CallbackMap permissionResultCallbacks

activityResultCallback

protected CordovaPlugin activityResultCallback

initCallbackService

protected java.lang.String initCallbackService

activityResultRequestCode

protected int activityResultRequestCode

activityWasDestroyed

protected boolean activityWasDestroyed

savedPluginState

protected android.os.Bundle savedPluginState

Constructor Detail

CordovaInterfaceImpl

public CordovaInterfaceImpl(android.app.Activity activity)

CordovaInterfaceImpl

public CordovaInterfaceImpl(android.app.Activity activity,
                            java.util.concurrent.ExecutorService threadPool)

Method Detail

startActivityForResult

public void startActivityForResult(CordovaPlugin command,
                                   android.content.Intent intent,
                                   int requestCode)

Description copied from interface: CordovaInterface

Launch an activity for which you would like a result when it finished. When this activity exits, your onActivityResult() method will be called.

Specified by:

startActivityForResult in interface CordovaInterface

Parameters:

command - The command object

intent - The intent to start

requestCode - The request code that is passed to callback to identify the activity

setActivityResultCallback

public void setActivityResultCallback(CordovaPlugin plugin)

Description copied from interface: CordovaInterface

Set the plugin to be called when a sub-activity exits.

Specified by:

setActivityResultCallback in interface CordovaInterface

Parameters:

plugin - The plugin on which onActivityResult is to be called

getActivity

public android.app.Activity getActivity()

Description copied from interface: CordovaInterface

Get the Android activity.

Specified by:

getActivity in interface CordovaInterface

Returns:

the Activity

onMessage

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

Description copied from interface: CordovaInterface

Called when a message is sent to plugin.

Specified by:

onMessage in interface CordovaInterface

Parameters:

id - The message id

data - The message data

Returns:

Object or null

getThreadPool

public java.util.concurrent.ExecutorService getThreadPool()

Description copied from interface: CordovaInterface

Returns a shared thread pool that can be used for background tasks.

Specified by:

getThreadPool in interface CordovaInterface

onCordovaInit

public void onCordovaInit(PluginManager pluginManager)

Dispatches any pending onActivityResult callbacks and sends the resume event if the Activity was destroyed by the OS.

onActivityResult

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

Routes the result to the awaiting plugin. Returns false if no plugin was waiting.

setActivityResultRequestCode

public void setActivityResultRequestCode(int requestCode)

Call this from your startActivityForResult() overload. This is required to catch the case where plugins use Activity.startActivityForResult() + CordovaInterface.setActivityResultCallback() rather than CordovaInterface.startActivityForResult().

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Saves parameters for startActivityForResult().

restoreInstanceState

public void restoreInstanceState(android.os.Bundle savedInstanceState)

Call this from onCreate() so that any saved startActivityForResult parameters will be restored.

onRequestPermissionResult

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

Called by the system when the user grants permissions

Parameters:

requestCode -

permissions -

grantResults -

Throws:

org.json.JSONException

requestPermission

public void requestPermission(CordovaPlugin plugin,
                              int requestCode,
                              java.lang.String permission)

Description copied from interface: CordovaInterface

Sends a permission request to the activity for one permission.

Specified by:

requestPermission in interface CordovaInterface

requestPermissions

public void requestPermissions(CordovaPlugin plugin,
                               int requestCode,
                               java.lang.String[] permissions)

Description copied from interface: CordovaInterface

Sends a permission request to the activity for a group of permissions

Specified by:

requestPermissions in interface CordovaInterface

hasPermission

public boolean hasPermission(java.lang.String permission)

Description copied from interface: CordovaInterface

Check for a permission. Returns true if the permission is granted, false otherwise.

Specified by:

hasPermission in interface CordovaInterface