From 24fd82d7736a34e5fb628a8a8e810d8d9dc93025 Mon Sep 17 00:00:00 2001 From: Taco Date: Thu, 26 Aug 2021 22:08:27 -0400 Subject: [PATCH] Use NotificationChannelCompat utilities (#5781) --- .../data/notification/Notifications.kt | 126 ++++++++---------- .../util/system/NotificationExtensions.kt | 38 ++++++ 2 files changed, 91 insertions(+), 73 deletions(-) create mode 100644 app/src/main/java/eu/kanade/tachiyomi/util/system/NotificationExtensions.kt diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt b/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt index 4a37b1243e..8999a93479 100644 --- a/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt +++ b/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt @@ -1,12 +1,13 @@ package eu.kanade.tachiyomi.data.notification -import android.app.NotificationChannel -import android.app.NotificationChannelGroup -import android.app.NotificationManager import android.content.Context -import android.os.Build +import androidx.core.app.NotificationManagerCompat +import androidx.core.app.NotificationManagerCompat.IMPORTANCE_DEFAULT +import androidx.core.app.NotificationManagerCompat.IMPORTANCE_HIGH +import androidx.core.app.NotificationManagerCompat.IMPORTANCE_LOW import eu.kanade.tachiyomi.R -import eu.kanade.tachiyomi.util.system.notificationManager +import eu.kanade.tachiyomi.util.system.buildNotificationChannel +import eu.kanade.tachiyomi.util.system.buildNotificationChannelGroup /** * Class to manage the basic information of all the notifications used in the app. @@ -81,94 +82,73 @@ object Notifications { /** * Creates the notification channels introduced in Android Oreo. + * This won't do anything on Android versions that don't support notification channels. * * @param context The application context. */ fun createChannels(context: Context) { - if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) return + val notificationService = NotificationManagerCompat.from(context) - listOf( - NotificationChannelGroup(GROUP_BACKUP_RESTORE, context.getString(R.string.group_backup_restore)), - NotificationChannelGroup(GROUP_DOWNLOADER, context.getString(R.string.group_downloader)) - ).forEach(context.notificationManager::createNotificationChannelGroup) + val channelGroupList = listOf( + buildNotificationChannelGroup(GROUP_BACKUP_RESTORE) { + setName(context.getString(R.string.group_backup_restore)) + }, + buildNotificationChannelGroup(GROUP_DOWNLOADER) { + setName(context.getString(R.string.group_downloader)) + } + ) + notificationService.createNotificationChannelGroupsCompat(channelGroupList) - listOf( - NotificationChannel( - CHANNEL_COMMON, - context.getString(R.string.channel_common), - NotificationManager.IMPORTANCE_LOW - ), - NotificationChannel( - CHANNEL_LIBRARY, - context.getString(R.string.channel_library), - NotificationManager.IMPORTANCE_LOW - ).apply { + val channelList = listOf( + buildNotificationChannel(CHANNEL_COMMON, IMPORTANCE_LOW) { + setName(context.getString(R.string.channel_common)) + }, + buildNotificationChannel(CHANNEL_LIBRARY, IMPORTANCE_LOW) { + setName(context.getString(R.string.channel_library)) setShowBadge(false) }, - NotificationChannel( - CHANNEL_DOWNLOADER_PROGRESS, - context.getString(R.string.channel_progress), - NotificationManager.IMPORTANCE_LOW - ).apply { - group = GROUP_DOWNLOADER + buildNotificationChannel(CHANNEL_DOWNLOADER_PROGRESS, IMPORTANCE_LOW) { + setName(context.getString(R.string.channel_progress)) + setGroup(GROUP_DOWNLOADER) setShowBadge(false) }, - NotificationChannel( - CHANNEL_DOWNLOADER_COMPLETE, - context.getString(R.string.channel_complete), - NotificationManager.IMPORTANCE_LOW - ).apply { - group = GROUP_DOWNLOADER + buildNotificationChannel(CHANNEL_DOWNLOADER_COMPLETE, IMPORTANCE_LOW) { + setName(context.getString(R.string.channel_complete)) + setGroup(GROUP_DOWNLOADER) setShowBadge(false) }, - NotificationChannel( - CHANNEL_DOWNLOADER_ERROR, - context.getString(R.string.channel_errors), - NotificationManager.IMPORTANCE_LOW - ).apply { - group = GROUP_DOWNLOADER + buildNotificationChannel(CHANNEL_DOWNLOADER_ERROR, IMPORTANCE_LOW) { + setName(context.getString(R.string.channel_errors)) + setGroup(GROUP_DOWNLOADER) setShowBadge(false) }, - NotificationChannel( - CHANNEL_NEW_CHAPTERS, - context.getString(R.string.channel_new_chapters), - NotificationManager.IMPORTANCE_DEFAULT - ), - NotificationChannel( - CHANNEL_UPDATES_TO_EXTS, - context.getString(R.string.channel_ext_updates), - NotificationManager.IMPORTANCE_DEFAULT - ), - NotificationChannel( - CHANNEL_BACKUP_RESTORE_PROGRESS, - context.getString(R.string.channel_progress), - NotificationManager.IMPORTANCE_LOW - ).apply { - group = GROUP_BACKUP_RESTORE + buildNotificationChannel(CHANNEL_NEW_CHAPTERS, IMPORTANCE_DEFAULT) { + setName(context.getString(R.string.channel_new_chapters)) + }, + buildNotificationChannel(CHANNEL_UPDATES_TO_EXTS, IMPORTANCE_DEFAULT) { + setName(context.getString(R.string.channel_ext_updates)) + }, + buildNotificationChannel(CHANNEL_BACKUP_RESTORE_PROGRESS, IMPORTANCE_LOW) { + setName(context.getString(R.string.channel_progress)) + setGroup(GROUP_BACKUP_RESTORE) setShowBadge(false) }, - NotificationChannel( - CHANNEL_BACKUP_RESTORE_COMPLETE, - context.getString(R.string.channel_complete), - NotificationManager.IMPORTANCE_HIGH - ).apply { - group = GROUP_BACKUP_RESTORE + buildNotificationChannel(CHANNEL_BACKUP_RESTORE_COMPLETE, IMPORTANCE_HIGH) { + setName(context.getString(R.string.channel_complete)) + setGroup(GROUP_BACKUP_RESTORE) setShowBadge(false) setSound(null, null) }, - NotificationChannel( - CHANNEL_CRASH_LOGS, - context.getString(R.string.channel_crash_logs), - NotificationManager.IMPORTANCE_HIGH - ), - NotificationChannel( - CHANNEL_INCOGNITO_MODE, - context.getString(R.string.pref_incognito_mode), - NotificationManager.IMPORTANCE_LOW - ) - ).forEach(context.notificationManager::createNotificationChannel) + buildNotificationChannel(CHANNEL_CRASH_LOGS, IMPORTANCE_HIGH) { + setName(context.getString(R.string.channel_crash_logs)) + }, + buildNotificationChannel(CHANNEL_INCOGNITO_MODE, IMPORTANCE_LOW) { + setName(context.getString(R.string.pref_incognito_mode)) + }, + ) + notificationService.createNotificationChannelsCompat(channelList) // Delete old notification channels - deprecatedChannels.forEach(context.notificationManager::deleteNotificationChannel) + deprecatedChannels.forEach(notificationService::deleteNotificationChannel) } } diff --git a/app/src/main/java/eu/kanade/tachiyomi/util/system/NotificationExtensions.kt b/app/src/main/java/eu/kanade/tachiyomi/util/system/NotificationExtensions.kt new file mode 100644 index 0000000000..9b44dbcdb2 --- /dev/null +++ b/app/src/main/java/eu/kanade/tachiyomi/util/system/NotificationExtensions.kt @@ -0,0 +1,38 @@ +package eu.kanade.tachiyomi.util.system + +import androidx.core.app.NotificationChannelCompat +import androidx.core.app.NotificationChannelGroupCompat + +/** + * Helper method to build a notification channel group. + * + * @param channelId the channel id. + * @param block the function that will execute inside the builder. + * @return a notification channel group to be displayed or updated. + */ +fun buildNotificationChannelGroup( + channelId: String, + block: (NotificationChannelGroupCompat.Builder.() -> Unit) +): NotificationChannelGroupCompat { + val builder = NotificationChannelGroupCompat.Builder(channelId) + builder.block() + return builder.build() +} + +/** + * Helper method to build a notification channel. + * + * @param channelId the channel id. + * @param channelImportance the channel importance. + * @param block the function that will execute inside the builder. + * @return a notification channel to be displayed or updated. + */ +fun buildNotificationChannel( + channelId: String, + channelImportance: Int, + block: (NotificationChannelCompat.Builder.() -> Unit) +): NotificationChannelCompat { + val builder = NotificationChannelCompat.Builder(channelId, channelImportance) + builder.block() + return builder.build() +}