org.apache.cordova

Class CoreAndroid

java.lang.Object

org.apache.cordova.CordovaPlugin

org.apache.cordova.CoreAndroid

public class CoreAndroid
extends CordovaPlugin

This classes exposes methods in Cordova that can be called from JavaScript.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_NAME
protected static java.lang.String	TAG

Fields inherited from class org.apache.cordova.CordovaPlugin

cordova, preferences, webView

Constructor Summary

Constructors

Constructor and Description
CoreAndroid()

Method Summary

Modifier and Type	Method and Description
void	backHistory() Go to previous page displayed.
void	clearCache() Clear the resource cache.
void	clearHistory() Clear page history for the app.
boolean	execute(java.lang.String action, org.json.JSONArray args, CallbackContext callbackContext) Executes the request and returns PluginResult.
void	exitApp() Exit the Android application.
void	fireJavascriptEvent(java.lang.String action) Send an event to be fired on the Javascript side.
static java.lang.Object	getBuildConfigValue(android.content.Context ctx, java.lang.String key)
boolean	isBackbuttonOverridden() Return whether the Android back button is overridden by the user.
void	loadUrl(java.lang.String url, org.json.JSONObject props) Load the url into the webview.
void	onDestroy() The final call you receive before your activity is destroyed.
void	overrideBackbutton(boolean override) Override the default behavior of the Android back button.
void	overrideButton(java.lang.String button, boolean override) Override the default behavior of the Android volume buttons.
void	pluginInitialize() Sets the context of the Command.
void	sendResumeEvent(PluginResult resumeEvent) Used to send the resume event in the case that the Activity is destroyed by the OS

Methods inherited from class org.apache.cordova.CordovaPlugin

execute, execute, fromPluginUri, getServiceName, handleOpenForRead, hasPermisssion, initialize, onActivityResult, onConfigurationChanged, onMessage, onNewIntent, onOverrideUrlLoading, onPause, onReceivedClientCertRequest, onReceivedHttpAuthRequest, onRequestPermissionResult, onReset, onRestoreStateForActivityResult, onResume, onSaveInstanceState, onStart, onStop, 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

PLUGIN_NAME

public static final java.lang.String PLUGIN_NAME

See Also:

Constant Field Values

TAG

protected static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

CoreAndroid

public CoreAndroid()

Method Detail

fireJavascriptEvent

public void fireJavascriptEvent(java.lang.String action)

Send an event to be fired on the Javascript side.

Parameters:

action - The name of the event to be fired

pluginInitialize

public void pluginInitialize()

Sets the context of the Command. This can then be used to do things like get file paths associated with the Activity.

Overrides:

pluginInitialize in class CordovaPlugin

execute

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

Executes the request and returns PluginResult.

Overrides:

execute in class CordovaPlugin

Parameters:

action - The action to execute.

args - JSONArry of arguments for the plugin.

callbackContext - The callback context from which we were invoked.

Returns:

A PluginResult object with a status and message.

Throws:

org.json.JSONException

clearCache

public void clearCache()

Clear the resource cache.

loadUrl

public void loadUrl(java.lang.String url,
                    org.json.JSONObject props)
             throws org.json.JSONException

Load the url into the webview.

Parameters:

url -

props - Properties that can be passed in to the Cordova activity (i.e. loadingDialog, wait, ...)

Throws:

org.json.JSONException

clearHistory

public void clearHistory()

Clear page history for the app.

backHistory

public void backHistory()

Go to previous page displayed. This is the same as pressing the backbutton on Android device.

overrideBackbutton

public void overrideBackbutton(boolean override)

Override the default behavior of the Android back button. If overridden, when the back button is pressed, the "backKeyDown" JavaScript event will be fired.

Parameters:

override - T=override, F=cancel override

overrideButton

public void overrideButton(java.lang.String button,
                           boolean override)

Override the default behavior of the Android volume buttons. If overridden, when the volume button is pressed, the "volume[up|down]button" JavaScript event will be fired.

Parameters:

button - volumeup, volumedown

override - T=override, F=cancel override

isBackbuttonOverridden

public boolean isBackbuttonOverridden()

Return whether the Android back button is overridden by the user.

Returns:

boolean

exitApp

public void exitApp()

Exit the Android application.

onDestroy

public void onDestroy()

Description copied from class: CordovaPlugin

The final call you receive before your activity is destroyed.

Overrides:

onDestroy in class CordovaPlugin

sendResumeEvent

public void sendResumeEvent(PluginResult resumeEvent)

Used to send the resume event in the case that the Activity is destroyed by the OS

Parameters:

resumeEvent - PluginResult containing the payload for the resume event to be fired

getBuildConfigValue

public static java.lang.Object getBuildConfigValue(android.content.Context ctx,
                                                   java.lang.String key)