com.salesforce.androidsdk.phonegap.plugin

Class ForcePlugin

java.lang.Object

CordovaPlugin

com.salesforce.androidsdk.phonegap.plugin.ForcePlugin

Direct Known Subclasses:

MobileSyncPlugin, SalesforceNetworkPlugin, SalesforceOAuthPlugin, SDKInfoPlugin, SFAccountManagerPlugin, SmartStorePlugin, TestRunnerPlugin

public abstract class ForcePlugin
extends CordovaPlugin

Abstract super class for all Salesforce plugins

Constructor Summary

Constructors

Constructor and Description
ForcePlugin()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	execute(java.lang.String actionStr, JavaScriptPluginVersion jsVersion, JSONArray args, CallbackContext callbackContext) Abstract method to concrete subclass need to implement
boolean	execute(java.lang.String action, JSONArray args, CallbackContext callbackContext) Executes the plugin request and returns PluginResult.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForcePlugin

public ForcePlugin()

Method Detail

execute

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

Executes the plugin request and returns PluginResult.

Parameters:

action - The action to exectute

args - JSONArray of arguments for the plugin (possibly starting with version)

callbackContext - Used when calling back into Javascript.

Returns:

A PluginResult object with a status and message.

Throws:

JSONException

execute

protected abstract boolean execute(java.lang.String actionStr,
                                   JavaScriptPluginVersion jsVersion,
                                   JSONArray args,
                                   CallbackContext callbackContext)
                            throws JSONException

Abstract method to concrete subclass need to implement

Parameters:

actionStr - The action to execute

args - JSONArray of arguments for the plugin.

callbackContext - Used when calling back into Javascript.

Returns:

Whether the action was valid.

Throws:

JSONException