@capacitor/background-runner 2.1.0 → 2.2.0

package/README.md

@@ -269,7 +269,7 @@ Visit [Don't kill my app!](https://dontkillmyapp.com) for more information on th
 
 ## Limitations of Background Tasks
 
-It’s not possible to run persistent, always running background services on mobile operating systems. Due to the limitations imposed by iOS and Android designed to reduce battery and data consumption, background tasks are constrained with various limitations that you must keep in mind while designing and implementing your background task.
+It's not possible to run persistent, always running background services on mobile operating systems. Due to the limitations imposed by iOS and Android designed to reduce battery and data consumption, background tasks are constrained with various limitations that you must keep in mind while designing and implementing your background task.
 
 ### iOS
 
@@ -289,6 +289,8 @@ It’s not possible to run persistent, always running background services on mob
 * [`checkPermissions()`](#checkpermissions)
 * [`requestPermissions(...)`](#requestpermissions)
 * [`dispatchEvent(...)`](#dispatchevent)
+* [`addListener('backgroundRunnerNotificationReceived', ...)`](#addlistenerbackgroundrunnernotificationreceived-)
+* [`removeNotificationListeners()`](#removenotificationlisteners)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 
@@ -350,6 +352,41 @@ Dispatches an event to the configured runner.
 --------------------
 
 
+### addListener('backgroundRunnerNotificationReceived', ...)
+
+```typescript
+addListener(eventName: 'backgroundRunnerNotificationReceived', listenerFunc: (event: NotificationActionEvent) => void) => any
+```
+
+Add a listener for notification actions.
+
+| Param              | Type                                                                                            |
+| ------------------ | ----------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'backgroundRunnerNotificationReceived'</code>                                             |
+| **`listenerFunc`** | <code>(event: <a href="#notificationactionevent">NotificationActionEvent</a>) =&gt; void</code> |
+
+**Returns:** <code>any</code>
+
+**Since:** 2.1.1
+
+--------------------
+
+
+### removeNotificationListeners()
+
+```typescript
+removeNotificationListeners() => any
+```
+
+Remove notification action listeners for this plugin.
+
+**Returns:** <code>any</code>
+
+**Since:** 2.1.1
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -377,6 +414,21 @@ Dispatches an event to the configured runner.
 | **`details`** | <code>{ [key: string]: any; }</code> |                                            |       |
 
 
+#### NotificationActionEvent
+
+| Prop                 | Type                |
+| -------------------- | ------------------- |
+| **`actionTypeId`**   | <code>string</code> |
+| **`notificationId`** | <code>number</code> |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                      |
+| ------------ | ------------------------- |
+| **`remove`** | <code>() =&gt; any</code> |
+
+
 ### Type Aliases
 
 

package/android/src/main/java/io/ionic/backgroundrunner/plugin/BackgroundRunnerPlugin.kt

@@ -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()
+    }
 }

package/android/src/main/java/io/ionic/backgroundrunner/plugin/api/Notification.kt

@@ -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
@@ -32,8 +32,10 @@ class Notification(jsonObject: JSONObject) {
         id = jsonObject.optInt("id", -1)
         title = jsonObject.optString("title", "")
         body = jsonObject.optString("body", "")
+        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()) {
@@ -59,4 +61,4 @@ class Notification(jsonObject: JSONObject) {
 
         return resId
     }
-}
+}

package/android/src/main/java/io/ionic/backgroundrunner/plugin/api/Notifications.kt

@@ -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()

package/dist/docs.json

@@ -73,6 +73,50 @@
           "T"
         ],
         "slug": "dispatchevent"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'backgroundRunnerNotificationReceived', listenerFunc: (event: NotificationActionEvent) => void) => any",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'backgroundRunnerNotificationReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: NotificationActionEvent) => void"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "2.1.1"
+          }
+        ],
+        "docs": "Add a listener for notification actions.",
+        "complexTypes": [
+          "NotificationActionEvent",
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerbackgroundrunnernotificationreceived-"
+      },
+      {
+        "name": "removeNotificationListeners",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "2.1.1"
+          }
+        ],
+        "docs": "Remove notification action listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removenotificationlisteners"
       }
     ],
     "properties": []
