Android > Advanced

Customizing notifications

Setting up custom push icons

Overview

Android lets you customise the way your notifications look:

  1. Small icon: Required - App icon displayed in your notifications. The small icon must be opaque white, otherwise Android will display a white square.
  2. Accent color: Optional - Color is used by to color your small icon / app name. Android will use a grey accent icolor if you don't set one.
  3. Large icon: Optional - Use it to add contextual information to your message. You shouldn't use it to display your app icon.

Android push anatomy

Small icon

The small icon allows users to recognize your app when they receive a push. It should be opaque white, using only the alpha channel and 24x24dp as mentioned in Google documentation. You can easily create one using the Android Assets Studio.

Small icon samples

If you use a colored small icon, Android will display it as a white square:

Small icon issue

Here's how to set it to Batch push:

public class YourApp extends Application
{
    @Override
    public void onCreate()
    {
        super.onCreate();

        Batch.setConfig(new Config(YOUR_BATCH_API_KEY));

        Batch.Push.setGCMSenderId("YOUR-GCM-SENDER-ID");
        Batch.Push.setSmallIconResourceId(R.drawable.push_icon);
    }
}

Accent color

Google allows you to set an accent color for your push notifications. If you don't set a custom accent color, Android will use a grey accent color.

Accent color

Here is how to customise that color:

public class YourApp extends Application
{
    @Override
    public void onCreate()
    {
        ...

        Batch.Push.setNotificationsColor(0xFF00FF00); // You should pass an aRGB integer
    }
}

Large icon

The large icon is optional. You can use it to add contextual information to your notification (e.g. an avatar, etc). You shouldn't use the large icon to display the icon of the app. Here is how it looks:

Large icon sample

Here's how to set a custom large icon to Batch push:

public class YourApp extends Application
{
    @Override
    public void onCreate()
    {
        super.onCreate();

        Batch.setConfig(new Config(YOUR_BATCH_API_KEY));

        Batch.Push.setGCMSenderId("your_gcm_sender_id");
        Batch.Push.setSmallIconResourceId(R.drawable.push_icon);
        Batch.Push.setLargeIcon(BitmapFactory.decodeResource(getResources(),
                R.drawable.large_push_icon));
    }
}

Sending silent notifications

Silent push notifications allow you wake up the app to run actions for a limited amount of time without notifying the user.

Here is the key you need to add to your payload to send silent notifications:

{"msg": null}

Please note that this will work out of the box with Batch’s default receiver. In case you are using a custom receiver, ensure you don’t display any notification when a null value is received for the “msg” parameter.

Setting notification default sound

Starting with Batch 1.8, you can now override the default sound that will be played when showing a notification.
To do so, simply provide an Uri to Batch. Accepted Uris are the same as the framework's Notification.Builder.setSound

public class YourApp extends Application
{
    @Override
    public void onCreate()
    {
        ...

        Batch.Push.setSound(RingtoneManager.getDefaultUri(RingtoneManager.TYPE_ALARM));
    }
}

Managing notification display

You can restrict notification display on Android with several parameters such as disabling sound, vibration, or simply disabling notifications for that user if you have a way to ask for opt-in.

Batch Push provides you with an enum with the interactions a notification can have via: PushNotificationType. This enum contains ALERT, SOUND, LIGHTS and VIBRATE. By default, everything is activated.

Disabling notifications

EnumSet<PushNotificationType> set = EnumSet.of(PushNotificationType.NONE); // Disable all notifications

Batch.Push.setNotificationsType(set);

You can call Batch.Push.setNotificationsType whenever you want in the runtime of your application.

Disabling sound

EnumSet<PushNotificationType> set = EnumSet.allOf(PushNotificationType.class);
        set.remove(PushNotificationType.SOUND); // Disable only sound

Batch.Push.setNotificationsType(set);

Please keep in mind that once you've set notification type within Batch, you have to set it again to change it.

Reading a push's payload from your activity

