com.smarterapps.automateitplugin.sdk

Class PluginTrigger

java.lang.Object

com.smarterapps.automateitplugin.sdk.PluginTrigger

public abstract class PluginTrigger
extends java.lang.Object

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

See Also:

Trigger Sample, Download Sample

Constructor Summary

Constructors

Constructor and Description
PluginTrigger()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<RequiredApp>	getRequiredApps() This method should return a list of apps required to execute the trigger.
abstract java.lang.String	getTriggerDescription(android.content.Context context) Gets the default trigger description.
abstract java.lang.String	getTriggerDescription(android.content.Context context, PluginDataFieldCollection data) Gets the trigger description when parameters are set.
java.lang.String	getTriggerDescription(android.content.Context context, java.lang.String data) Do not use - for internal use only
abstract PluginDataFieldCollection	getTriggerFields(android.content.Context context) Gets the trigger parameters fields collection.
abstract int	getTriggerIconResourceId() Gets the trigger icon resource id.
protected long	getTriggerId()
abstract int	getTriggerSmallIconResourceId() Gets the trigger small icon resource id.
abstract java.lang.String	getTriggerTitle(android.content.Context context) Gets the trigger title.
void	launchTrigger() Call this method when the trigger event is set. When this method is called, it notifies AutomateIt that the trigger is set and it should launch its related 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 trigger requires initial setup before it can be used by AutomateIt.
void	startListening(android.content.Context context, long triggerId) Do not use - for internal use only
void	startListening(android.content.Context context, long triggerId, PluginDataFieldCollection data) Do not use - for internal use only
abstract void	startListening(android.content.Context context, PluginDataFieldCollection data) This method is called when the trigger should start waiting for execution.
abstract void	stopListening(android.content.Context context) This method is called when the trigger should stop waiting for execution.
abstract PluginValidationResult	validateData(android.content.Context context, PluginDataFieldCollection data) Validate the trigger 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

PluginTrigger

public PluginTrigger()

Method Detail

getTriggerTitle

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

Gets the trigger title. The trigger title is displayed within AutomateIt on the triggers 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 trigger title

getTriggerDescription

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

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

Parameters:

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

Returns:

The trigger default description

getTriggerDescription

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

Gets the trigger description when parameters are set. The trigger description is displayed within AutomateIt on the Edit Rule screen header when editing the trigger 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 trigger parameters

Returns:

The trigger description with the set parameters

getTriggerIconResourceId

public abstract int getTriggerIconResourceId()

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

Returns:

The trigger icon resource id

getTriggerSmallIconResourceId

public abstract int getTriggerSmallIconResourceId()

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

Returns:

The trigger icon resource id

getTriggerFields

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

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

Parameters:

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

Returns:

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

validateData

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

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

Parameters:

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

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

Returns:

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

getRequiredApps

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

This method should return a list of apps required to execute the trigger. 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 trigger

startListening

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

This method is called when the trigger should start waiting for execution. The method will be called in the following cases:

• Rule is created
• Rule is enabled
• Rule active period started

Usually, in this method you should start a service and wait for the trigger event to happen.

Parameters:

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

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

stopListening

public abstract void stopListening(android.content.Context context)

This method is called when the trigger should stop waiting for execution. The method will be called in the following cases:

• Rule is deleted
• Rule is disabled
• Rule active period ended

Usually, in this method you should stop your service and clear all related resources/listeners/receivers

Parameters:

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

requiresInitialSetup

public boolean requiresInitialSetup(android.content.Context context)

Override this method to indicate the plugin trigger requires initial setup before it can be used by AutomateIt. Additional setup might be required in case your trigger 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 trigger requires initial setup before the plugin trigger 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

launchTrigger

public final void launchTrigger()

Call this method when the trigger event is set.
When this method is called, it notifies AutomateIt that the trigger is set and it should launch its related action.

startListening

public final void startListening(android.content.Context context,
                                 long triggerId,
                                 PluginDataFieldCollection data)

Do not use - for internal use only

startListening

public final void startListening(android.content.Context context,
                                 long triggerId)

Do not use - for internal use only

getTriggerDescription

public final java.lang.String getTriggerDescription(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

getTriggerId

protected long getTriggerId()