[windows] Add closeReason in onLocalNotificationClose event #6

Author: lijy91

example/lib/pages/home.dart

@@ -33,8 +33,8 @@ class _HomePageState extends State<HomePage> {
     _exampleNotification?.onShow = () {
       print('onShow ${_exampleNotification?.identifier}');
     };
-    _exampleNotification?.onClose = () {
-      print('onClose ${_exampleNotification?.identifier}');
+    _exampleNotification?.onClose = (closeReason) {
+      print('onClose ${_exampleNotification?.identifier} - $closeReason');
     };
     _exampleNotification?.onClick = () {
       print('onClick ${_exampleNotification?.identifier}');
@@ -53,8 +53,8 @@ class _HomePageState extends State<HomePage> {
     notification.onShow = () {
       print('onShow ${notification.identifier}');
     };
-    notification.onClose = () {
-      print('onClose ${notification.identifier}');
+    notification.onClose = (closeReason) {
+      print('onClose ${notification.identifier} - $closeReason');
     };
     notification.onClick = () {
       print('onClick ${notification.identifier}');

lib/local_notifier.dart

@@ -1,4 +1,5 @@
 export 'src/local_notification_action.dart';
+export 'src/local_notification_close_reason.dart';
 export 'src/local_notification_listener.dart';
 export 'src/local_notification.dart';
 export 'src/local_notifier.dart';

lib/src/local_notification.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:uuid/uuid.dart';
 
 import 'local_notification_action.dart';
+import 'local_notification_close_reason.dart';
 import 'local_notification_listener.dart';
 import 'local_notifier.dart';
 
@@ -24,7 +25,7 @@ class LocalNotification with LocalNotificationListener {
   List<LocalNotificationAction>? actions;
 
   VoidCallback? onShow;
-  VoidCallback? onClose;
+  ValueChanged<LocalNotificationCloseReason>? onClose;
   VoidCallback? onClick;
   ValueChanged<int>? onClickAction;
 
@@ -96,11 +97,14 @@ class LocalNotification with LocalNotificationListener {
   }
 
   @override
-  void onLocalNotificationClose(LocalNotification notification) {
+  void onLocalNotificationClose(
+    LocalNotification notification,
+    LocalNotificationCloseReason closeReason,
+  ) {
     if (identifier != notification.identifier || onClose == null) {
       return;
     }
-    onClose!();
+    onClose!(closeReason);
   }
 
   @override

lib/src/local_notification_close_reason.dart

@@ -0,0 +1,5 @@
+enum LocalNotificationCloseReason {
+  userCanceled,
+  timedOut,
+  unknown,
+}

lib/src/local_notification_listener.dart

@@ -1,8 +1,12 @@
+import 'local_notification_close_reason.dart';
 import 'local_notification.dart';
 
 abstract class LocalNotificationListener {
   void onLocalNotificationShow(LocalNotification notification) {}
-  void onLocalNotificationClose(LocalNotification notification) {}
+  void onLocalNotificationClose(
+    LocalNotification notification,
+    LocalNotificationCloseReason closeReason,
+  ) {}
   void onLocalNotificationClick(LocalNotification notification) {}
   void onLocalNotificationClickAction(
     LocalNotification notification,

lib/src/local_notifier.dart

@@ -4,6 +4,7 @@ import 'dart:io';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
 
+import 'local_notification_close_reason.dart';
 import 'local_notification_listener.dart';
 import 'local_notification.dart';
 
@@ -35,7 +36,15 @@ class LocalNotifier {
       if (call.method == 'onLocalNotificationShow') {
         listener.onLocalNotificationShow(localNotification!);
       } else if (call.method == 'onLocalNotificationClose') {
-        listener.onLocalNotificationClose(localNotification!);
+        LocalNotificationCloseReason closeReason =
+            LocalNotificationCloseReason.values.firstWhere(
+          (e) => describeEnum(e) == call.arguments['closeReason'],
+          orElse: () => LocalNotificationCloseReason.unknown,
+        );
+        listener.onLocalNotificationClose(
+          localNotification!,
+          closeReason,
+        );
       } else if (call.method == 'onLocalNotificationClick') {
         listener.onLocalNotificationClick(localNotification!);
       } else if (call.method == 'onLocalNotificationClickAction') {

windows/local_notifier_plugin.cpp

@@ -45,9 +45,25 @@ class CustomToastHandler : public IWinToastHandler {
   }
 
   void toastDismissed(WinToastDismissalReason state) const {
+    std::string closeReason = "unknown";
+
+    switch (state) {
+      case UserCanceled:
+        closeReason = "userCanceled";
+        break;
+      case TimedOut:
+        closeReason = "timedOut";
+        break;
+      default:
+        break;
+    }
+
     flutter::EncodableMap args = flutter::EncodableMap();
     args[flutter::EncodableValue("notificationId")] =
         flutter::EncodableValue(identifier);
+    args[flutter::EncodableValue("closeReason")] =
+        flutter::EncodableValue(closeReason);
+
     channel->InvokeMethod("onLocalNotificationClose",
                           std::make_unique<flutter::EncodableValue>(args));
   }