Package com.batch.android.module

Class ActionModule

java.lang.Object

com.batch.android.module.BatchModule

com.batch.android.module.ActionModule

public class ActionModule
extends BatchModule

Batch's Action Module.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	RESERVED_ACTION_IDENTIFIER_PREFIX
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor	Description
ActionModule()

Method Summary

Modifier and Type	Method	Description
void	addDrawableAlias(java.lang.String alias, int drawableResID)	See Batch.Actions.addDrawableAlias(String, int)
int	getAliasedDrawableID(java.lang.String alias)
BatchDeeplinkInterceptor	getDeeplinkInterceptor()	Set the developer registered deeplink interceptor
int	getDrawableIdForNameOrAlias(android.content.Context context, java.lang.String drawableName)
java.lang.String	getId()	ID of the module
int	getState()	Should return the state of the module (usually 0 for deactivated, 1 for activated)
boolean	performAction(android.content.Context context, java.lang.String identifier, JSONObject args, UserActionSource source)	Perform the specified action.
boolean	performUserAction(android.content.Context context, java.lang.String identifier, JSONObject args)	Perform the specified action.
void	registerAction(UserAction userAction)	See Batch.Actions.register(UserAction)
void	setDeeplinkInterceptor(BatchDeeplinkInterceptor interceptor)	Get the developer registered deeplink interceptor
void	unregisterAction(java.lang.String identifier)	See Batch.Actions.unregister(String)

Methods inherited from class com.batch.android.module.BatchModule

batchDidStart, batchDidStop, batchIsFinishing, batchWillStart, batchWillStop

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

RESERVED_ACTION_IDENTIFIER_PREFIX

public static final java.lang.String RESERVED_ACTION_IDENTIFIER_PREFIX

See Also:

Constant Field Values

Constructor Detail

ActionModule

public ActionModule()

Method Detail

registerAction

public void registerAction(@NonNull
                           UserAction userAction)

See Batch.Actions.register(UserAction)

unregisterAction

public void unregisterAction(@NonNull
                             java.lang.String identifier)

See Batch.Actions.unregister(String)

addDrawableAlias

public void addDrawableAlias(@NonNull
                             java.lang.String alias,
                             @DrawableRes
                             int drawableResID)

See Batch.Actions.addDrawableAlias(String, int)

getAliasedDrawableID

@DrawableRes
public int getAliasedDrawableID(@NonNull
                                java.lang.String alias)

performUserAction

public boolean performUserAction(@Nullable
                                 android.content.Context context,
                                 @NonNull
                                 java.lang.String identifier,
                                 @Nullable
                                 JSONObject args)

Perform the specified action. Meant for the public SDK

Parameters:

context - Context, if any

identifier - Action identifier

args - Action arguments in JSON form

Returns:

true if an action was registered for this identifier and performed, false otherwise.

performAction

public boolean performAction(@Nullable
                             android.content.Context context,
                             @NonNull
                             java.lang.String identifier,
                             @NonNull
                             JSONObject args,
                             @Nullable
                             UserActionSource source)

Perform the specified action. Meant for the private SDK

Parameters:

context - Context, if any

identifier - Action identifier

args - Action arguments in JSON form

source - The action source

Returns:

true if an action was registered for this identifier and performed, false otherwise.

setDeeplinkInterceptor

public void setDeeplinkInterceptor(@Nullable
                                   BatchDeeplinkInterceptor interceptor)

Get the developer registered deeplink interceptor

getDeeplinkInterceptor

@Nullable
public BatchDeeplinkInterceptor getDeeplinkInterceptor()

Set the developer registered deeplink interceptor

getDrawableIdForNameOrAlias

public int getDrawableIdForNameOrAlias(@NonNull
                                       android.content.Context context,
                                       @Nullable
                                       java.lang.String drawableName)

getId

public java.lang.String getId()

Description copied from class: BatchModule

ID of the module

Specified by:

getId in class BatchModule

Returns:

getState

public int getState()

Description copied from class: BatchModule

Should return the state of the module (usually 0 for deactivated, 1 for activated)

Specified by:

getState in class BatchModule

Returns: