Class DownloadNotificationHelper


  • public final class DownloadNotificationHelper
    extends Object
    Helper for creating download notifications.
    • Constructor Detail

      • DownloadNotificationHelper

        public DownloadNotificationHelper​(Context context,
                                          String channelId)
        Parameters:
        context - A context.
        channelId - The id of the notification channel to use.
    • Method Detail

      • buildProgressNotification

        public Notification buildProgressNotification​(Context context,
                                                      @DrawableRes
                                                      int smallIcon,
                                                      @Nullable
                                                      PendingIntent contentIntent,
                                                      @Nullable
                                                      String message,
                                                      List<Download> downloads,
                                                      @RequirementFlags
                                                      int notMetRequirements)
        Returns a progress notification for the given downloads.
        Parameters:
        context - A context.
        smallIcon - A small icon for the notification.
        contentIntent - An optional content intent to send when the notification is clicked.
        message - An optional message to display on the notification.
        downloads - The downloads.
        notMetRequirements - Any requirements for downloads that are not currently met.
        Returns:
        The notification.
      • buildDownloadCompletedNotification

        public Notification buildDownloadCompletedNotification​(Context context,
                                                               @DrawableRes
                                                               int smallIcon,
                                                               @Nullable
                                                               PendingIntent contentIntent,
                                                               @Nullable
                                                               String message)
        Returns a notification for a completed download.
        Parameters:
        context - A context.
        smallIcon - A small icon for the notifications.
        contentIntent - An optional content intent to send when the notification is clicked.
        message - An optional message to display on the notification.
        Returns:
        The notification.
      • buildDownloadFailedNotification

        public Notification buildDownloadFailedNotification​(Context context,
                                                            @DrawableRes
                                                            int smallIcon,
                                                            @Nullable
                                                            PendingIntent contentIntent,
                                                            @Nullable
                                                            String message)
        Returns a notification for a failed download.
        Parameters:
        context - A context.
        smallIcon - A small icon for the notifications.
        contentIntent - An optional content intent to send when the notification is clicked.
        message - An optional message to display on the notification.
        Returns:
        The notification.