@capacitor/background-runner 1.1.0 → 2.1.0

package/CapacitorBackgroundRunner.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.author = package['author']
   s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
   s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}', 'packages/capacitor-plugin/ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}', 'packages/ios-engine/Sources/RunnerEngine/*.swift'
-  s.ios.deployment_target  = '13.0'
+  s.ios.deployment_target  = '14.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
 end

package/README.md

@@ -441,9 +441,11 @@ A simple string key / value store backed by UserDefaults on iOS and Shared Prefe
 
 Send basic local notifications.
 
-| Prop           | Type                                  | Description                   | Since |
-| -------------- | ------------------------------------- | ----------------------------- | ----- |
-| **`schedule`** | <code>(options: {}) =&gt; void</code> | Schedule a local notification | 1.0.0 |
+| Prop             | Type                                                                                                | Description                        | Since |
+| ---------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------- | ----- |
+| **`schedule`**   | <code>(options: {}) =&gt; void</code>                                                               | Schedule a local notification      | 1.0.0 |
+| **`setBadge`**   | <code>(options: <a href="#notificationbadgeoptions">NotificationBadgeOptions</a>) =&gt; void</code> | Set the application badge count    | 2.0.0 |
+| **`clearBadge`** | <code>() =&gt; void</code>                                                                          | Clears the application badge count | 2.0.0 |
 
 
 #### NotificationScheduleOptions
@@ -470,6 +472,15 @@ Send basic local notifications.
 | **`channelId`**        | <code>string</code>  | Specifies the channel the notification should be delivered on. If channel with the given name does not exist then the notification will not fire. If not provided, it will use the default channel. Calls `setChannelId()` on [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder) with the provided value. Only available for Android 26+.                                                                                                                                                                                                                     | 1.0.0 |
 
 
+#### NotificationBadgeOptions
+
+| Prop                       | Type                | Description                                                                           | Since |
+| -------------------------- | ------------------- | ------------------------------------------------------------------------------------- | ----- |
+| **`count`**                | <code>number</code> | The number to set on the application badge count.                                     | 2.0.0 |
+| **`notificationTitle`**    | <code>string</code> | The **required** title for the associated badge count notification. Only for Android. | 2.0.0 |
+| **`notificationSubtitle`** | <code>string</code> | The subtitle for the associated badge count notification. Only for Android.           | 2.0.0 |
+
+
 #### CapacitorGeolocation
 
 Get access to device location information.
@@ -492,21 +503,46 @@ Get access to device location information.
 | **`heading`**          | <code>number \| null</code> | The heading the user is facing (if available)                                                                         | 1.0.0 |
 
 
-#### CapcacitorWatch
+#### CapacitorWatch
 
 Interact with a watch paired with this app
 
-sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.
+sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a <a href="#capacitorwatch">CapacitorWatch</a> Watch application.
 They could be used if a native watch app is developed as a companion app to a Capacitor app
 
-| Prop                           | Type                                                                     | Description                                                                                                                                                 |
-| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`sendMessage`**              | <code>(options: []) =&gt; void</code>                                    | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a CapacitorWatch watch app                              |
-| **`transferUserInfo`**         | <code>(options: []) =&gt; void</code>                                    | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a CapacitorWatch watch app                       |
-| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code>                                    | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a CapacitorWatch watch app |
-| **`isReachable`**              | <code>boolean</code>                                                     | Checks to see if the compaion watch is reachable                                                                                                            |
-| **`updateWatchUI`**            | <code>(options: { watchUI: string; }) =&gt; void</code>                  | Replaces the current UI on the watch with what is specified here.                                                                                           |
-| **`updateWatchData`**          | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields                                                                          |
+| Prop                           | Type                                                                     | Description                                                                                                                                                                               |
+| ------------------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`sendMessage`**              | <code>(options: []) =&gt; void</code>                                    | Sends a message to the watch with the sendMessage() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app                              |
+| **`transferUserInfo`**         | <code>(options: []) =&gt; void</code>                                    | Sends information to the watch with the transferUserInfo() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app                       |
+| **`updateApplicationContext`** | <code>(options: []) =&gt; void</code>                                    | Updates the application context on the watch with the updateApplicationContext() WCSession delegate method This has no effect on a <a href="#capacitorwatch">CapacitorWatch</a> watch app |
+| **`isReachable`**              | <code>boolean</code>                                                     | Checks to see if the compaion watch is reachable                                                                                                                                          |
+| **`updateWatchUI`**            | <code>(options: { watchUI: string; }) =&gt; void</code>                  | Replaces the current UI on the watch with what is specified here.                                                                                                                         |
+| **`updateWatchData`**          | <code>(options: { data: { [key: string]: string; }; }) =&gt; void</code> | Updates the data the watch is using to display variables in text and button fields                                                                                                        |
+
+
+#### CapacitorApp
+
+| Prop           | Type                                                   |
+| -------------- | ------------------------------------------------------ |
+| **`getState`** | <code>() =&gt; <a href="#appstate">AppState</a></code> |
+| **`getInfo`**  | <code>() =&gt; <a href="#appinfo">AppInfo</a></code>   |
+
+
+#### AppState
+
+| Prop           | Type                 | Description                       | Since |
+| -------------- | -------------------- | --------------------------------- | ----- |
+| **`isActive`** | <code>boolean</code> | Whether the app is active or not. | 1.0.0 |
+
+
+#### AppInfo
+
+| Prop          | Type                | Description                                                                                         | Since |
+| ------------- | ------------------- | --------------------------------------------------------------------------------------------------- | ----- |
+| **`name`**    | <code>string</code> | The name of the app.                                                                                | 1.0.0 |
+| **`id`**      | <code>string</code> | The identifier of the app. On iOS it's the Bundle Identifier. On Android it's the Application ID    | 1.0.0 |
+| **`build`**   | <code>string</code> | The build version. On iOS it's the CFBundleVersion. On Android it's the versionCode.                | 1.0.0 |
+| **`version`** | <code>string</code> | The app version. On iOS it's the CFBundleShortVersionString. On Android it's package's versionName. | 1.0.0 |
 
 
 </capacitor-api-docs>

package/android/build.gradle

@@ -1,21 +1,21 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
-    androidxCoreKTXVersion = project.hasProperty('androidxCoreKTXVersion') ? rootProject.ext.androidxCoreKTXVersion : '1.10.0'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxCoreKTXVersion = project.hasProperty('androidxCoreKTXVersion') ? rootProject.ext.androidxCoreKTXVersion : '1.12.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
     workManagerVersion = project.hasProperty('workManagerVersion') ? rootProject.ext.workManagerVersion : '2.8.1'
 
 }
 
 buildscript {
-    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.8.20'
+    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.9.25'
     repositories {
         google()
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.0.0'
+        classpath 'com.android.tools.build:gradle:8.7.2'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
 
     }
@@ -26,10 +26,10 @@ apply plugin: 'org.jetbrains.kotlin.android'
 
 android {
     namespace "com.capacitorjs.plugins.backgroundrunner"
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
     defaultConfig {
-        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -44,8 +44,8 @@ android {
         abortOnError false
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_17
-        targetCompatibility JavaVersion.VERSION_17
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
     }
 }
 

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

@@ -13,6 +13,8 @@ import io.ionic.android_js_engine.Context
 import io.ionic.android_js_engine.NativeCapacitorAPI
 import io.ionic.android_js_engine.NativeJSFunction
 import io.ionic.android_js_engine.Runner
+import io.ionic.backgroundrunner.plugin.api.App
+import io.ionic.backgroundrunner.plugin.api.AppState
 import io.ionic.backgroundrunner.plugin.api.Device
 import io.ionic.backgroundrunner.plugin.api.Geolocation
 import io.ionic.backgroundrunner.plugin.api.KV
@@ -187,6 +189,7 @@ class BackgroundRunner(context: android.content.Context) {
         api.initKVAPI(KV(context, config.label))
         api.initGeolocationAPI(Geolocation(context))
         api.initNotificationsAPI(Notifications(context))
+        api.initAppAPI(App(context))
 
         val newContext  = runner.createContext(contextName, api)
         newContext.execute(srcFile, false)

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

@@ -9,6 +9,7 @@ import com.getcapacitor.PluginMethod
 import com.getcapacitor.annotation.CapacitorPlugin
 import com.getcapacitor.annotation.Permission
 import com.getcapacitor.annotation.PermissionCallback
+import io.ionic.backgroundrunner.plugin.api.AppState
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch
@@ -30,27 +31,36 @@ import kotlinx.coroutines.runBlocking
 )
 class BackgroundRunnerPlugin: Plugin() {
     private var impl: BackgroundRunner? = null
+    private var appState: AppState = AppState.getInstance()
 
     companion object {
         const val GEOLOCATION = "geolocation"
         const val NOTIFICATIONS = "notifications"
     }
 
+    override fun handleOnStart() {
+        super.handleOnStart()
+        appState.isActive = true
+    }
+
     override fun handleOnPause() {
         super.handleOnPause()
         Log.d("Background Runner", "registering runner workers")
+        appState.isActive = false
         impl?.scheduleBackgroundTask(this.context)
     }
 
     override fun handleOnStop() {
         super.handleOnStop()
         Log.d("Background Runner", "shutting down foreground runner")
+        appState.isActive = false
         impl?.shutdown()
     }
 
     override fun handleOnResume() {
         super.handleOnResume()
         Log.d("Background Runner", "starting foreground runner")
+        appState.isActive = true
         impl?.start()
     }
 

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

@@ -0,0 +1,31 @@
+package io.ionic.backgroundrunner.plugin.api
+
+import androidx.core.content.pm.PackageInfoCompat
+import com.getcapacitor.util.InternalUtils
+import io.ionic.android_js_engine.capacitor_api.AppAPI
+import org.json.JSONObject
+
+class App(private val context: android.content.Context): AppAPI {
+
+    override fun getInfo(): String {
+        val packageInfo = InternalUtils.getPackageInfo(context.packageManager, context.packageName)
+        val appInfo = context.applicationInfo
+
+        val appName = if (appInfo.labelRes == 0) appInfo.nonLocalizedLabel.toString() else context.getString(appInfo.labelRes)
+
+        val info = JSONObject()
+        info.put("name", appName)
+        info.put("id", packageInfo.packageName)
+        info.put("build", PackageInfoCompat.getLongVersionCode(packageInfo).toString())
+        info.put("version", packageInfo.versionName)
+
+        return info.toString()
+    }
+
+    override fun getState(): String {
+
+        val state = JSONObject()
+        state.put("isActive", AppState.getInstance().isActive)
+        return state.toString()
+    }
+}

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

@@ -0,0 +1,14 @@
+package io.ionic.backgroundrunner.plugin.api
+
+class AppState {
+    public var isActive = false
+
+    companion object {
+        @Volatile
+        private var instance: AppState? = null
+
+        fun getInstance() = instance ?: synchronized(this) {
+            instance ?: AppState().also { instance = it }
+        }
+    }
+}

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

@@ -35,12 +35,15 @@ class Notification(jsonObject: JSONObject) {
         ongoing = jsonObject.optBoolean("ongoing", false)
         autoCancel = jsonObject.optBoolean("autoCancel", false)
 
-        val scheduleDateString = jsonObject.getString("scheduleAt")
-
-        val sdf = SimpleDateFormat(jsDateFormat)
-        val parsedDate = sdf.parse(scheduleDateString)
-
-        scheduleAt = parsedDate ?: Date()
+        val scheduleDateString = jsonObject.optString("scheduleAt", "")
+        if (scheduleDateString.isNotEmpty()) {
+            val sdf = SimpleDateFormat(jsDateFormat)
+            val parsedDate = sdf.parse(scheduleDateString)
+
+            scheduleAt = parsedDate ?: Date()
+        } else {
+            scheduleAt = Date()
+        }
     }
 
     fun smallIcon(context: android.content.Context, defaultIcon: Int): Int {

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

@@ -17,6 +17,8 @@ import com.getcapacitor.CapConfig
 import com.getcapacitor.plugin.util.AssetUtil
 import io.ionic.android_js_engine.capacitor_api.NotificationsAPI
 import org.json.JSONArray
+import org.json.JSONObject
+
 
 class Notifications(context: Context) : NotificationsAPI {
     private val manager: NotificationManagerCompat
@@ -32,12 +34,40 @@ class Notifications(context: Context) : NotificationsAPI {
         this.config = CapConfig.loadDefault(context)
 
         this.createNotificationChannel()
+        this.createBadgeNotificationChannel()
     }
     companion object {
         const val notificationIntentKey = "LocalNotificationId"
         const val defaultNotificationChannelID = "default"
+        const val defaultBadgeNotificationChannelID = "badge"
+    }
+
+    override fun clearBadge() {
+        val builder = NotificationCompat.Builder(context, defaultBadgeNotificationChannelID)
+        builder.setSmallIcon(getDefaultSmallIcon())
+        builder.setNumber(0)
+        builder.setAutoCancel(true)
+
+        val manager = context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
+        manager.notify(1001, builder.build())
+    }
+
+    override fun setBadge(jsonString: String) {
+        val obj = JSONObject(jsonString)
+        val options = SetBadgeOptions(obj)
+
+        val builder = NotificationCompat.Builder(context, defaultBadgeNotificationChannelID)
+        builder.setSmallIcon(getDefaultSmallIcon())
+        builder.setContentTitle(options.messageTitle)
+        builder.setContentText(options.messageSubtitle)
+        builder.setNumber(options.count)
+        builder.setAutoCancel(true)
+
+        val manager = context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
+        manager.notify(1001, builder.build())
     }
 
+
     override fun schedule(jsonString: String) {
         val notifications = mutableListOf<Notification>()
 
@@ -96,6 +126,22 @@ class Notifications(context: Context) : NotificationsAPI {
         }
     }
 
+    private fun createBadgeNotificationChannel() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+            val name: CharSequence = "Badge"
+            val description = "Badge"
+            val importance = NotificationManager.IMPORTANCE_LOW
+            val channel = NotificationChannel(defaultBadgeNotificationChannelID, name, importance)
+            channel.description = description
+            channel.setShowBadge(true)
+
+            val notificationManager = context.getSystemService(
+                NotificationManager::class.java
+            )
+            notificationManager.createNotificationChannel(channel)
+        }
+    }
+
     private fun getDefaultSoundUrl(context: Context): Uri? {
         val soundId = getDefaultSound(context)
         return if (soundId != AssetUtil.RESOURCE_ID_ZERO_VALUE) {

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

@@ -0,0 +1,11 @@
+package io.ionic.backgroundrunner.plugin.api
+
+import org.json.JSONObject
+
+data class SetBadgeOptions(var count: Int, var messageTitle: String, var messageSubtitle: String) {
+    constructor(jsonObject: JSONObject) : this(0, "", "") {
+        this.count = jsonObject.optInt("count", 0)
+        this.messageTitle = jsonObject.optString("notificationTitle", "")
+        this.messageSubtitle = jsonObject.optString("notificationSubtitle", "")
+    }
+}

package/dist/docs-api.json

@@ -47,9 +47,18 @@
         "tags": [],
         "docs": "",
         "complexTypes": [
-          "CapcacitorWatch"
+          "CapacitorWatch"
         ],
-        "type": "CapcacitorWatch"
+        "type": "CapacitorWatch"
+      },
+      {
+        "name": "CapacitorApp",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "CapacitorApp"
+        ],
+        "type": "CapacitorApp"
       }
     ]
   },
@@ -239,6 +248,52 @@
             "NotificationScheduleOptions"
           ],
           "type": "(options: {}) => void"
+        },
+        {
+          "name": "setBadge",
+          "tags": [
+            {
+              "text": "`CapacitorNotifications.setBadge({...})`",
+              "name": "example"
+            },
+            {
+              "text": "options",
+              "name": "param"
+            },
+            {
+              "text": "void",
+              "name": "returns"
+            },
+            {
+              "text": "2.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Set the application badge count",
+          "complexTypes": [
+            "NotificationBadgeOptions"
+          ],
+          "type": "(options: NotificationBadgeOptions) => void"
+        },
+        {
+          "name": "clearBadge",
+          "tags": [
+            {
+              "text": "`CapacitorNotifications.clearBadge()`",
+              "name": "example"
+            },
+            {
+              "text": "void",
+              "name": "returns"
+            },
+            {
+              "text": "2.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Clears the application badge count",
+          "complexTypes": [],
+          "type": "() => void"
         }
       ]
     },
@@ -469,6 +524,51 @@
         }
       ]
     },
+    {
+      "name": "NotificationBadgeOptions",
+      "slug": "notificationbadgeoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "count",
+          "tags": [
+            {
+              "text": "2.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The number to set on the application badge count.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "notificationTitle",
+          "tags": [
+            {
+              "text": "2.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The **required** title for the associated badge count notification.\n\nOnly for Android.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "notificationSubtitle",
+          "tags": [
+            {
+              "text": "2.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The subtitle for the associated badge count notification.\n\nOnly for Android.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
     {
       "name": "CapacitorGeolocation",
       "slug": "capacitorgeolocation",
@@ -591,9 +691,9 @@
       ]
     },
     {
-      "name": "CapcacitorWatch",
-      "slug": "capcacitorwatch",
-      "docs": "Interact with a watch paired with this app\n\nsendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.\nThey could be used if a native watch app is developed as a companion app to a Capacitor app",
+      "name": "CapacitorWatch",
+      "slug": "capacitorwatch",
+      "docs": "Interact with a watch paired with this app\n\nsendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapacitorWatch Watch application.\nThey could be used if a native watch app is developed as a companion app to a Capacitor app",
       "tags": [],
       "methods": [],
       "properties": [
@@ -658,6 +758,111 @@
           "type": "(options: { data: { [key: string]: string; }; }) => void"
         }
       ]
+    },
+    {
+      "name": "CapacitorApp",
+      "slug": "capacitorapp",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "getState",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "AppState"
+          ],
+          "type": "() => AppState"
+        },
+        {
+          "name": "getInfo",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "AppInfo"
+          ],
+          "type": "() => AppInfo"
+        }
+      ]
+    },
+    {
+      "name": "AppState",
+      "slug": "appstate",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "isActive",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the app is active or not.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "AppInfo",
+      "slug": "appinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the app.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the app.\nOn iOS it's the Bundle Identifier.\nOn Android it's the Application ID",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "build",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The build version.\nOn iOS it's the CFBundleVersion.\nOn Android it's the versionCode.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The app version.\nOn iOS it's the CFBundleShortVersionString.\nOn Android it's package's versionName.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
     }
   ],
   "enums": [],

package/dist/esm/apis.d.ts

@@ -52,6 +52,30 @@ export interface NetworkStatus {
     connected: boolean;
     connectionType: string;
 }
+export interface NotificationBadgeOptions {
+    /**
+     * The number to set on the application badge count.
+     *
+     * @since 2.0.0
+     */
+    count: number;
+    /**
+     * The **required** title for the associated badge count notification.
+     *
+     * Only for Android.
+     *
+     * @since 2.0.0
+     */
+    notificationTitle: string;
+    /**
+     * The subtitle for the associated badge count notification.
+     *
+     * Only for Android.
+     *
+     * @since 2.0.0
+     */
+    notificationSubtitle: string;
+}
 export interface NotificationScheduleOptions {
     /**
      * The notification identifier.
@@ -239,6 +263,46 @@ export interface NotificationScheduleOptions {
      */
     channelId?: string;
 }