A push's custom payload can be read from multiple places:

  • A Notification Interceptor, to be able to enhance the notification using custom payload values
  • Your own BroadcastReceiver implementation, to be able to act on a push and take full control of what happens when you get one
  • An Activity, allowing your code to act upon the payload without having to make your own PendingIntent

Most of the time, reading it from the activity is what you're looking for.

If integrated correctly, Batch will attach the full payload to the extras of triggered intent. Depending on your Activity's flags and the current application state, you might get the intent in onCreate() or onNewIntent()

Here's an example of how to read the following custom payload: {"foo": "bar"}

public class MyActivity extends Activity
{
  @Override
  public void onCreate(Bundle savedInstanceState) {
    [...]
    handleBatchCustomPayload(getIntent());
  }

  @Override
  public void onNewIntent(Intent newIntent) {
    super.onNewIntent(newIntent);
    Batch.onNewIntent(this, newIntent);
    handleBatchCustomPayload(newIntent);
  }

  public void handleBatchCustomPayload(Intent intent) {
    Bundle pushPayload = intent.getBundleExtra(Batch.Push.PAYLOAD_KEY);
    if (pushPayload != null) {
      // The activity was opened from a Batch push notification, and may include a custom payload
      // You might wanna mark the intent as consumed so that you don't handle it multiple times.
      // If this extra is missing but you, please check that your integration is correct, and that
      // nothing is missing in your NotificationInterceptor/BroadcastReceiver implementation

      // Custom payload values are available as string extras. No other types are supported by FCM.
      // Values that are of complex types, like a JSON object or Array, will have to be decoded using a json library

      String foo = pushPayload.getStringExtra("foo"); // foo = "bar"
    }
  }
}

Advanced notification customization

Sometimes, you might want to alter and/or enhance the way Batch builds the notification, or override other fields based on the notification payload.
Starting with Batch 1.9.2, Batch includes a notification interception system so you don't have to make your own notification from scratch.

First, you will need to extend the BatchNotificationInterceptor class. It has two methods you can override to tweak notifications:

  • getPushNotificationCompatBuilder gives you full access the the NotificationCompat.Builder. This method is called after Batch is done setting everything up in the builder you get in a parameter. You can add your own customizations to it, or return a totally different builder.
  • getPushNotificationId lets you change the Notification ID. This is handy to turn the ID into a non unique one, allowing notifications to be updated (such as a sports game score update, for example).

Then you can either use this interceptor in a Batch.Push.displayNotification() call in a custom receiver, or set it globally using Batch.Push.setNotificationInterceptor() in your Application's onCreate().

Note: Like other setup methods, it is VERY important that you set the global interceptor in the Application's onCreate() and not the Activity's.

Example interceptor implementation:

public class NotificationInterceptor extends BatchNotificationInterceptor
{
  @Nullable
  @Override
  public NotificationCompat.Builder getPushNotificationCompatBuilder(@NonNull Context context,
                                                                     @NonNull NotificationCompat.Builder defaultBuilder,
                                                                     @NonNull Bundle pushIntentExtras,
                                                                     int notificationId)
  {
    defaultBuilder.setOngoing(true);
    return defaultBuilder;
  }
}

All that is left to do, is to globally register the interceptor:

public class MyApplication extends Application
{
  @Override
  public void onCreate()
  {
    super.onCreate();

    Batch.Push.setNotificationInterceptor(new NotificationInterceptor());

    // Other Batch configuration ...
  }
}

Note: Batch sets some default values on the Notification builder that cannot be overridden later. If you run into such a case, please contact us, so we can take this into account for future SDK improvements.

Adding actions to notifications

By combining Batch Actions and BatchNotificationInterceptor, you can easily add action buttons to notifications based on your custom payload: BatchNotificationAction comes with an helper method allowing you to generate NotificationCompat.Action easily without needing to worry about PendingIntents or services.

