change: Change method for customizing notification icon

Author: Dev-hwang

README.md

@@ -342,7 +342,7 @@ void initState() {
 * `serviceId`: The unique ID that identifies the service.
 * `notificationTitle`: The title to display in the notification.
 * `notificationText`: The text to display in the notification.
-* `notificationIcon`: The icon to display in the notification. (only work Android)
+* `notificationIcon`: The icon to display in the notification. Go to [this page](./documentation/customize_notification_icon.md) to customize.
 * `notificationButtons`: The buttons to display in the notification. (can add 0~3 buttons)
 * `callback`: A top-level function that calls the setTaskHandler function.
 

android/src/main/kotlin/com/pravera/flutter_foreground_task/PreferencesKey.kt

@@ -35,7 +35,7 @@ object PreferencesKey {
     // notification content
     const val NOTIFICATION_CONTENT_TITLE = "notificationContentTitle"
     const val NOTIFICATION_CONTENT_TEXT = "notificationContentText"
-    const val NOTIFICATION_CONTENT_ICON = "iconData"
+    const val NOTIFICATION_CONTENT_ICON = "icon"
     const val NOTIFICATION_CONTENT_BUTTONS = "buttons"
 
     // task options

android/src/main/kotlin/com/pravera/flutter_foreground_task/models/NotificationContent.kt

@@ -6,10 +6,10 @@ import org.json.JSONArray
 import org.json.JSONObject
 
 data class NotificationContent(
-    val title: String,
-    val text: String,
-    val icon: NotificationIconData?,
-    val buttons: List<NotificationButton>
+        val title: String,
+        val text: String,
+        val icon: NotificationIcon?,
+        val buttons: List<NotificationButton>
 ) {
     companion object {
         fun getData(context: Context): NotificationContent {
@@ -20,9 +20,9 @@ data class NotificationContent(
             val text = prefs.getString(PrefsKey.NOTIFICATION_CONTENT_TEXT, null) ?: ""
 
             val iconJsonString = prefs.getString(PrefsKey.NOTIFICATION_CONTENT_ICON, null)
-            var icon: NotificationIconData? = null
+            var icon: NotificationIcon? = null
             if (iconJsonString != null) {
-                icon = NotificationIconData.fromJsonString(iconJsonString)
+                icon = NotificationIcon.fromJsonString(iconJsonString)
             }
 
             val buttonsJsonString = prefs.getString(PrefsKey.NOTIFICATION_CONTENT_BUTTONS, null)

android/src/main/kotlin/com/pravera/flutter_foreground_task/models/NotificationIcon.kt

@@ -0,0 +1,34 @@
+package com.pravera.flutter_foreground_task.models
+
+import org.json.JSONObject
+
+data class NotificationIcon(
+    val metaDataName: String,
+    val backgroundColorRgb: String?
+) {
+    companion object {
+        private const val META_DATA_NAME_KEY = "metaDataName"
+        private const val BACKGROUND_COLOR_RGB_KEY = "backgroundColorRgb"
+
+        fun fromJsonString(jsonString: String): NotificationIcon {
+            val jsonObj = JSONObject(jsonString)
+
+            val metaDataName: String = if (jsonObj.isNull(META_DATA_NAME_KEY)) {
+                ""
+            } else {
+                jsonObj.getString(META_DATA_NAME_KEY)
+            }
+
+            val backgroundColorRgb: String? = if (jsonObj.isNull(BACKGROUND_COLOR_RGB_KEY)) {
+                null
+            } else {
+                jsonObj.getString(BACKGROUND_COLOR_RGB_KEY)
+            }
+
+            return NotificationIcon(
+                metaDataName = metaDataName,
+                backgroundColorRgb = backgroundColorRgb
+            )
+        }
+    }
+}

android/src/main/kotlin/com/pravera/flutter_foreground_task/models/NotificationIconData.kt

@@ -8,7 +8,6 @@ import android.content.pm.ServiceInfo
 import android.graphics.Color
 import android.net.wifi.WifiManager
 import android.os.*
-import android.os.Build
 import android.text.Spannable
 import android.text.SpannableString
 import android.text.style.ForegroundColorSpan
@@ -27,6 +26,7 @@ import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.update
 import java.util.*
 
+
 /**
  * A service class for implementing foreground service.
  *
@@ -288,9 +288,9 @@ class ForegroundService : Service() {
         val channelId = notificationOptions.channelId
 
         // notification icon
-        val iconData = notificationContent.icon
-        val iconBackgroundColor = iconData?.backgroundColorRgb?.let(::getRgbColor)
-        val iconResId = if (iconData != null) getIconResId(iconData) else getIconResId()
+        val icon = notificationContent.icon
+        val iconResId = getIconResId(icon)
+        val iconBackgroundColor = icon?.backgroundColorRgb?.let(::getRgbColor)
 
         // notification intent
         val pendingIntent = getPendingIntent()
@@ -445,37 +445,28 @@ class ForegroundService : Service() {
         foregroundTask = null
     }
 
-    private fun getIconResId(): Int {
-        return try {
-            val pm = applicationContext.packageManager
-            val appInfo =
-                pm.getApplicationInfo(applicationContext.packageName, PackageManager.GET_META_DATA)
-            appInfo.icon
-        } catch (e: Exception) {
-            Log.e(TAG, "getIconResId", e)
-            0
-        }
-    }
+    private fun getIconResId(icon: NotificationIcon?): Int {
+        try {
+            val packageManager = applicationContext.packageManager
+            val packageName = applicationContext.packageName
+            val appInfo = packageManager.getApplicationInfo(packageName, PackageManager.GET_META_DATA)
 
-    private fun getIconResId(iconData: NotificationIconData): Int {
-        val resType = iconData.resType
-        val resPrefix = iconData.resPrefix
-        val name = iconData.name
-        if (resType.isEmpty() || resPrefix.isEmpty() || name.isEmpty()) {
-            return 0
-        }
+            // application icon
+            if (icon == null) {
+                return appInfo.icon
+            }
 
-        val resName = if (resPrefix.contains("ic")) {
-            String.format("ic_%s", name)
-        } else {
-            String.format("img_%s", name)
-        }
+            // custom icon
+            val metaData = appInfo.metaData
+            if (metaData != null) {
+                return metaData.getInt(icon.metaDataName)
+            }
 
-        return applicationContext.resources.getIdentifier(
-            resName,
-            resType,
-            applicationContext.packageName
-        )
+            return 0
+        } catch (e: Exception) {
+            Log.e(TAG, "getIconResId($icon)", e)
+            return 0
+        }
     }
 
     private fun getPendingIntent(): PendingIntent {

android/src/main/kotlin/com/pravera/flutter_foreground_task/service/ForegroundService.kt

@@ -0,0 +1,54 @@
+Go to [`page`][1] and generate the notification icon.
+You can also use the [`image generator`][2] provided by Android Studio.
+
+Move the downloaded icon image file to the `android/app/src/res/drawable` folder.
+
+If successful, it will appear as shown in the image below:
+
+<img width="300" alt="image" src="https://github.com/user-attachments/assets/1ebe4750-def1-4387-a0ed-aeb8d4f483a4">
+
+Next, you need to add meta-data in the `AndroidManifest.xml` file so that the plugin can reference the icon resource.
+
+```xml
+<application>
+    <!-- Warning: Do not change service name. -->
+    <service
+        android:name="com.pravera.flutter_foreground_task.service.ForegroundService"
+        android:foregroundServiceType="dataSync"
+        android:exported="false" />
+
+    <!-- this -->
+    <meta-data
+        android:name="com.your_package.service.HEART_ICON"
+        android:resource="@drawable/ic_heart" />
+</application>
+```
+
+The name of the meta-data can be customized, but it is recommended to set it to a unique name combined with your package name.
+
+Finally, you can create a NotificationIcon object to change the notification icon when starting or updating the service.
+
+```dart
+void start() {
+  FlutterForegroundTask.startService(
+    notificationTitle: 'notificationTitle',
+    notificationText: 'notificationText',
+    notificationIcon: const NotificationIcon(
+      metaDataName: 'com.your_package.service.HEART_ICON',
+      backgroundColor: Colors.orange,
+    ),
+  );
+}
+
+void update() {
+  FlutterForegroundTask.updateService(
+    notificationIcon: const NotificationIcon(
+      metaDataName: 'com.your_package.service.HEART_ICON',
+      backgroundColor: Colors.purple,
+    ),
+  );
+}
+```
+
+[1]: https://romannurik.github.io/AndroidAssetStudio/icons-notification.html#source.type=clipart&source.clipart=ac_unit&source.space.trim=1&source.space.pad=0.15&name=ic_notification
+[2]: https://developer.android.com/studio/write/create-app-icons#create-notification

documentation/customize_notification_icon.md

@@ -49,33 +49,14 @@ A class that defines the action of onRepeatEvent in `TaskHandler`.
 | `once()`           | Call onRepeatEvent only once.                  |
 | `repeat(interval)` | Call onRepeatEvent at milliseconds `interval`. |
 
-### :chicken: NotificationIconData
+### :chicken: NotificationIcon
 
-Data for setting the notification icon.
+A data class for dynamically changing the notification icon.
 
-| Property    | Description                                                                                                                                                                                         |
-|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `resType`   | The resource type of the notification icon. If the resource is in the drawable folder, set it to `ResourceType.drawable`, if the resource is in the mipmap folder, set it to `ResourceType.mipmap`. |
-| `resPrefix` | The resource prefix of the notification icon. If the notification icon name is `ic_simple_notification`, set it to `ResourcePrefix.ic` and set `name` to `simple_notification`.                     |
-| `name`      | Notification icon name without prefix.                                                                                                                                                              |
-
-### :chicken: ResourceType
-
-The resource type of the notification icon.
-
-| Value      | Description                                                                                             |
-|------------|---------------------------------------------------------------------------------------------------------|
-| `drawable` | A resources in the drawable folder. The drawable folder is where all kinds of images are stored.        |
-| `mipmap`   | A resources in the mipmap folder. The mipmap folder is usually where the launcher icon image is stored. |
-
-### :chicken: ResourcePrefix
-
-The resource prefix of the notification icon.
-
-| Value | Description                         |
-|-------|-------------------------------------|
-| `ic`  | A resources with the `ic_` prefix.  |
-| `img` | A resources with the `img_` prefix. |
+| Property          | Description                                                                                    |
+|-------------------|------------------------------------------------------------------------------------------------|
+| `metaDataName`    | The name of the meta-data in the manifest that contains the drawable icon resource identifier. |
+| `backgroundColor` | The background color for the notification icon.                                                |
 
 ### :chicken: NotificationButton
 

documentation/models_documentation.md

@@ -46,6 +46,14 @@
             android:foregroundServiceType="dataSync|remoteMessaging"
             android:exported="false" />
 
+        <!-- Custom notification icon. -->
+        <meta-data
+            android:name="com.your_package.service.HOME_ICON"
+            android:resource="@drawable/ic_home" />
+        <meta-data
+            android:name="com.your_package.service.HEART_ICON"
+            android:resource="@drawable/ic_heart" />
+
         <!-- Don't delete the meta-data below.
              This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
         <meta-data