+export interface AppInfo {
+    /**
+     * The name of the app.
+     *
+     * @since 1.0.0
+     */
+    name: string;
+    /**
+     * The identifier of the app.
+     * On iOS it's the Bundle Identifier.
+     * On Android it's the Application ID
+     *
+     * @since 1.0.0
+     */
+    id: string;
+    /**
+     * The build version.
+     * On iOS it's the CFBundleVersion.
+     * On Android it's the versionCode.
+     *
+     * @since 1.0.0
+     */
+    build: string;
+    /**
+     * The app version.
+     * On iOS it's the CFBundleShortVersionString.
+     * On Android it's package's versionName.
+     *
+     * @since 1.0.0
+     */
+    version: string;
+}
+export interface AppState {
+    /**
+     * Whether the app is active or not.
+     *
+     * @since 1.0.0
+     */
+    isActive: boolean;
+}
 /**
  * Get access to device location information.
  *
@@ -310,14 +374,29 @@ export interface CapacitorNotifications {
      * @since 1.0.0
      */
     schedule: (options: NotificationScheduleOptions[]) => void;
+    /**
+     * Set the application badge count
+     * @example `CapacitorNotifications.setBadge({...})`
+     * @param options
+     * @returns void
+     * @since 2.0.0
+     */
+    setBadge: (options: NotificationBadgeOptions) => void;
+    /**
+     * Clears the application badge count
+     * @example `CapacitorNotifications.clearBadge()`
+     * @returns void
+     * @since 2.0.0
+     */
+    clearBadge: () => void;
 }
 /**
  * Interact with a watch paired with this app
  *
- * sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.
+ * sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapacitorWatch Watch application.
  * They could be used if a native watch app is developed as a companion app to a Capacitor app
  */
