org.apache.cordova

Interface CordovaInterface

All Known Implementing Classes:

CordovaInterfaceImpl

public interface CordovaInterface

The Activity interface that is implemented by CordovaActivity. It is used to isolate plugin development, and remove dependency on entire Cordova library.

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.
java.lang.Object	onMessage(java.lang.String id, java.lang.Object data) Called when a message is sent to plugin.
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	setActivityResultCallback(CordovaPlugin plugin) Set the plugin to be called when a sub-activity exits.
void	startActivityForResult(CordovaPlugin command, android.content.Intent intent, int requestCode) Launch an activity for which you would like a result when it finished.

Method Detail

startActivityForResult

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

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

Parameters:

command - The command object

intent - The intent to start

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

setActivityResultCallback

void setActivityResultCallback(CordovaPlugin plugin)

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

Parameters:

plugin - The plugin on which onActivityResult is to be called

getActivity

android.app.Activity getActivity()

Get the Android activity.

Returns:

the Activity

onMessage

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

Called when a message is sent to plugin.

Parameters:

id - The message id

data - The message data

Returns:

Object or null

getThreadPool

java.util.concurrent.ExecutorService getThreadPool()

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

requestPermission

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

Sends a permission request to the activity for one permission.

requestPermissions

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

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

hasPermission

boolean hasPermission(java.lang.String permission)

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