Custom actions

Batch Actions is a module allowing you to register remotely-configurable runnable code to the SDK, when simple deeplinks wouldn't be enough. They can be triggered at any time by the SDK, allowing you to focus on the action code rather than when to trigger it.

Batch comes with builtin actions (deeplinking, user data edition, etc...)

Note: On iOS, actions are mainly used for mobile landings, but their usage will be extended in future Batch versions.

Registering an action

An action has two components:

  • An identifier (case-unsensitive string), which will allow you to reference this action

    • While the identifier string is up to you, it cannot start with "batch.": these identifiers are reserved for built-in actions.
  • An implementation block

Registering them is easy, and should be done every time your app starts, right before starting Batch:

  • Objective-C
  • Swift
BatchUserActionBlock alertActionBlock = ^(NSString * _Nonnull identifier, NSDictionary<NSString *,NSObject *> * _Nonnull arguments, id<BatchUserActionSource>  _Nullable source) {
    // Your action code here
};
[BatchActions registerAction:[BatchUserAction userActionWithIdentifier:@"<YOUR_ACTION_NAME>"
                                                           actionBlock:alertActionBlock]];

The source argument represents what caused the action to be triggered. You can use isKindOfClass (or a swift cast using as?) to check what source it comes from, and read what you need.
Two sources classes are currently used: BatchPushMessage and BatchManualUserActionSource. More will be added in the future.

Unregistering an action

Simply call the unregister method with the previously set identifier:

  • Objective-C
  • Swift
[BatchActions unregisterActionIdentifier:@"<YOUR_ACTION_NAME>"];

Triggering an action

You might want to re-use the code you've already registered to Batch from your own code by triggering an action.

Simply give Batch the action identifier and arguments, and it will call your action:

  • Objective-C
  • Swift
[BatchActions performActionIdentifiedBy:@"alert" withArguments:@{@"title":@"Hello", @"body":@"How are you doing?"}];

Note: Built-in Batch actions are reserved to the SDK and not triggerable that way

Built-in actions

Batch provide a set of pre-defined actions, allowing you to easily trigger a specific behavior without implementing them yourself.

IdentifierDescriptionArguments
batch.dismissSimply dismiss the notification and exitN/A
batch.deeplinkOpen the provided deeplink (will call the DeeplinkInterceptor if one is set)Object - Required
lString - Required
The deeplink to open
E.g.{"l":"https://google.com"}
liBoolean - Optional - Default false
If true the Batch SDK will try to open your deeplink inside the app
E.g.{"li":false}
batch.ios_request_notificationsShow the notification permissions pop-upN/A
batch.ios_redirect_settingsOpen the notifications settings of the current applicationN/A
batch.ios_smart_reoptinChecks if the user has already been asked for notifications, if not it shows the notification permissions pop-up, otherwise it opens the notifications settings of the current applicationN/A
batch.user.tagAdd or remove a tag associated with the current userObject - Required
aString - Required
The action to perform.
Acceptable values are add and remove

E.g.{"a":"remove"}
cString - Required
The collection to use when updating the tag
E.g.{"c":"actions"}
tString - Required
The tag to update
E.g.{"t":"has_bought"}
batch.groupExecute a list of up to 10 nested actions successivelyObject - Required
actionsArray - Required
A list of actions to perform. This list must not be longer than 10 elements and can't contains batch.group actions
E.g.{"actions":[["batch.deeplink",{"l":"https://google.com"}],["batch.user.tag",{"add":"..."}]]}