Here's an example of BatchNotificationInterceptor implementation that adds a "Call" button for the following custom payload: {"phoneCTA": "123456789"}

public class NotificationInterceptor extends BatchNotificationInterceptor
{
    @Nullable
    @Override
    public NotificationCompat.Builder getPushNotificationCompatBuilder(@NonNull Context context,
                                                                       @NonNull NotificationCompat.Builder defaultBuilder,
                                                                       @NonNull Bundle pushIntentExtras,
                                                                       int notificationId)
    {
        final String phoneNumber = pushIntentExtras.getString("phoneCTA");
        if (phoneNumber != null) {
            try {
                JSONObject jsonArgs = new JSONObject();
                jsonArgs.put("number", phoneNumber);

                BatchNotificationAction notificationAction = new BatchNotificationAction();
                notificationAction.shouldDismissNotification = false;
                notificationAction.actionIdentifier = "CALL";
                notificationAction.label = "Call";
                notificationAction.actionArguments = jsonArgs;

                List<BatchNotificationAction> notificationActions = new ArrayList<>(1);
                notificationActions.add(notificationAction);

                List<NotificationCompat.Action> compatActions = BatchNotificationAction.getSupportActions(
                        context,
                        notificationActions,
                        BatchPushPayload.payloadFromReceiverExtras(pushIntentExtras),
                        notificationId);

                for (NotificationCompat.Action compatAction : compatActions) {
                    defaultBuilder.addAction(compatAction);
                }
            } catch (JSONException | MissingDependencyException | BatchPushPayload.ParsingException e) {
                e.printStackTrace();
            }

        }

        return defaultBuilder;
    }
}

This interceptor assumes that you've registered the CALL action to Batch earlier:


public class MyApplication extends Application
{
  @Override
  public void onCreate()
  {
    super.onCreate();  
    Batch.Push.setNotificationInterceptor(new NotificationInterceptor());
    Batch.Actions.register(new UserAction("CALL", new UserActionRunnable()
    {
      @Override
      public void performAction(@Nullable Context context,
                                @NonNull String identifier,
                                @NonNull JSONObject args,
                                @Nullable UserActionSource source)
      {
        try {
          Intent callIntent = new Intent(Intent.ACTION_DIAL);
          callIntent.setData(Uri.parse("tel:" + Uri.encode(args.getString("number"))));
          callIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
          startActivity(callIntent);
        } catch (JSONException e) {
          e.printStackTrace();
          Toast.makeText(context, "Could not execute CALL action", Toast.LENGTH_SHORT).show();
        }
      }
    }));
    // Other Batch configuration ...
  }  
}

Changing the notification's launch intent

You might also want the notification to launch another intent that the one picked by Batch. Starting with Batch 1.10.2, you can easily generate a valid PendingIntent containing Batch's required extras, or append Batch's data to your own pending intent:

public class NotificationInterceptor extends BatchNotificationInterceptor
{
    @Nullable
    @Override
    public NotificationCompat.Builder getPushNotificationCompatBuilder(@NonNull Context context,
                                                                       @NonNull NotificationCompat.Builder defaultBuilder,
                                                                       @NonNull Bundle pushIntentExtras,
                                                                       int notificationId)
    {
        // Automatically make a PendingIntent from a given intent
        defaultBuilder.setContentIntent(Batch.Push.makePendingIntent(context, new Intent(context, MySecondaryActivity.class), pushIntentExtras));

        // Get a PendingIntent for an URL
        defaultBuilder.setContentIntent(Batch.Push.makePendingIntentForDeeplink(context, "https://batch.com", pushIntentExtras));

        // Or, bring your own PendingIntent, and add Batch's data
        Intent i = new Intent(context, MySecondaryActivity.class);
        Batch.Push.appendBatchData(pushIntentExtras, i);
        PendingIntent pi = PendingIntent.getActivity([...]); // Generate your own PendingIntent
        defaultBuilder.setContentIntent(pi);

        return defaultBuilder;
    }
}