Android actionTypeId action support (#122)

* fix(android): correct actionTypeID to actionTypeId and add action intent handling in notifications

fix(android): enhance notification intent handling to ensure app launch intent is properly set

fix(android): improve notification action intent handling by making intents explicit and updating PendingIntent flags for compatibility

fix(android): enhance action intent handling in Notifications to ensure fallback for invalid actionTypeId

* feat(android): Add notification action handling and listener methods

* feat(iOS): Add notification listener and delegate methods for background runner

* Add changeset

* fmt

* build

---------

Co-authored-by: Joseph Pender <joey.pender@outsystems.com>

Author: hahagu

.changeset/hungry-onions-jog.md

@@ -0,0 +1,5 @@
+---
+"@capacitor/background-runner": minor
+---
+
+Adding handling for Android notifications

README.md

@@ -14,6 +14,8 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
+import android.content.Intent
+import com.getcapacitor.Bridge
 
 
 @CapacitorPlugin(
@@ -125,4 +127,46 @@ class BackgroundRunnerPlugin: Plugin() {
     fun registerBackgroundTask(call: PluginCall) {
         call.resolve()
     }
+
+    override fun handleOnNewIntent(intent: Intent) {
+        super.handleOnNewIntent(intent)
+        
+        Log.d("BackgroundRunner", "handleOnNewIntent with action: ${intent.action}")
+        
+        if (intent.action == ".NOTIFICATION_CLICKED") {
+            val actionTypeId = intent.getStringExtra("actionTypeId")
+            val notificationId = intent.getIntExtra("notificationId", -1)
+            
+            // Create notification action data
+            val notificationAction = if (actionTypeId != null) {
+                JSObject().apply {
+                    put("actionTypeId", actionTypeId)
+                    put("notificationId", notificationId)
+                }
+            } else null
+            
+            // Launch the app using proper intent flags
+            val packageName = context.packageName
+            val launchIntent = context.packageManager.getLaunchIntentForPackage(packageName)?.apply {
+                action = Intent.ACTION_MAIN
+                addCategory(Intent.CATEGORY_LAUNCHER)
+                flags = Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP
+            }
+            
+            if (launchIntent != null) {
+                context.startActivity(launchIntent)
+                
+                // Notify listeners about the action with retention
+                notificationAction?.let {
+                    notifyListeners("backgroundRunnerNotificationReceived", it, true)
+                }
+            }
+        }
+    }
+
+    @PluginMethod
+    fun removeNotificationListeners(call: PluginCall) {
+        notifyListeners("backgroundRunnerNotificationReceived", null)
+        call.resolve()
+    }
 }

packages/capacitor-plugin/API.md

@@ -20,7 +20,7 @@ class Notification(jsonObject: JSONObject) {
     var sound: String? = null
     var smallIcon: String? = null
     var largeIcon: String? = null
-    var actionTypeID: String? = null
+    var actionTypeId: String? = null
     var extra: HashMap<String, Any>? = null
     var group: String? = null
     var groupSummary: String? = null
@@ -35,6 +35,7 @@ class Notification(jsonObject: JSONObject) {
         smallIcon = jsonObject.optString("smallIcon", "")
         ongoing = jsonObject.optBoolean("ongoing", false)
         autoCancel = jsonObject.optBoolean("autoCancel", false)
+        actionTypeId = jsonObject.optString("actionTypeId", null)
 
         val scheduleDateString = jsonObject.optString("scheduleAt", "")
         if (scheduleDateString.isNotEmpty()) {

packages/capacitor-plugin/README.md

@@ -92,6 +92,27 @@ class Notifications(context: Context) : NotificationsAPI {
             builder.setGroupSummary(it.groupSummary != null)
             builder.setSmallIcon(it.smallIcon(this.context, getDefaultSmallIcon()))
 
+            // Add action intent handling
+            val actionIntent = Intent(".NOTIFICATION_CLICKED").apply {
+                `package` = context.packageName
+                putExtra("actionTypeId", it.actionTypeId)
+                putExtra("notificationId", it.id)
+            }
+            
+            val flags = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
+                PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
+            } else {
+                PendingIntent.FLAG_UPDATE_CURRENT
+            }
+            
+            val pendingActionIntent = PendingIntent.getActivity(
+                context,
+                it.id,
+                actionIntent,
+                flags
+            )
+            builder.setContentIntent(pendingActionIntent)
+
             val largeBody = it.largeBody
             if (largeBody != null) {
                 val style = NotificationCompat.BigTextStyle()

packages/capacitor-plugin/android/src/main/java/io/ionic/backgroundrunner/plugin/BackgroundRunnerPlugin.kt

@@ -8,4 +8,5 @@
     CAP_PLUGIN_METHOD(registerBackgroundTask, CAPPluginReturnPromise);
     CAP_PLUGIN_METHOD(checkPermissions, CAPPluginReturnPromise);
     CAP_PLUGIN_METHOD(requestPermissions, CAPPluginReturnPromise);
+    CAP_PLUGIN_METHOD(removeNotificationListeners, CAPPluginReturnPromise);
 )

packages/capacitor-plugin/android/src/main/java/io/ionic/backgroundrunner/plugin/api/Notification.kt

@@ -1,6 +1,7 @@
 import Foundation
 import Capacitor
 import WatchConnectivity
+import UserNotifications
 
 @objc(BackgroundRunnerPlugin)
 public class BackgroundRunnerPlugin: CAPPlugin {
@@ -14,6 +15,9 @@ public class BackgroundRunnerPlugin: CAPPlugin {
             object: nil
         )
 
+        // Register as notification delegate
+        registerNotificationCategories()
+
         initWatchConnectivity()
     }
 
@@ -95,6 +99,11 @@ public class BackgroundRunnerPlugin: CAPPlugin {
         call.resolve()
     }
 
+    @objc func removeNotificationListeners(_ call: CAPPluginCall) {
+        notifyListeners("backgroundRunnerNotificationReceived", data: nil)
+        call.resolve()
+    }
+
     @objc private func didEnterBackground() {
         do {
             try impl.scheduleBackgroundTasks()
@@ -175,4 +184,45 @@ public class BackgroundRunnerPlugin: CAPPlugin {
 
         print("Watch Connectivity Enabled")
     }
+
+    @objc func registerNotificationCategories() {
+        let notificationCenter = UNUserNotificationCenter.current()
+
+        // Set the plugin as the notification delegate
+        notificationCenter.delegate = self
+    }
+}
+
+// MARK: - UNUserNotificationCenterDelegate
+extension BackgroundRunnerPlugin: UNUserNotificationCenterDelegate {
+    // This method will be called when a notification is tapped
+    public func userNotificationCenter(_ center: UNUserNotificationCenter,
+                                       didReceive response: UNNotificationResponse,
+                                       withCompletionHandler completionHandler: @escaping () -> Void) {
+        let actionTypeId = response.notification.request.content.categoryIdentifier
+        let notificationId = Int(response.notification.request.identifier) ?? -1
+
+        // Create event data
+        let eventData: [String: Any] = [
+            "actionTypeId": actionTypeId,
+            "notificationId": notificationId
+        ]
+
+        // Notify listeners with the action data - the 'true' parameter is for retaining the event
+        notifyListeners("backgroundRunnerNotificationReceived", data: eventData, retainUntilConsumed: true)
+
+        completionHandler()
+    }
+
+    // This is needed to present notifications when the app is in the foreground
+    public func userNotificationCenter(_ center: UNUserNotificationCenter,
+                                       willPresent notification: UNNotification,
+                                       withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
+        // Show the notification even when the app is in foreground
+        if #available(iOS 14.0, *) {
+            completionHandler([.banner, .sound, .badge])
+        } else {
+            completionHandler([.alert, .sound, .badge])
+        }
+    }
 }