com.smarterapps.automateitplugin.sdk

Class PluginAction

java.lang.Object

com.smarterapps.automateitplugin.sdk.PluginAction

public abstract class PluginAction
extends java.lang.Object

This class is used as a super class for all actions included in the plugin. In order to implement a new action, you need to extend this class.

See Also:

Action Sample, Download Sample

Constructor Summary

Constructors

Constructor and Description
PluginAction()

Method Summary

Modifier and Type	Method and Description
abstract void	doAction(android.content.Context context, PluginDataFieldCollection data) Execute the plugin action.
abstract java.lang.String	getActionDescription(android.content.Context context) Gets the default action description.
abstract java.lang.String	getActionDescription(android.content.Context context, PluginDataFieldCollection data) Gets the action description when parameters are set.
java.lang.String	getActionDescription(android.content.Context context, java.lang.String data) Do not use - for internal use only
abstract PluginDataFieldCollection	getActionFields(android.content.Context context) Gets the action parameters fields collection.
abstract int	getActionIconResourceId() Gets the action icon resource id.
abstract int	getActionSmallIconResourceId() Gets the action small icon resource id.
abstract java.lang.String	getActionTitle(android.content.Context context) Gets the action title.
abstract java.util.List<RequiredApp>	getRequiredApps() This method should return a list of apps required to execute the action.
void	performInitialSetup(android.content.Context context) This method is called when requiresInitialSetup returns true.
boolean	requiresInitialSetup(android.content.Context context) Override this method to indicate the plugin action requires initial setup before it can be used by AutomateIt.
abstract PluginValidationResult	validateData(android.content.Context context, PluginDataFieldCollection data) Validate the action data.
PluginValidationResult	validateData(android.content.Context context, java.lang.String data) Do not use - for internal use only

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginAction

public PluginAction()

Method Detail

getActionTitle

public abstract java.lang.String getActionTitle(android.content.Context context)

Gets the action title. The action title is displayed within AutomateIt on the actions list and on the plugin main Activity

Parameters:

context - The context through which you can access the plugin resources through which you can access the plugin resources

Returns:

The action title

getActionDescription

public abstract java.lang.String getActionDescription(android.content.Context context)

Gets the default action description. The default action description is displayed within AutomateIt on the actions list and on the plugin main Activity

Parameters:

context - The context through which you can access the plugin resources

Returns:

The action default description

getActionDescription

public abstract java.lang.String getActionDescription(android.content.Context context,
                                                      PluginDataFieldCollection data)

Gets the action description when parameters are set. The action description is displayed within AutomateIt on the Edit Rule screen header when editing the action parameters, and on the My Rules/Rules Market screens when the rule details are shown

Parameters:

context - The context through which you can access the plugin resources

data - The action parameters

Returns:

The action description with the set parameters

getActionIconResourceId

public abstract int getActionIconResourceId()

Gets the action icon resource id. The icon is shown within AutomateIt and its size must be 48x48dp. If the icon size is incorrect, the action will not be available.
See more about icons and plugin graphics at AutomateIt Plugin UI guidelines

Returns:

The action icon resource id

getActionSmallIconResourceId

public abstract int getActionSmallIconResourceId()

Gets the action small icon resource id. The icon is shown within AutomateIt and its size must be 30x30dp. If the icon size is incorrect, the action will not be available.
See more about icons and plugin graphics at AutomateIt Plugin UI guidelines

Returns:

The action icon resource id

getActionFields

public abstract PluginDataFieldCollection getActionFields(android.content.Context context)

Gets the action parameters fields collection. The action fields are used to customize the action and allow the user to configure certain parameters required for the action execution.

Parameters:

context - The context through which you can access the plugin resources

Returns:

The action fields collection. If no fields are required for the action, return null.

validateData

public abstract PluginValidationResult validateData(android.content.Context context,
                                                    PluginDataFieldCollection data)

Validate the action data. Before saving rules within AutomateIt, validation is performed for the action. Validate the parameters set by the user and make sure they can safely be sent to doAction

Parameters:

context - The context through which you can access the plugin resources

data - The action parameters with values set by the user (If getActionFields is not null)

Returns:

The plugin validation result. If action is valid, return getValidResult

getRequiredApps

public abstract java.util.List<RequiredApp> getRequiredApps()

This method should return a list of apps required to execute the action. For instance, if you are building a plugin that relies on a certain functionality of a 3rd party app (such as AutomateIt Waze Plugin, you need to add an appropriate RequiredApp object to the return value. When the plugin main activity is shown, it will add an "Install" button for each required app, redirecting the user to the Play Store for downloading the app.

Returns:

The required apps, or null if no apps are required for the plugin action

doAction

public abstract void doAction(android.content.Context context,
                              PluginDataFieldCollection data)

Execute the plugin action. This is where the main logic of the action is implemented. You can access the action parameters using PluginDataFieldCollection.getFieldById(int) of the data parameter

Parameters:

context - The context through which you can access the plugin resources

data - The action parameters with values set by the user (If getActionFields is not null)

requiresInitialSetup

public boolean requiresInitialSetup(android.content.Context context)

Override this method to indicate the plugin action requires initial setup before it can be used by AutomateIt. Additional setup might be required in case your action has a one-time setup such as creating a database, login to remote service etc. If not overridden, returns false.

Parameters:

context - The context through which you can access the plugin resources

Returns:

True, if the action requires initial setup before the plugin action can be used

performInitialSetup

public void performInitialSetup(android.content.Context context)

This method is called when requiresInitialSetup returns true. Any initial setup logic should be implemented in this method.

Parameters:

context - The context through which you can access the plugin resources

getActionDescription

public final java.lang.String getActionDescription(android.content.Context context,
                                                   java.lang.String data)

Do not use - for internal use only

validateData

public final PluginValidationResult validateData(android.content.Context context,
                                                 java.lang.String data)

Do not use - for internal use only