Adding Notification Buttons

Adding buttons to push notifications is a great way to encourage users to engage with your messages by adding additional options that are relevant to the content being displayed. The Marigold SDK automatically creates several default button options for you to choose from, as well as allowing you to specify custom buttons you have set up in your app.

A guide to setting up custom buttons can be found here.

📘

Note

The default categories in the SDK are available from the following versions:
iOS - 9.0.0
Android - 10.0.0

Handling Actions

It's possible to add custom behaviour in your app when particular buttons are tapped.

iOS

The category and button selected will be passed back to the app in the UNUserNotificationCenterDelegate userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler: method. You can retrieve them from the UNNotificationResponse actionIdentifier field. Marigold default buttons are returned in the format <category_name>&<button_title>.

- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler {
    NSArray *components = [response.actionIdentifier componentsSeparatedByString:@"&"];
    if ([components count] == 2) {
        NSString *category = [components objectAtIndex:0];
        NSString *title = [components objectAtIndex:1];
        
        // Handle button tapped
    }
}

func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
    let components = response.actionIdentifier.components(separatedBy:"&")
    if (components.count == 2) {
      let category = components[0]
      let title = components[1]

      // Handle button tapped
    }
}

Android

You can add a NotificationActionTappedListener instance to the SDK which will be notified when the user taps an action.

new Marigold().addNotificationActionTappedListener(new NotificationActionTappedListener() {
    @Override
    public void onNotificationActionTapped(Context context, Bundle bundle, String title, String category, NotificationActionState actionState) {
      // handle button tapped
    }
});

SailthruMobile().addNotificationActionTappedListener { context, bundle, title, category, actionState ->  
    // handle button tapped
}

Default Categories

From version 9.0.0 of the iOS SDK and version 10.0.0 of the Android SDK, the following categories will be automatically created in the SDK. You can use these by choosing them from the dropdown, if available, or you can just send the category ID directly in the 'Custom Category ID' field.