Package 

Class BatchNotificationChannelsManager


  • 
    public final class BatchNotificationChannelsManager
    
                        

    BatchNotificationChannelsManager manages how Batch interacts with Android 8.0 (API 26). It allows you to control which default notification channel Batch will use, how it is named, or to provide your own channel per notification

    • Method Detail

      • setChannelNameProvider

         void setChannelNameProvider(@Nullable() BatchNotificationChannelsManager.ChannelNameProvider provider)

        Used to set a channel name provider, allowing you to change Batch's default channel name.

        This is the string that the user will see in their device settings, so you should translate it.Batch will call you back on your provider at least once, to get the channel name, and then willcall you on every locale change, to make sure that the Android OS has the right translation.

        If your provider throws an exception, Batch will use its default name.

        If you simply want to use a string resource, use setChannelName.

        Set to 'null' to remove the provider and use Batch's default one.

      • setChannelIdInterceptor

         void setChannelIdInterceptor(@Nullable() BatchNotificationChannelsManager.NotificationChannelIdInterceptor interceptor)

        Used to set a channel id interceptor, allowing you to override the Channel ID of a notification, per notification.You will be called on this interceptor before displaying notifications, unless you're in manual mode and don't use Batch to display the notification.

        The provider might be called on ANY API Level

        If your provider throws an exception, Batch will use its default name.

      • openSystemChannelSettings

         static boolean openSystemChannelSettings(@NonNull() Context context)

        Opens the notification channel settings system UI for Batch's default channel.

        Will do nothing on API < 26

        Parameters:
        context - Your context
      • openSystemChannelSettings

         static boolean openSystemChannelSettings(@NonNull() Context context, @NonNull() String channelId)

        Opens the notification channel settings system UI for the specified channel

        Will do nothing on API < 26

        Parameters:
        context - Your context.
        channelId - The channel to open this.