Add notification progress support

README.md

@@ -367,6 +367,7 @@ void initState() {
 * `notificationTitle`: The title to display in the notification.
 * `notificationText`: The text to display in the notification.
 * `notificationIcon`: The icon to display in the notification. Go to [this page](./documentation/customize_notification_icon.md) to customize.
+* `notificationProgress`: The progress bar to display in the notification. Use `NotificationProgress.none()` to hide an existing progress bar.
 * `notificationButtons`: The buttons to display in the notification. (can add 0~3 buttons)
 * `notificationInitialRoute`: Initial route to be used when the app is launched via a notification. Works the same as the `launchApp` utility.
 * `callback`: A top-level function that calls the setTaskHandler function.
@@ -387,6 +388,7 @@ Future<ServiceRequestResult> _startService() async {
       notificationTitle: 'Foreground Service is running',
       notificationText: 'Tap to return to the app',
       notificationIcon: null,
+      notificationProgress: const NotificationProgress(max: 100, progress: 0),
       notificationButtons: [
         const NotificationButton(id: 'btn_hello', text: 'hello'),
       ],
@@ -443,6 +445,7 @@ class FirstTaskHandler extends TaskHandler {
     FlutterForegroundTask.updateService(
       notificationTitle: 'Hello FirstTaskHandler :)',
       notificationText: timestamp.toString(),
+      notificationProgress: NotificationProgress(max: 100, progress: _count),
     );
 
     // Send data to main isolate.

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

@@ -40,6 +40,7 @@ object PreferencesKey {
     const val NOTIFICATION_CONTENT_TITLE = "notificationContentTitle"
     const val NOTIFICATION_CONTENT_TEXT = "notificationContentText"
     const val NOTIFICATION_CONTENT_ICON = "icon"
+    const val NOTIFICATION_CONTENT_PROGRESS = "progress"
     const val NOTIFICATION_CONTENT_BUTTONS = "buttons"
     const val NOTIFICATION_INITIAL_ROUTE = "initialRoute"
 
@@ -57,4 +58,4 @@ object PreferencesKey {
 
   // task data
     const val CALLBACK_HANDLE = "callbackHandle"
-}
+}

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

@@ -9,6 +9,7 @@ data class NotificationContent(
         val title: String,
         val text: String,
         val icon: NotificationIcon?,
+        val progress: NotificationProgress?,
         val buttons: List<NotificationButton>,
         val initialRoute: String?
 ) {
@@ -26,6 +27,12 @@ data class NotificationContent(
                 icon = NotificationIcon.fromJsonString(iconJsonString)
             }
 
+            val progressJsonString = prefs.getString(PrefsKey.NOTIFICATION_CONTENT_PROGRESS, null)
+            var progress: NotificationProgress? = null
+            if (progressJsonString != null) {
+                progress = NotificationProgress.fromJsonString(progressJsonString)
+            }
+
             val buttonsJsonString = prefs.getString(PrefsKey.NOTIFICATION_CONTENT_BUTTONS, null)
             val buttons: MutableList<NotificationButton> = mutableListOf()
             if (buttonsJsonString != null) {
@@ -42,6 +49,7 @@ data class NotificationContent(
                 title = title,
                 text = text,
                 icon = icon,
+                progress = progress,
                 buttons = buttons,
                 initialRoute = initialRoute
             )
@@ -60,6 +68,12 @@ data class NotificationContent(
                 iconJsonString = JSONObject(iconJson).toString()
             }
 
+            val progressJson = map?.get(PrefsKey.NOTIFICATION_CONTENT_PROGRESS) as? Map<*, *>
+            var progressJsonString: String? = null
+            if (progressJson != null) {
+                progressJsonString = JSONObject(progressJson).toString()
+            }
+
             val buttonsJson = map?.get(PrefsKey.NOTIFICATION_CONTENT_BUTTONS) as? List<*>
             var buttonsJsonString: String? = null
             if (buttonsJson != null) {
@@ -72,6 +86,7 @@ data class NotificationContent(
                 putString(PrefsKey.NOTIFICATION_CONTENT_TITLE, title)
                 putString(PrefsKey.NOTIFICATION_CONTENT_TEXT, text)
                 putString(PrefsKey.NOTIFICATION_CONTENT_ICON, iconJsonString)
+                putString(PrefsKey.NOTIFICATION_CONTENT_PROGRESS, progressJsonString)
                 putString(PrefsKey.NOTIFICATION_CONTENT_BUTTONS, buttonsJsonString)
                 putString(PrefsKey.NOTIFICATION_INITIAL_ROUTE, initialRoute)
                 commit()
@@ -91,6 +106,12 @@ data class NotificationContent(
                 iconJsonString = JSONObject(iconJson).toString()
             }
 
+            val progressJson = map?.get(PrefsKey.NOTIFICATION_CONTENT_PROGRESS) as? Map<*, *>
+            var progressJsonString: String? = null
+            if (progressJson != null) {
+                progressJsonString = JSONObject(progressJson).toString()
+            }
+
             val buttonsJson = map?.get(PrefsKey.NOTIFICATION_CONTENT_BUTTONS) as? List<*>
             var buttonsJsonString: String? = null
             if (buttonsJson != null) {
@@ -103,6 +124,7 @@ data class NotificationContent(
                 title?.let { putString(PrefsKey.NOTIFICATION_CONTENT_TITLE, it) }
                 text?.let { putString(PrefsKey.NOTIFICATION_CONTENT_TEXT, it) }
                 iconJsonString?.let { putString(PrefsKey.NOTIFICATION_CONTENT_ICON, it) }
+                progressJsonString?.let { putString(PrefsKey.NOTIFICATION_CONTENT_PROGRESS, it) }
                 buttonsJsonString?.let { putString(PrefsKey.NOTIFICATION_CONTENT_BUTTONS, it) }
                 initialRoute?.let { putString(PrefsKey.NOTIFICATION_INITIAL_ROUTE, it) }
                 commit()
@@ -119,4 +141,4 @@ data class NotificationContent(
             }
         }
     }
-}
+}

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

@@ -0,0 +1,27 @@
+package com.pravera.flutter_foreground_task.models
+
+import org.json.JSONObject
+
+data class NotificationProgress(
+    val max: Int,
+    val progress: Int,
+    val indeterminate: Boolean,
+    val show: Boolean
+) {
+    companion object {
+        fun fromJsonString(jsonString: String): NotificationProgress {
+            val jsonObj = JSONObject(jsonString)
+            val max = jsonObj.optInt("max", 0)
+            val progress = jsonObj.optInt("progress", 0)
+            val indeterminate = jsonObj.optBoolean("indeterminate", false)
+            val show = jsonObj.optBoolean("show", max > 0 || indeterminate)
+
+            return NotificationProgress(
+                max = max.coerceAtLeast(0),
+                progress = progress.coerceIn(0, max.coerceAtLeast(0)),
+                indeterminate = indeterminate,
+                show = show
+            )
+        }
+    }
+}

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

@@ -362,6 +362,13 @@ class ForegroundService : Service() {
             builder.setContentTitle(notificationContent.title)
             builder.setContentText(notificationContent.text)
             builder.style = Notification.BigTextStyle()
+            notificationContent.progress?.let { progress ->
+                if (progress.show) {
+                    builder.setProgress(progress.max, progress.progress, progress.indeterminate)
+                } else {
+                    builder.setProgress(0, 0, false)
+                }
+            }
             builder.setVisibility(notificationOptions.visibility)
             builder.setOnlyAlertOnce(notificationOptions.onlyAlertOnce)
             if (iconBackgroundColor != null) {
@@ -389,6 +396,13 @@ class ForegroundService : Service() {
             builder.setContentTitle(notificationContent.title)
             builder.setContentText(notificationContent.text)
             builder.setStyle(NotificationCompat.BigTextStyle().bigText(notificationContent.text))
+            notificationContent.progress?.let { progress ->
+                if (progress.show) {
+                    builder.setProgress(progress.max, progress.progress, progress.indeterminate)
+                } else {
+                    builder.setProgress(0, 0, false)
+                }
+            }
             builder.setVisibility(notificationOptions.visibility)
             builder.setOnlyAlertOnce(notificationOptions.onlyAlertOnce)
             if (iconBackgroundColor != null) {
@@ -613,4 +627,4 @@ class ForegroundService : Service() {
 
         return actions
     }
-}
+}

example/lib/main.dart

@@ -23,11 +23,15 @@ class MyTaskHandler extends TaskHandler {
 
   void _incrementCount() {
     _count++;
+    final int progress = _count % 10;
 
     // Update notification content.
     FlutterForegroundTask.updateService(
       notificationTitle: 'Hello MyTaskHandler :)',
       notificationText: 'count: $_count',
+      notificationProgress: progress == 0
+          ? const NotificationProgress.none()
+          : NotificationProgress(max: 10, progress: progress),
     );
 
     // Send data to main isolate.
@@ -176,6 +180,7 @@ class _ExamplePageState extends State<ExamplePage> {
         notificationTitle: 'Foreground Service is running',
         notificationText: 'Tap to return to the app',
         notificationIcon: null,
+        notificationProgress: const NotificationProgress(max: 10, progress: 0),
         notificationButtons: [
           const NotificationButton(id: 'btn_hello', text: 'hello'),
         ],

lib/errors/service_already_started_exception.dart

@@ -1,6 +1,7 @@
 class ServiceAlreadyStartedException implements Exception {
-  ServiceAlreadyStartedException(
-      [this.message = 'The service has already started.']);
+  ServiceAlreadyStartedException([
+    this.message = 'The service has already started.',
+  ]);
 
   final String message;
 

lib/errors/service_not_initialized_exception.dart

@@ -1,7 +1,8 @@
 class ServiceNotInitializedException implements Exception {
-  ServiceNotInitializedException(
-      [this.message =
-          'Not initialized. Please call this function after calling the init function.']);
+  ServiceNotInitializedException([
+    this.message =
+        'Not initialized. Please call this function after calling the init function.',
+  ]);
 
   final String message;
 

lib/errors/service_timeout_exception.dart

@@ -1,7 +1,8 @@
 class ServiceTimeoutException implements Exception {
-  ServiceTimeoutException(
-      [this.message =
-          'The service request timed out. (ref: https://developer.android.com/guide/components/services#StartingAService)']);
+  ServiceTimeoutException([
+    this.message =
+        'The service request timed out. (ref: https://developer.android.com/guide/components/services#StartingAService)',
+  ]);
 
   final String message;
 

lib/flutter_foreground_task.dart

@@ -16,6 +16,7 @@ import 'models/notification_button.dart';
 import 'models/notification_icon.dart';
 import 'models/notification_options.dart';
 import 'models/notification_permission.dart';
+import 'models/notification_progress.dart';
 import 'models/service_request_result.dart';
 import 'task_handler.dart';
 import 'utils/utility.dart';
@@ -33,6 +34,7 @@ export 'models/notification_icon.dart';
 export 'models/notification_options.dart';
 export 'models/notification_permission.dart';
 export 'models/notification_priority.dart';
+export 'models/notification_progress.dart';
 export 'models/notification_visibility.dart';
 export 'models/service_request_result.dart';
 export 'ui/with_foreground_task.dart';
@@ -102,6 +104,7 @@ class FlutterForegroundTask {
     required String notificationTitle,
     required String notificationText,
     NotificationIcon? notificationIcon,
+    NotificationProgress? notificationProgress,
     List<NotificationButton>? notificationButtons,
     String? notificationInitialRoute,
     Function? callback,
@@ -124,6 +127,7 @@ class FlutterForegroundTask {
         notificationTitle: notificationTitle,
         notificationText: notificationText,
         notificationIcon: notificationIcon,
+        notificationProgress: notificationProgress,
         notificationButtons: notificationButtons,
         notificationInitialRoute: notificationInitialRoute,
         callback: callback,
@@ -160,6 +164,7 @@ class FlutterForegroundTask {
     String? notificationTitle,
     String? notificationText,
     NotificationIcon? notificationIcon,
+    NotificationProgress? notificationProgress,
     List<NotificationButton>? notificationButtons,
     String? notificationInitialRoute,
     Function? callback,
@@ -174,6 +179,7 @@ class FlutterForegroundTask {
         notificationText: notificationText,
         notificationTitle: notificationTitle,
         notificationIcon: notificationIcon,
+        notificationProgress: notificationProgress,
         notificationButtons: notificationButtons,
         notificationInitialRoute: notificationInitialRoute,
         callback: callback,

lib/flutter_foreground_task_method_channel.dart

@@ -14,18 +14,21 @@ import 'models/notification_button.dart';
 import 'models/notification_icon.dart';
 import 'models/notification_options.dart';
 import 'models/notification_permission.dart';
+import 'models/notification_progress.dart';
 import 'models/service_options.dart';
 import 'task_handler.dart';
 
 /// An implementation of [FlutterForegroundTaskPlatform] that uses method channels.
 class MethodChannelFlutterForegroundTask extends FlutterForegroundTaskPlatform {
   @visibleForTesting
-  final MethodChannel mMDChannel =
-      const MethodChannel('flutter_foreground_task/methods');
+  final MethodChannel mMDChannel = const MethodChannel(
+    'flutter_foreground_task/methods',
+  );
 
   @visibleForTesting
-  final MethodChannel mBGChannel =
-      const MethodChannel('flutter_foreground_task/background');
+  final MethodChannel mBGChannel = const MethodChannel(
+    'flutter_foreground_task/background',
+  );
 
   @visibleForTesting
   Platform platform = const LocalPlatform();
@@ -42,6 +45,7 @@ class MethodChannelFlutterForegroundTask extends FlutterForegroundTaskPlatform {
     required String notificationTitle,
     required String notificationText,
     NotificationIcon? notificationIcon,
+    NotificationProgress? notificationProgress,
     List<NotificationButton>? notificationButtons,
     String? notificationInitialRoute,
     Function? callback,
@@ -55,6 +59,7 @@ class MethodChannelFlutterForegroundTask extends FlutterForegroundTaskPlatform {
       notificationContentTitle: notificationTitle,
       notificationContentText: notificationText,
       notificationIcon: notificationIcon,
+      notificationProgress: notificationProgress,
       notificationButtons: notificationButtons,
       notificationInitialRoute: notificationInitialRoute,
       callback: callback,
@@ -74,6 +79,7 @@ class MethodChannelFlutterForegroundTask extends FlutterForegroundTaskPlatform {
     String? notificationTitle,
     String? notificationText,
     NotificationIcon? notificationIcon,
+    NotificationProgress? notificationProgress,
     List<NotificationButton>? notificationButtons,
     String? notificationInitialRoute,
     Function? callback,
@@ -83,6 +89,7 @@ class MethodChannelFlutterForegroundTask extends FlutterForegroundTaskPlatform {
       notificationContentTitle: notificationTitle,
       notificationContentText: notificationText,
       notificationIcon: notificationIcon,
+      notificationProgress: notificationProgress,
       notificationButtons: notificationButtons,
       notificationInitialRoute: notificationInitialRoute,
       callback: callback,
@@ -214,8 +221,9 @@ class MethodChannelFlutterForegroundTask extends FlutterForegroundTaskPlatform {
   @override
   Future<bool> openIgnoreBatteryOptimizationSettings() async {
     if (platform.isAndroid) {
-      return await mMDChannel
-          .invokeMethod('openIgnoreBatteryOptimizationSettings');
+      return await mMDChannel.invokeMethod(
+        'openIgnoreBatteryOptimizationSettings',
+      );
     }
     return true;
   }
@@ -246,15 +254,17 @@ class MethodChannelFlutterForegroundTask extends FlutterForegroundTaskPlatform {
 
   @override
   Future<NotificationPermission> checkNotificationPermission() async {
-    final int result =
-        await mMDChannel.invokeMethod('checkNotificationPermission');
+    final int result = await mMDChannel.invokeMethod(
+      'checkNotificationPermission',
+    );
     return NotificationPermission.fromIndex(result);
   }
 
   @override
   Future<NotificationPermission> requestNotificationPermission() async {
-    final int result =
-        await mMDChannel.invokeMethod('requestNotificationPermission');
+    final int result = await mMDChannel.invokeMethod(
+      'requestNotificationPermission',
+    );
     return NotificationPermission.fromIndex(result);
   }