@@ -162,6 +206,45 @@
           "type": "{ [key: string]: any; }"
         }
       ]
+    },
+    {
+      "name": "NotificationActionEvent",
+      "slug": "notificationactionevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "actionTypeId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "notificationId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => any"
+        }
+      ]
     }
   ],
   "enums": [],

package/dist/esm/definitions.d.ts

@@ -1,4 +1,4 @@
-import type { PermissionState } from '@capacitor/core';
+import type { PermissionState, PluginListenerHandle } from '@capacitor/core';
 export interface BackgroundRunnerConfig {
     /**
      * The name of the runner, used in logs.
@@ -122,6 +122,10 @@ export interface RequestPermissionOptions {
 export interface RegisterBackgroundTaskOptions {
     runner: BackgroundRunnerConfig;
 }
+export interface NotificationActionEvent {
+    actionTypeId: string;
+    notificationId: number;
+}
 export interface BackgroundRunnerPlugin {
     /**
      * Check permissions for the various Capacitor device APIs.
@@ -141,6 +145,18 @@ export interface BackgroundRunnerPlugin {
      * @since 1.0.0
      */
     dispatchEvent<T = void>(options: DispatchEventOptions): Promise<T>;
+    /**
+     * Add a listener for notification actions.
+     *
+     * @since 2.1.1
+     */
+    addListener(eventName: 'backgroundRunnerNotificationReceived', listenerFunc: (event: NotificationActionEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove notification action listeners for this plugin.
+     *
+     * @since 2.1.1
+     */
+    removeNotificationListeners(): Promise<void>;
 }
 declare module '@capacitor/cli' {
     interface PluginsConfig {

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState } from '@capacitor/core';\n\nexport interface BackgroundRunnerConfig {\n  /**\n   * The name of the runner, used in logs.\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The path to the runner JavaScript file, relative to the app bundle.\n   *\n   * @since 1.0.0\n   */\n  src: string;\n  /**\n   * The name of the event that will be called when the OS executes the background task.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  /**\n   * If background task should repeat based on the interval set in `interval`.\n   *\n   * @since 1.0.0\n   */\n  repeat: boolean;\n  /**\n   * The number of minutes after the the app is put into the background in which the background task should begin.\n   *\n   * If `repeat` is true, this also specifies the number of minutes between each execution.\n   *\n   * @since 1.0.0\n   */\n  interval: number;\n  /**\n   * Automatically register and schedule background task on app load.\n   *\n   * @since 1.0.0\n   */\n  autoStart?: boolean;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    /**\n     * On load, Background Runner will automatically register a\n     * background task that will be scheduled and run once your app is\n     * backgrounded.\n     */\n    BackgroundRunner?: {\n      /**\n       * The name of the runner, used in logs.\n       *\n       * @since 1.0.0\n       * @example \"com.example.background.task\"\n       */\n      label: string;\n      /**\n       * The path to the runner JavaScript file, relative to the app bundle.\n       *\n       * @since 1.0.0\n       * @example \"runners/background.js\"\n       */\n      src: string;\n      /**\n       * The name of the event that will be called when the OS executes the background task.\n       *\n       * @since 1.0.0\n       * @example \"myCustomEvent\"\n       */\n      event: string;\n      /**\n       * If background task should repeat based on the interval set in `interval`.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      repeat: boolean;\n      /**\n       * The number of minutes after the the app is put into the background in which the background task should begin.\n       *\n       * If `repeat` is true, this also specifies the number of minutes between each execution.\n       *\n       * @since 1.0.0\n       * @example 15\n       */\n      interval: number;\n      /**\n       * Automatically register and schedule background task on app load.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      autoStart?: boolean;\n    };\n  }\n}\n\nexport type API = 'geolocation' | 'notifications';\n\nexport interface PermissionStatus {\n  geolocation: PermissionState;\n  notifications: PermissionState;\n}\n\nexport interface DispatchEventOptions {\n  /**\n   * The runner label to dispatch the event to\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The name of the registered event listener.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  details: { [key: string]: any };\n}\n\nexport interface RequestPermissionOptions {\n  apis: API[];\n}\n\nexport interface RegisterBackgroundTaskOptions {\n  runner: BackgroundRunnerConfig;\n}\n\nexport interface BackgroundRunnerPlugin {\n  /**\n   * Check permissions for the various Capacitor device APIs.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n  /**\n   * Request permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(\n    options: RequestPermissionOptions,\n  ): Promise<PermissionStatus>;\n  /**\n   * Dispatches an event to the configured runner.\n   * @param options\n   * @since 1.0.0\n   */\n  dispatchEvent<T = void>(options: DispatchEventOptions): Promise<T>;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    BackgroundRunner?: BackgroundRunnerConfig;\n  }\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport interface BackgroundRunnerConfig {\n  /**\n   * The name of the runner, used in logs.\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The path to the runner JavaScript file, relative to the app bundle.\n   *\n   * @since 1.0.0\n   */\n  src: string;\n  /**\n   * The name of the event that will be called when the OS executes the background task.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  /**\n   * If background task should repeat based on the interval set in `interval`.\n   *\n   * @since 1.0.0\n   */\n  repeat: boolean;\n  /**\n   * The number of minutes after the the app is put into the background in which the background task should begin.\n   *\n   * If `repeat` is true, this also specifies the number of minutes between each execution.\n   *\n   * @since 1.0.0\n   */\n  interval: number;\n  /**\n   * Automatically register and schedule background task on app load.\n   *\n   * @since 1.0.0\n   */\n  autoStart?: boolean;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    /**\n     * On load, Background Runner will automatically register a\n     * background task that will be scheduled and run once your app is\n     * backgrounded.\n     */\n    BackgroundRunner?: {\n      /**\n       * The name of the runner, used in logs.\n       *\n       * @since 1.0.0\n       * @example \"com.example.background.task\"\n       */\n      label: string;\n      /**\n       * The path to the runner JavaScript file, relative to the app bundle.\n       *\n       * @since 1.0.0\n       * @example \"runners/background.js\"\n       */\n      src: string;\n      /**\n       * The name of the event that will be called when the OS executes the background task.\n       *\n       * @since 1.0.0\n       * @example \"myCustomEvent\"\n       */\n      event: string;\n      /**\n       * If background task should repeat based on the interval set in `interval`.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      repeat: boolean;\n      /**\n       * The number of minutes after the the app is put into the background in which the background task should begin.\n       *\n       * If `repeat` is true, this also specifies the number of minutes between each execution.\n       *\n       * @since 1.0.0\n       * @example 15\n       */\n      interval: number;\n      /**\n       * Automatically register and schedule background task on app load.\n       *\n       * @since 1.0.0\n       * @example true\n       */\n      autoStart?: boolean;\n    };\n  }\n}\n\nexport type API = 'geolocation' | 'notifications';\n\nexport interface PermissionStatus {\n  geolocation: PermissionState;\n  notifications: PermissionState;\n}\n\nexport interface DispatchEventOptions {\n  /**\n   * The runner label to dispatch the event to\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The name of the registered event listener.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  details: { [key: string]: any };\n}\n\nexport interface RequestPermissionOptions {\n  apis: API[];\n}\n\nexport interface RegisterBackgroundTaskOptions {\n  runner: BackgroundRunnerConfig;\n}\n\nexport interface NotificationActionEvent {\n  actionTypeId: string;\n  notificationId: number;\n}\n\nexport interface BackgroundRunnerPlugin {\n  /**\n   * Check permissions for the various Capacitor device APIs.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n  /**\n   * Request permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(\n    options: RequestPermissionOptions,\n  ): Promise<PermissionStatus>;\n  /**\n   * Dispatches an event to the configured runner.\n   * @param options\n   * @since 1.0.0\n   */\n  dispatchEvent<T = void>(options: DispatchEventOptions): Promise<T>;\n  /**\n   * Add a listener for notification actions.\n   *\n   * @since 2.1.1\n   */\n  addListener(\n    eventName: 'backgroundRunnerNotificationReceived',\n    listenerFunc: (event: NotificationActionEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove notification action listeners for this plugin.\n   *\n   * @since 2.1.1\n   */\n  removeNotificationListeners(): Promise<void>;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    BackgroundRunner?: BackgroundRunnerConfig;\n  }\n}\n"]}

package/dist/esm/web.d.ts

@@ -1,8 +1,11 @@
+import type { PluginListenerHandle } from '@capacitor/core';
 import { WebPlugin } from '@capacitor/core';
-import type { BackgroundRunnerPlugin, DispatchEventOptions, PermissionStatus } from './definitions';
+import type { BackgroundRunnerPlugin, DispatchEventOptions, PermissionStatus, NotificationActionEvent } from './definitions';
 export declare class BackgroundRunnerWeb extends WebPlugin implements BackgroundRunnerPlugin {
     checkPermissions(): Promise<PermissionStatus>;
     requestPermissions(): Promise<PermissionStatus>;
     registerBackgroundTask(): Promise<void>;
     dispatchEvent<T = void>(_options: DispatchEventOptions): Promise<T>;
+    addListener(_eventName: 'backgroundRunnerNotificationReceived', _listenerFunc: (event: NotificationActionEvent) => void): Promise<PluginListenerHandle>;
+    removeNotificationListeners(): Promise<void>;
 }

package/dist/esm/web.js

@@ -12,5 +12,11 @@ export class BackgroundRunnerWeb extends WebPlugin {
     dispatchEvent(_options) {
         throw new Error('not available on web');
     }
+    async addListener(_eventName, _listenerFunc) {
+        throw new Error('not available on web');
+    }
+    async removeNotificationListeners() {
+        throw new Error('not available on web');
+    }
 }
 //# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAQ5C,MAAM,OAAO,mBACX,SAAQ,SAAS;IAGjB,gBAAgB;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,kBAAkB;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,sBAAsB;QACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,aAAa,CAAW,QAA8B;QACpD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type {\n  BackgroundRunnerPlugin,\n  DispatchEventOptions,\n  PermissionStatus,\n} from './definitions';\n\nexport class BackgroundRunnerWeb\n  extends WebPlugin\n  implements BackgroundRunnerPlugin\n{\n  checkPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  requestPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  registerBackgroundTask(): Promise<void> {\n    throw new Error('not available on web');\n  }\n\n  dispatchEvent<T = void>(_options: DispatchEventOptions): Promise<T> {\n    throw new Error('not available on web');\n  }\n}\n"]}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAS5C,MAAM,OAAO,mBACX,SAAQ,SAAS;IAGjB,gBAAgB;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,kBAAkB;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,sBAAsB;QACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,aAAa,CAAW,QAA8B;QACpD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,UAAkD,EAClD,aAAuD;QAEvD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,2BAA2B;QAC/B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\nimport { WebPlugin } from '@capacitor/core';\n\nimport type {\n  BackgroundRunnerPlugin,\n  DispatchEventOptions,\n  PermissionStatus,\n  NotificationActionEvent,\n} from './definitions';\n\nexport class BackgroundRunnerWeb\n  extends WebPlugin\n  implements BackgroundRunnerPlugin\n{\n  checkPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  requestPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  registerBackgroundTask(): Promise<void> {\n    throw new Error('not available on web');\n  }\n\n  dispatchEvent<T = void>(_options: DispatchEventOptions): Promise<T> {\n    throw new Error('not available on web');\n  }\n\n  async addListener(\n    _eventName: 'backgroundRunnerNotificationReceived',\n    _listenerFunc: (event: NotificationActionEvent) => void,\n  ): Promise<PluginListenerHandle> {\n    throw new Error('not available on web');\n  }\n\n  async removeNotificationListeners(): Promise<void> {\n    throw new Error('not available on web');\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -21,6 +21,12 @@ class BackgroundRunnerWeb extends core.WebPlugin {
     dispatchEvent(_options) {
         throw new Error('not available on web');
     }
+    async addListener(_eventName, _listenerFunc) {
+        throw new Error('not available on web');
+    }
+    async removeNotificationListeners() {
+        throw new Error('not available on web');
+    }
 }
 
 var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent(_options) {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;;;AACK,MAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;AAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;AACrE,CAAC;;ACFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;AACnD,IAAI,gBAAgB,GAAG;AACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,kBAAkB,GAAG;AACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,sBAAsB,GAAG;AAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,aAAa,CAAC,QAAQ,EAAE;AAC5B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL;;;;;;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent(_options) {\n        throw new Error('not available on web');\n    }\n    async addListener(_eventName, _listenerFunc) {\n        throw new Error('not available on web');\n    }\n    async removeNotificationListeners() {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;;;AACK,MAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;AAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;AACrE,CAAC;;ACFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;AACnD,IAAI,gBAAgB,GAAG;AACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,kBAAkB,GAAG;AACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,sBAAsB,GAAG;AAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,aAAa,CAAC,QAAQ,EAAE;AAC5B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,MAAM,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE;AACjD,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,MAAM,2BAA2B,GAAG;AACxC,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL;;;;;;;;;"}

package/dist/plugin.js

@@ -18,6 +18,12 @@ var capacitorBackgroundRunner = (function (exports, core) {
         dispatchEvent(_options) {
             throw new Error('not available on web');
         }
+        async addListener(_eventName, _listenerFunc) {
+            throw new Error('not available on web');
+        }
+        async removeNotificationListeners() {
+            throw new Error('not available on web');
+        }
     }
 
     var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent(_options) {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;IAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACrE,CAAC;;ICFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;IACnD,IAAI,gBAAgB,GAAG;IACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,kBAAkB,GAAG;IACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,sBAAsB,GAAG;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,aAAa,CAAC,QAAQ,EAAE;IAC5B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent(_options) {\n        throw new Error('not available on web');\n    }\n    async addListener(_eventName, _listenerFunc) {\n        throw new Error('not available on web');\n    }\n    async removeNotificationListeners() {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;IAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACrE,CAAC;;ICFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;IACnD,IAAI,gBAAgB,GAAG;IACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,kBAAkB,GAAG;IACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,sBAAsB,GAAG;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,aAAa,CAAC,QAAQ,EAAE;IAC5B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,MAAM,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE;IACjD,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,MAAM,2BAA2B,GAAG;IACxC,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL;;;;;;;;;;;;;;;;;"}

package/ios/Plugin/BackgroundRunnerPlugin.m

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

package/ios/Plugin/BackgroundRunnerPlugin.swift

@@ -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])
+        }
+    }
 }

package/ios/Plugin/CapacitorAPI/Notifications.swift

@@ -195,7 +195,7 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
 
             let badgeOptions = SetBadgeOption(from: jsonDict)
 
-            DispatchQueue.main.sync {
+            DispatchQueue.main.async {
                 if #available(iOS 16.0, *) {
                     UNUserNotificationCenter.current().setBadgeCount(badgeOptions.count)
                 } else {
@@ -213,7 +213,7 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
                 throw CapacitorNotificationsErrors.permissionDenied
             }
 
-            DispatchQueue.main.sync {
+            DispatchQueue.main.async {
                 if #available(iOS 16.0, *) {
                     UNUserNotificationCenter.current().setBadgeCount(0)
                 } else {

package/ios/Plugin/CapacitorAPI/Reachability.swift

@@ -191,7 +191,7 @@ public extension Reachability {
                 _ = unmanagedWeakifiedReachability.retain()
                 return UnsafeRawPointer(unmanagedWeakifiedReachability.toOpaque())
             },
-            release: { (info: UnsafeRawPointer) -> Void in
+            release: { (info: UnsafeRawPointer) in
                 let unmanagedWeakifiedReachability = Unmanaged<ReachabilityWeakifier>.fromOpaque(info)
                 unmanagedWeakifiedReachability.release()
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/background-runner",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Capacitor Background Runner",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -81,5 +81,5 @@
       "src": "android"
     }
   },
-  "gitHead": "448ba72151718509470463daca43b69e3e86bc9c"
+  "gitHead": "9bd41296af96580537f63bb51a64f37a6e76a645"
 }