-export interface CapcacitorWatch {
+export interface CapacitorWatch {
     /**
      * Sends a message to the watch with the sendMessage() WCSession delegate method
      *
@@ -359,10 +438,15 @@ export interface CapcacitorWatch {
         };
     }) => void;
 }
+export interface CapacitorApp {
+    getState: () => AppState;
+    getInfo: () => AppInfo;
+}
 export interface CapacitorAPI {
     CapacitorDevice: CapacitorDevice;
     CapacitorKV: CapacitorKV;
     CapacitorNotifications: CapacitorNotifications;
     CapacitorGeolocation: CapacitorGeolocation;
-    CapacitorWatch: CapcacitorWatch;
+    CapacitorWatch: CapacitorWatch;
+    CapacitorApp: CapacitorApp;
 }

package/dist/esm/apis.js.map

@@ -1 +1 @@
-{"version":3,"file":"apis.js","sourceRoot":"","sources":["../../src/apis.ts"],"names":[],"mappings":"","sourcesContent":["export interface GetCurrentPositionResult {\n  /**\n   * Latitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  latitude: number;\n  /**\n   * longitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  longitude: number;\n  /**\n   * Accuracy level of the latitude and longitude coordinates in meters\n   *\n   * @since 1.0.0\n   */\n  accuracy: number;\n  /**\n   * The altitude the user is at (if available)\n   *\n   * @since 1.0.0\n   */\n  altitude: number | null;\n  /**\n   * Accuracy level of the altitude coordinate in meters, if available.\n   *\n   * Available on all iOS versions and on Android 8.0+.\n   *\n   * @since 1.0.0\n   */\n  altitudeAccuracy?: number | null | undefined;\n  /**\n   * The speed the user is traveling (if available)\n   *\n   * @since 1.0.0\n   */\n  speed: number | null;\n  /**\n   * The heading the user is facing (if available)\n   *\n   * @since 1.0.0\n   */\n  heading: number | null;\n}\n\nexport interface BatteryStatus {\n  batteryLevel: number;\n  isCharging: boolean;\n}\n\nexport interface NetworkStatus {\n  connected: boolean;\n  connectionType: string;\n}\n\nexport interface NotificationScheduleOptions {\n  /**\n   * The notification identifier.\n   * On Android it's a 32-bit int.\n   * So the value should be between -2147483648 and 2147483647 inclusive.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n  /**\n   * Date to send this notification.\n   *\n   * @since 1.0.0\n   */\n  scheduleAt: Date;\n  /**\n   * Name of the audio file to play when this notification is displayed.\n   *\n   * Include the file extension with the filename.\n   *\n   * On iOS, the file should be in the app bundle.\n   * On Android, the file should be in res/raw folder.\n   *\n   * Recommended format is `.wav` because is supported by both iOS and Android.\n   *\n   * Only available for iOS and Android < 26.\n   * For Android 26+ use channelId of a channel configured with the desired sound.\n   *\n   * If the sound file is not found, (i.e. empty string or wrong name)\n   * the default system notification sound will be used.\n   * If not provided, it will produce the default sound on Android and no sound on iOS.\n   *\n   * @since 1.0.0\n   */\n  sound?: string;\n  /**\n   * Associate an action type with this notification.\n   *\n   * @since 1.0.0\n   */\n  actionTypeId?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Sets `threadIdentifier` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  threadIdentifier?: string;\n  /**\n   * The string this notification adds to the category's summary format string.\n   *\n   * Sets `summaryArgument` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  summaryArgument?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Calls `setGroup()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  group?: string;\n  /**\n   * If true, this notification becomes the summary for a group of\n   * notifications.\n   *\n   * Calls `setGroupSummary()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android when using `group`.\n   *\n   * @since 1.0.0\n   */\n  groupSummary?: string;\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n  /**\n   * If true, the notification can't be swiped away.\n   *\n   * Calls `setOngoing()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  ongoing?: boolean;\n  /**\n   * If true, the notification is canceled when the user clicks on it.\n   *\n   * Calls `setAutoCancel()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  autoCancel?: boolean;\n  /**\n   * Sets a multiline text block for display in a big text notification style.\n   *\n   * @since 1.0.0\n   */\n  largeBody?: string;\n  /**\n   * Used to set the summary text detail in inbox and big text notification styles.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  summaryText?: string;\n  /**\n   * Set a custom status bar icon.\n   *\n   * If set, this overrides the `smallIcon` option from Capacitor\n   * configuration.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  smallIcon?: string;\n  /**\n   * Set a large icon for notifications.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  largeIcon?: string;\n  /**\n   * Specifies the channel the notification should be delivered on.\n   *\n   * If channel with the given name does not exist then the notification will\n   * not fire. If not provided, it will use the default channel.\n   *\n   * Calls `setChannelId()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android 26+.\n   *\n   * @since 1.0.0\n   */\n  channelId?: string;\n}\n\n/**\n * Get access to device location information.\n *\n * @since 1.0.0\n */\nexport interface CapacitorGeolocation {\n  /**\n   * Get the device's last known location\n   * @since 1.0.0\n   */\n  getCurrentPosition: () => GetCurrentPositionResult;\n}\n\n/**\n * A simple string key / value store backed by UserDefaults on iOS and Shared Preferences on Android.\n */\nexport interface CapacitorKV {\n  /**\n   * Set a string value with the given key.\n   *\n   * @param key\n   * @param value\n   * @returns\n   * @since 1.0.0\n   */\n  set: (key: string, value: string) => void;\n  /**\n   * Get a string value for the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  get: (key: string) => { value: string };\n  /**\n   * Remove a value with the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  remove: (key: string) => void;\n}\n\n/**\n * Get information on the device, such as network connectivity and battery status.\n */\nexport interface CapacitorDevice {\n  /**\n   * Get the current battery status for the device.\n   *\n   * @since 1.0.0\n   */\n  getBatteryStatus: () => BatteryStatus;\n  /**\n   * Get the current network status for the device.\n   *\n   * @since 1.0.0\n   */\n  getNetworkStatus: () => NetworkStatus;\n}\n\n/**\n * Send basic local notifications.\n */\nexport interface CapacitorNotifications {\n  /**\n   * Schedule a local notification\n   * @example `CapacitorNotifications.schedule()`\n   * @param options\n   * @returns void\n   * @since 1.0.0\n   */\n  schedule: (options: NotificationScheduleOptions[]) => void;\n}\n\n/**\n * Interact with a watch paired with this app\n *\n * sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application.\n * They could be used if a native watch app is developed as a companion app to a Capacitor app\n */\nexport interface CapcacitorWatch {\n  /**\n   * Sends a message to the watch with the sendMessage() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  sendMessage: (options: []) => void;\n  /**\n   * Sends information to the watch with the transferUserInfo() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  transferUserInfo: (options: []) => void;\n  /**\n   * Updates the application context on the watch with the updateApplicationContext() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  updateApplicationContext: (options: []) => void;\n  /**\n   * Checks to see if the compaion watch is reachable\n   */\n  isReachable: boolean;\n  /**\n   * Replaces the current UI on the watch with what is specified here.\n   * @param options the new WatchUI you want to show on the watch\n   * @returns void\n   */\n  updateWatchUI: (options: { watchUI: string }) => void;\n  /**\n   * Updates the data the watch is using to display variables in text and button fields\n   * @param options the new data to send to the watch\n   * @returns void\n   */\n  updateWatchData: (options: { data: { [key: string]: string } }) => void;\n}\n\nexport interface CapacitorAPI {\n  CapacitorDevice: CapacitorDevice;\n  CapacitorKV: CapacitorKV;\n  CapacitorNotifications: CapacitorNotifications;\n  CapacitorGeolocation: CapacitorGeolocation;\n  CapacitorWatch: CapcacitorWatch;\n}\n"]}
+{"version":3,"file":"apis.js","sourceRoot":"","sources":["../../src/apis.ts"],"names":[],"mappings":"","sourcesContent":["export interface GetCurrentPositionResult {\n  /**\n   * Latitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  latitude: number;\n  /**\n   * longitude in decimal degrees\n   *\n   * @since 1.0.0\n   */\n  longitude: number;\n  /**\n   * Accuracy level of the latitude and longitude coordinates in meters\n   *\n   * @since 1.0.0\n   */\n  accuracy: number;\n  /**\n   * The altitude the user is at (if available)\n   *\n   * @since 1.0.0\n   */\n  altitude: number | null;\n  /**\n   * Accuracy level of the altitude coordinate in meters, if available.\n   *\n   * Available on all iOS versions and on Android 8.0+.\n   *\n   * @since 1.0.0\n   */\n  altitudeAccuracy?: number | null | undefined;\n  /**\n   * The speed the user is traveling (if available)\n   *\n   * @since 1.0.0\n   */\n  speed: number | null;\n  /**\n   * The heading the user is facing (if available)\n   *\n   * @since 1.0.0\n   */\n  heading: number | null;\n}\n\nexport interface BatteryStatus {\n  batteryLevel: number;\n  isCharging: boolean;\n}\n\nexport interface NetworkStatus {\n  connected: boolean;\n  connectionType: string;\n}\n\nexport interface NotificationBadgeOptions {\n  /**\n   * The number to set on the application badge count.\n   *\n   * @since 2.0.0\n   */\n  count: number;\n  /**\n   * The **required** title for the associated badge count notification.\n   *\n   * Only for Android.\n   *\n   * @since 2.0.0\n   */\n  notificationTitle: string;\n  /**\n   * The subtitle for the associated badge count notification.\n   *\n   * Only for Android.\n   *\n   * @since 2.0.0\n   */\n  notificationSubtitle: string;\n}\n\nexport interface NotificationScheduleOptions {\n  /**\n   * The notification identifier.\n   * On Android it's a 32-bit int.\n   * So the value should be between -2147483648 and 2147483647 inclusive.\n   *\n   * @since 1.0.0\n   */\n  id: number;\n  /**\n   * The title of the notification.\n   *\n   * @since 1.0.0\n   */\n  title: string;\n  /**\n   * The body of the notification, shown below the title.\n   *\n   * @since 1.0.0\n   */\n  body: string;\n  /**\n   * Date to send this notification.\n   *\n   * @since 1.0.0\n   */\n  scheduleAt: Date;\n  /**\n   * Name of the audio file to play when this notification is displayed.\n   *\n   * Include the file extension with the filename.\n   *\n   * On iOS, the file should be in the app bundle.\n   * On Android, the file should be in res/raw folder.\n   *\n   * Recommended format is `.wav` because is supported by both iOS and Android.\n   *\n   * Only available for iOS and Android < 26.\n   * For Android 26+ use channelId of a channel configured with the desired sound.\n   *\n   * If the sound file is not found, (i.e. empty string or wrong name)\n   * the default system notification sound will be used.\n   * If not provided, it will produce the default sound on Android and no sound on iOS.\n   *\n   * @since 1.0.0\n   */\n  sound?: string;\n  /**\n   * Associate an action type with this notification.\n   *\n   * @since 1.0.0\n   */\n  actionTypeId?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Sets `threadIdentifier` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  threadIdentifier?: string;\n  /**\n   * The string this notification adds to the category's summary format string.\n   *\n   * Sets `summaryArgument` on the\n   * [`UNMutableNotificationContent`](https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent).\n   *\n   * Only available for iOS.\n   *\n   * @since 1.0.0\n   */\n  summaryArgument?: string;\n  /**\n   * Used to group multiple notifications.\n   *\n   * Calls `setGroup()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  group?: string;\n  /**\n   * If true, this notification becomes the summary for a group of\n   * notifications.\n   *\n   * Calls `setGroupSummary()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android when using `group`.\n   *\n   * @since 1.0.0\n   */\n  groupSummary?: string;\n  /**\n   * Set extra data to store within this notification.\n   *\n   * @since 1.0.0\n   */\n  extra?: any;\n  /**\n   * If true, the notification can't be swiped away.\n   *\n   * Calls `setOngoing()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  ongoing?: boolean;\n  /**\n   * If true, the notification is canceled when the user clicks on it.\n   *\n   * Calls `setAutoCancel()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  autoCancel?: boolean;\n  /**\n   * Sets a multiline text block for display in a big text notification style.\n   *\n   * @since 1.0.0\n   */\n  largeBody?: string;\n  /**\n   * Used to set the summary text detail in inbox and big text notification styles.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  summaryText?: string;\n  /**\n   * Set a custom status bar icon.\n   *\n   * If set, this overrides the `smallIcon` option from Capacitor\n   * configuration.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  smallIcon?: string;\n  /**\n   * Set a large icon for notifications.\n   *\n   * Icons should be placed in your app's `res/drawable` folder. The value for\n   * this option should be the drawable resource ID, which is the filename\n   * without an extension.\n   *\n   * Only available for Android.\n   *\n   * @since 1.0.0\n   */\n  largeIcon?: string;\n  /**\n   * Specifies the channel the notification should be delivered on.\n   *\n   * If channel with the given name does not exist then the notification will\n   * not fire. If not provided, it will use the default channel.\n   *\n   * Calls `setChannelId()` on\n   * [`NotificationCompat.Builder`](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder)\n   * with the provided value.\n   *\n   * Only available for Android 26+.\n   *\n   * @since 1.0.0\n   */\n  channelId?: string;\n}\n\nexport interface AppInfo {\n  /**\n   * The name of the app.\n   *\n   * @since 1.0.0\n   */\n  name: string;\n\n  /**\n   * The identifier of the app.\n   * On iOS it's the Bundle Identifier.\n   * On Android it's the Application ID\n   *\n   * @since 1.0.0\n   */\n  id: string;\n\n  /**\n   * The build version.\n   * On iOS it's the CFBundleVersion.\n   * On Android it's the versionCode.\n   *\n   * @since 1.0.0\n   */\n  build: string;\n\n  /**\n   * The app version.\n   * On iOS it's the CFBundleShortVersionString.\n   * On Android it's package's versionName.\n   *\n   * @since 1.0.0\n   */\n  version: string;\n}\n\nexport interface AppState {\n  /**\n   * Whether the app is active or not.\n   *\n   * @since 1.0.0\n   */\n  isActive: boolean;\n}\n\n/**\n * Get access to device location information.\n *\n * @since 1.0.0\n */\nexport interface CapacitorGeolocation {\n  /**\n   * Get the device's last known location\n   * @since 1.0.0\n   */\n  getCurrentPosition: () => GetCurrentPositionResult;\n}\n\n/**\n * A simple string key / value store backed by UserDefaults on iOS and Shared Preferences on Android.\n */\nexport interface CapacitorKV {\n  /**\n   * Set a string value with the given key.\n   *\n   * @param key\n   * @param value\n   * @returns\n   * @since 1.0.0\n   */\n  set: (key: string, value: string) => void;\n  /**\n   * Get a string value for the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  get: (key: string) => { value: string };\n  /**\n   * Remove a value with the given key.\n   * @param key\n   * @returns\n   * @since 1.0.0\n   */\n  remove: (key: string) => void;\n}\n\n/**\n * Get information on the device, such as network connectivity and battery status.\n */\nexport interface CapacitorDevice {\n  /**\n   * Get the current battery status for the device.\n   *\n   * @since 1.0.0\n   */\n  getBatteryStatus: () => BatteryStatus;\n  /**\n   * Get the current network status for the device.\n   *\n   * @since 1.0.0\n   */\n  getNetworkStatus: () => NetworkStatus;\n}\n\n/**\n * Send basic local notifications.\n */\nexport interface CapacitorNotifications {\n  /**\n   * Schedule a local notification\n   * @example `CapacitorNotifications.schedule()`\n   * @param options\n   * @returns void\n   * @since 1.0.0\n   */\n  schedule: (options: NotificationScheduleOptions[]) => void;\n  /**\n   * Set the application badge count\n   * @example `CapacitorNotifications.setBadge({...})`\n   * @param options\n   * @returns void\n   * @since 2.0.0\n   */\n  setBadge: (options: NotificationBadgeOptions) => void;\n  /**\n   * Clears the application badge count\n   * @example `CapacitorNotifications.clearBadge()`\n   * @returns void\n   * @since 2.0.0\n   */\n  clearBadge: () => void;\n}\n\n/**\n * Interact with a watch paired with this app\n *\n * sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapacitorWatch Watch application.\n * They could be used if a native watch app is developed as a companion app to a Capacitor app\n */\nexport interface CapacitorWatch {\n  /**\n   * Sends a message to the watch with the sendMessage() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  sendMessage: (options: []) => void;\n  /**\n   * Sends information to the watch with the transferUserInfo() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  transferUserInfo: (options: []) => void;\n  /**\n   * Updates the application context on the watch with the updateApplicationContext() WCSession delegate method\n   *\n   * This has no effect on a CapacitorWatch watch app\n   */\n  updateApplicationContext: (options: []) => void;\n  /**\n   * Checks to see if the compaion watch is reachable\n   */\n  isReachable: boolean;\n  /**\n   * Replaces the current UI on the watch with what is specified here.\n   * @param options the new WatchUI you want to show on the watch\n   * @returns void\n   */\n  updateWatchUI: (options: { watchUI: string }) => void;\n  /**\n   * Updates the data the watch is using to display variables in text and button fields\n   * @param options the new data to send to the watch\n   * @returns void\n   */\n  updateWatchData: (options: { data: { [key: string]: string } }) => void;\n}\n\nexport interface CapacitorApp {\n  getState: () => AppState;\n  getInfo: () => AppInfo;\n}\n\nexport interface CapacitorAPI {\n  CapacitorDevice: CapacitorDevice;\n  CapacitorKV: CapacitorKV;\n  CapacitorNotifications: CapacitorNotifications;\n  CapacitorGeolocation: CapacitorGeolocation;\n  CapacitorWatch: CapacitorWatch;\n  CapacitorApp: CapacitorApp;\n}\n"]}

package/ios/Plugin/BackgroundRunner.swift

@@ -6,22 +6,22 @@ import JavaScriptCore
 public class BackgroundRunner {
     public static let shared = BackgroundRunner()
     public var config: RunnerConfig?
-    
+
     private var runner = Runner()
 
     public init() {
         do {
-            config = try self.loadRunnerConfig()            
+            config = try self.loadRunnerConfig()
         } catch {
             print("could not initialize BackgroundRunner: \(error)")
         }
     }
-    
+
     public func scheduleBackgroundTasks() throws {
         guard let config = config else {
             throw BackgroundRunnerPluginError.noRunnerConfig
         }
-        
+
         if !config.autoSchedule {
             return
         }
@@ -52,13 +52,17 @@ public class BackgroundRunner {
                 _ = try BackgroundRunner.shared.execute(config: config)
 
                 task.setTaskCompleted(success: true)
+
+                if config.repeats {
+                    try self.scheduleBackgroundTasks()
+                }
             } catch {
                 print("background task error: \(error)")
                 task.setTaskCompleted(success: false)
             }
         }
     }
-    
+
     // swiftlint:disable:next cyclomatic_complexity function_body_length
     public func execute(config: RunnerConfig, inputArgs: [String: Any]? = nil, callbackId: String? = nil) throws -> [String: Any]? {
         do {
@@ -130,7 +134,6 @@ public class BackgroundRunner {
             try context.dispatchEvent(event: config.event, details: args)
 
             waitGroup.wait()
-            
 
             if let rejection = rejectionErr {
                 throw EngineError.jsException(details: rejection.message)

package/ios/Plugin/BackgroundRunnerPlugin.swift

@@ -13,7 +13,7 @@ public class BackgroundRunnerPlugin: CAPPlugin {
             name: UIApplication.didEnterBackgroundNotification,
             object: nil
         )
-        
+
         initWatchConnectivity()
     }
 
@@ -64,7 +64,7 @@ public class BackgroundRunnerPlugin: CAPPlugin {
             guard var config = impl.config else {
                 throw BackgroundRunnerPluginError.noRunnerConfig
             }
-            
+
             config.event = runnerEvent
 
             // swiftlint:disable:next unowned_variable_capture
@@ -116,7 +116,7 @@ public class BackgroundRunnerPlugin: CAPPlugin {
             completionHandler(.failure(BackgroundRunnerPluginError.invalidArgument(reason: "event is missing or invalid")))
             return
         }
-        
+
         var args: [String: Any] = [:]
 
         eventArgs.forEach { (key: AnyHashable, value: Any) in

package/ios/Plugin/CapacitorAPI/App.swift

@@ -0,0 +1,31 @@
+import Foundation
+import UIKit
+import JavaScriptCore
+
+@objc protocol CapacitorAppExports: JSExport {
+    static func getInfo() -> [String: Any]?
+    static func getState() -> [String: Any]
+}
+
+class CapacitorApp: NSObject, CapacitorAppExports {
+    static func getInfo() -> [String: Any]? {
+        if let info = Bundle.main.infoDictionary {
+            return [
+                "name": info["CFBundleDisplayName"] as? String ?? "",
+                "id": info["CFBundleIdentifier"] as? String ?? "",
+                "build": info["CFBundleVersion"] as? String ?? "",
+                "version": info["CFBundleShortVersionString"] as? String ?? ""
+            ]
+        }
+
+        return nil
+    }
+
+    static func getState() -> [String: Any] {
+        DispatchQueue.main.sync {
+            return [
+                "isActive": UIApplication.shared.applicationState == UIApplication.State.active
+            ]
+        }
+    }
+}

package/ios/Plugin/CapacitorAPI/KV.swift

@@ -16,7 +16,7 @@ class CapacitorKVStore: NSObject, CapacitorKVStoreExports {
         guard let value = UserDefaults.standard.string(forKey: key) else {
             return JSValue(nullIn: JSContext.current())
         }
-        
+
         var valueWrapper: [String: String] = [:]
         valueWrapper["value"] = value
 

package/ios/Plugin/CapacitorAPI/Notifications.swift

@@ -8,6 +8,18 @@ enum CapacitorNotificationsErrors: Error, Equatable {
     case permissionDenied
 }
 
+struct SetBadgeOption {
+    let count: Int
+
+    init(from dict: [String: Any?]) {
+        if let optionsCount = dict["count"] as? Int {
+            count = optionsCount
+        } else {
+            count = 0
+        }
+    }
+}
+
 struct NotificationOption {
     let id: Int
     let title: String
@@ -52,6 +64,8 @@ struct NotificationOption {
 
 @objc protocol CapacitorNotificationsExports: JSExport {
     static func schedule(_ options: JSValue)
+    static func setBadge(_ options: JSValue)
+    static func clearBadge()
 }
 
 class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
@@ -164,4 +178,50 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
             JSContext.current().exception = JSValue(newErrorFromMessage: "\(error)", in: JSContext.current())
         }
     }
+
+    static func setBadge(_ options: JSValue) {
+        do {
+            if CapacitorNotifications.checkPermission() != "granted" {
+                throw CapacitorNotificationsErrors.permissionDenied
+            }
+
+            if options.isUndefined || options.isNull {
+                throw CapacitorNotificationsErrors.invalidOptions(reason: "options are null")
+            }
+
+            guard let jsonDict = options.toDictionary() as? [String: Any?] else {
+                throw CapacitorNotificationsErrors.invalidOptions(reason: "options must be an valid object")
+            }
+
+            let badgeOptions = SetBadgeOption(from: jsonDict)
+
+            DispatchQueue.main.sync {
+                if #available(iOS 16.0, *) {
+                    UNUserNotificationCenter.current().setBadgeCount(badgeOptions.count)
+                } else {
+                    UIApplication.shared.applicationIconBadgeNumber = badgeOptions.count
+                }
+            }
+        } catch {
+            JSContext.current().exception = JSValue(newErrorFromMessage: "\(error)", in: JSContext.current())
+        }
+    }
+
+    static func clearBadge() {
+        do {
+            if CapacitorNotifications.checkPermission() != "granted" {
+                throw CapacitorNotificationsErrors.permissionDenied
+            }
+
+            DispatchQueue.main.sync {
+                if #available(iOS 16.0, *) {
+                    UNUserNotificationCenter.current().setBadgeCount(0)
+                } else {
+                    UIApplication.shared.applicationIconBadgeNumber = 0
+                }
+            }
+        } catch {
+            JSContext.current().exception = JSValue(newErrorFromMessage: "\(error)", in: JSContext.current())
+        }
+    }
 }

package/ios/Plugin/Context+CapacitorAPI.swift

@@ -7,5 +7,6 @@ extension Context {
         jsContext.setObject(CapacitorWatch(), forKeyedSubscript: "CapacitorWatch" as NSString)
         jsContext.setObject(CapacitorNotifications.self, forKeyedSubscript: "CapacitorNotifications" as NSString)
         jsContext.setObject(CapacitorDevice(), forKeyedSubscript: "CapacitorDevice" as NSString)
+        jsContext.setObject(CapacitorApp.self, forKeyedSubscript: "CapacitorApp" as NSString)
     }
 }

package/ios/Plugin/RunnerConfig.swift

@@ -6,7 +6,7 @@ public struct RunnerConfig {
     let src: String
     var autoSchedule: Bool
     var event: String
-    let repeats: Bool?
+    let repeats: Bool
     let enableWatchConnectivity: Bool
 
     let interval: Int?
@@ -28,7 +28,7 @@ public struct RunnerConfig {
         self.label = label
         self.src = src
         self.event = event
-        self.repeats = repeats
+        self.repeats = repeats ?? false
         self.interval = interval
         self.autoSchedule = autoStart ?? false
         self.enableWatchConnectivity = jsObject["enableWatchConnectivity"] as? Bool ?? false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/background-runner",
-  "version": "1.1.0",
+  "version": "2.1.0",
   "description": "Capacitor Background Runner",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -49,11 +49,11 @@
     "postinstall": "node ./scripts/install_libs.js"
   },
   "devDependencies": {
-    "@capacitor/android": "^5.2.2",
-    "@capacitor/cli": "^5.2.2",
-    "@capacitor/core": "^5.2.2",
-    "@capacitor/docgen": "^0.0.18",
-    "@capacitor/ios": "^5.2.2",
+    "@capacitor/android": "^6.0.0",
+    "@capacitor/cli": "^6.0.0",
+    "@capacitor/core": "^6.0.0",
+    "@capacitor/docgen": "^0.2.2",
+    "@capacitor/ios": "^6.0.0",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "^1.0.1",
     "@ionic/swiftlint-config": "^1.1.2",
@@ -66,7 +66,7 @@
     "typescript": "^5.1.6"
   },
   "peerDependencies": {
-    "@capacitor/core": "^5.0.0"
+    "@capacitor/core": "^6.0.0 || ^7.0.0"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",
@@ -81,5 +81,5 @@
       "src": "android"
     }
   },
-  "gitHead": "83f21e30fc631fb22467bf9f46be28e79b33be71"
+  "gitHead": "448ba72151718509470463daca43b69e3e86bc9c"
 }