@capacitor/background-runner 1.0.4 → 1.0.5-dev-20230817T150324.0

package/README.md

@@ -417,4 +417,21 @@ Get access to device location information.
 | **`speed`**            | <code>number \| null</code> | The speed the user is traveling (if available)                                                                        | 1.0.0 |
 | **`heading`**          | <code>number \| null</code> | The heading the user is facing (if available)                                                                         | 1.0.0 |
 
+
+#### CapcacitorWatch
+
+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.
+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                                                                          |
+
 </capacitor-api-docs>

package/android/src/main/AndroidManifest.xml

@@ -6,6 +6,6 @@
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
 
     <application>
-        <receiver android:name=".api.TimedNotificationPublisher" />
+        <receiver android:name="io.ionic.backgroundrunner.plugin.api.TimedNotificationPublisher" />
     </application>
 </manifest>

package/dist/docs-api.json

@@ -41,6 +41,15 @@
           "CapacitorGeolocation"
         ],
         "type": "CapacitorGeolocation"
+      },
+      {
+        "name": "CapacitorWatch",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "CapcacitorWatch"
+        ],
+        "type": "CapcacitorWatch"
       }
     ]
   },
@@ -580,6 +589,75 @@
           "type": "number | null"
         }
       ]
+    },
+    {
+      "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",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "sendMessage",
+          "tags": [],
+          "docs": "Sends a message to the watch with the sendMessage() WCSession delegate method\n\nThis has no effect on a CapacitorWatch watch app",
+          "complexTypes": [],
+          "type": "(options: []) => void"
+        },
+        {
+          "name": "transferUserInfo",
+          "tags": [],
+          "docs": "Sends information to the watch with the transferUserInfo() WCSession delegate method\n\nThis has no effect on a CapacitorWatch watch app",
+          "complexTypes": [],
+          "type": "(options: []) => void"
+        },
+        {
+          "name": "updateApplicationContext",
+          "tags": [],
+          "docs": "Updates the application context on the watch with the updateApplicationContext() WCSession delegate method\n\nThis has no effect on a CapacitorWatch watch app",
+          "complexTypes": [],
+          "type": "(options: []) => void"
+        },
+        {
+          "name": "isReachable",
+          "tags": [],
+          "docs": "Checks to see if the compaion watch is reachable",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "updateWatchUI",
+          "tags": [
+            {
+              "text": "options the new WatchUI you want to show on the watch",
+              "name": "param"
+            },
+            {
+              "text": "void",
+              "name": "returns"
+            }
+          ],
+          "docs": "Replaces the current UI on the watch with what is specified here.",
+          "complexTypes": [],
+          "type": "(options: { watchUI: string; }) => void"
+        },
+        {
+          "name": "updateWatchData",
+          "tags": [
+            {
+              "text": "options the new data to send to the watch",
+              "name": "param"
+            },
+            {
+              "text": "void",
+              "name": "returns"
+            }
+          ],
+          "docs": "Updates the data the watch is using to display variables in text and button fields",
+          "complexTypes": [],
+          "type": "(options: { data: { [key: string]: string; }; }) => void"
+        }
+      ]
     }
   ],
   "enums": [],

package/dist/esm/apis.d.ts

@@ -309,9 +309,58 @@ export interface CapacitorNotifications {
      */
     schedule: (options: NotificationScheduleOptions[]) => 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.
+ * They could be used if a native watch app is developed as a companion app to a Capacitor app
+ */
+export interface CapcacitorWatch {
+    /**
+     * Sends a message to the watch with the sendMessage() WCSession delegate method
+     *
+     * This has no effect on a CapacitorWatch watch app
+     */
+    sendMessage: (options: []) => void;
+    /**
+     * Sends information to the watch with the transferUserInfo() WCSession delegate method
+     *
+     * This has no effect on a CapacitorWatch watch app
+     */
+    transferUserInfo: (options: []) => void;
+    /**
+     * Updates the application context on the watch with the updateApplicationContext() WCSession delegate method
+     *
+     * This has no effect on a CapacitorWatch watch app
+     */
+    updateApplicationContext: (options: []) => void;
+    /**
+     * Checks to see if the compaion watch is reachable
+     */
+    isReachable: boolean;
+    /**
+     * Replaces the current UI on the watch with what is specified here.
+     * @param options the new WatchUI you want to show on the watch
+     * @returns void
+     */
+    updateWatchUI: (options: {
+        watchUI: string;
+    }) => void;
+    /**
+     * Updates the data the watch is using to display variables in text and button fields
+     * @param options the new data to send to the watch
+     * @returns void
+     */
+    updateWatchData: (options: {
+        data: {
+            [key: string]: string;
+        };
+    }) => void;
+}
 export interface CapacitorAPI {
     CapacitorDevice: CapacitorDevice;
     CapacitorKV: CapacitorKV;
     CapacitorNotifications: CapacitorNotifications;
     CapacitorGeolocation: CapacitorGeolocation;
+    CapacitorWatch: CapcacitorWatch;
 }

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  getCurrentLocation: () => 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) => 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\nexport interface CapacitorAPI {\n  CapacitorDevice: CapacitorDevice;\n  CapacitorKV: CapacitorKV;\n  CapacitorNotifications: CapacitorNotifications;\n  CapacitorGeolocation: CapacitorGeolocation;\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 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  getCurrentLocation: () => 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) => 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"]}

package/ios/Plugin/BackgroundRunner.swift

@@ -116,6 +116,7 @@ public class BackgroundRunner {
 
             var err: Error?
 
+            // swiftlint:disable:next unowned_variable_capture
             DispatchQueue.global(qos: .userInitiated).async { [unowned self] in
                 do {
                     _ = try self.execute(config: config, event: event, inputArgs: inputArgs)
@@ -135,6 +136,7 @@ public class BackgroundRunner {
         }
     }
 
+    // swiftlint:disable:next cyclomatic_complexity function_body_length
     public func execute(config: RunnerConfig, event: String, inputArgs: [String: Any]? = nil) throws -> [String: Any]? {
         do {
             if !started {

package/ios/Plugin/BackgroundRunnerPlugin.swift

@@ -64,6 +64,7 @@ public class BackgroundRunnerPlugin: CAPPlugin {
                 throw BackgroundRunnerPluginError.runnerError(reason: "no runner config loaded")
             }
 
+            // swiftlint:disable:next unowned_variable_capture
             DispatchQueue.global(qos: .userInitiated).async { [unowned self] in
                 do {
                     let result = try self.impl.execute(

package/ios/Plugin/CapacitorAPI/Notifications.swift

@@ -100,6 +100,7 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
         }
     }
 
+    // swiftlint:disable:next cyclomatic_complexity
     static func schedule(_ options: JSValue) {
         do {
             if CapacitorNotifications.checkPermission() != "granted" {
@@ -150,6 +151,7 @@ class CapacitorNotifications: NSObject, CapacitorNotificationsExports {
                     }
 
                     let dateInfo = Calendar.current.dateComponents(in: TimeZone.current, from: notificationDate)
+                    // swiftlint:disable:next force_unwrapping
                     let dateInterval = DateInterval(start: Date(), end: dateInfo.date!)
 
                     let trigger = UNTimeIntervalNotificationTrigger(timeInterval: dateInterval.duration, repeats: false)

package/ios/Plugin/CapacitorAPI/Reachability.swift

@@ -251,6 +251,7 @@ public extension Reachability {
 fileprivate extension Reachability {
 
     func setReachabilityFlags() throws {
+        // swiftlint:disable:next unowned_variable_capture
         try reachabilitySerialQueue.sync { [unowned self] in
             var flags = SCNetworkReachabilityFlags()
             if !SCNetworkReachabilityGetFlags(self.reachabilityRef, &flags) {
@@ -265,6 +266,7 @@ fileprivate extension Reachability {
     func notifyReachabilityChanged() {
         let notify = { [weak self] in
             guard let self = self else { return }
+            // swiftlint:disable:next void_function_in_ternary
             self.connection != .unavailable ? self.whenReachable?(self) : self.whenUnreachable?(self)
             self.notificationCenter.post(name: .reachabilityChanged, object: self)
         }

package/ios/Plugin/CapacitorAPI/Watch.swift

@@ -0,0 +1,89 @@
+import Foundation
+import JavaScriptCore
+import WatchConnectivity
+
+@objc protocol CapacitorWatchExports: JSExport {
+    func sendMessage(_ dataDict: JSValue) -> JSValue
+    func transferUserInfo(_ userInfo: JSValue) -> JSValue
+    func updateApplicationContext(_ appContext: JSValue) -> JSValue
+    func isReachable() -> JSValue
+    func updateWatchUI(_ call: JSValue)
+    func updateWatchData(_ call: JSValue)
+}
+
+// swiftlint:disable:next identifier_name
+public let UI_KEY = "watchUI"
+// swiftlint:disable:next identifier_name
+public let DATA_KEY = "viewData"
+
+class CapacitorWatch: NSObject, CapacitorWatchExports {
+    func sendMessage(_ dataDict: JSValue) -> JSValue {
+        let dict = jsValueToDict(dataDict)
+
+        WCSession.default.sendMessage(dict, replyHandler: nil)
+
+        return JSValue(undefinedIn: JSContext.current())
+    }
+
+    func transferUserInfo(_ userInfo: JSValue) -> JSValue {
+        let dict = jsValueToDict(userInfo)
+
+        WCSession.default.transferUserInfo(dict)
+
+        return JSValue(undefinedIn: JSContext.current())
+    }
+
+    func updateApplicationContext(_ appContext: JSValue) -> JSValue {
+        let dict = jsValueToDict(appContext)
+
+        try? WCSession.default.updateApplicationContext(dict)
+
+        return JSValue(undefinedIn: JSContext.current())
+    }
+
+    func isReachable() -> JSValue {
+        if WCSession.default.isReachable {
+            return JSValue(bool: true, in: JSContext.current())
+        }
+
+        return JSValue(bool: false, in: JSContext.current())
+    }
+
+    func updateWatchUI(_ call: JSValue) {
+        let dict = jsValueToDict(call)
+
+        guard let newUI = dict["data"] as? [String: String] else {
+            return
+        }
+
+        WCSession.default.transferUserInfo([UI_KEY: newUI])
+    }
+
+    func updateWatchData(_ call: JSValue) {
+        let dict = jsValueToDict(call)
+
+        guard let newData = dict["data"] as? [String: String] else {
+            return
+        }
+
+        WCSession.default.transferUserInfo([DATA_KEY: newData])
+    }
+
+    fileprivate func jsValueToDict(_ jsVal: JSValue) -> [String: Any] {
+        var dict: [String: Any] = [:]
+
+        if jsVal.isObject {
+            if let convertedDict = jsVal.toDictionary() as? [String: Any] {
+                dict = convertedDict
+            }
+        }
+
+        return dict
+    }
+}
+
+enum WatchDataError: Error {
+    case JSValIsNotObject
+    // swiftlint:disable:next identifier_name
+    case CouldNotConvertJSVal
+}

package/ios/Plugin/Context+CapacitorAPI.swift

@@ -4,7 +4,7 @@ extension Context {
     public func setupCapacitorAPI() {
         ctx.setObject(CapacitorKVStore.self, forKeyedSubscript: "CapacitorKV" as NSString)
         ctx.setObject(CapacitorGeolocation(context: self), forKeyedSubscript: "CapacitorGeolocation" as NSString)
-        ctx.setObject(CapacitorWearable(), forKeyedSubscript: "CapacitorWearable" as NSString)
+        ctx.setObject(CapacitorWatch(), forKeyedSubscript: "CapacitorWatch" as NSString)
         ctx.setObject(CapacitorNotifications.self, forKeyedSubscript: "CapacitorNotifications" as NSString)
         ctx.setObject(CapacitorDevice(), forKeyedSubscript: "CapacitorDevice" as NSString)
     }

package/ios/Plugin/WatchConnectivtySessionDelegate.swift

@@ -18,6 +18,8 @@ extension BackgroundRunnerPlugin: WCSessionDelegate {
         try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_sessionDidDeactivate", inputArgs: nil)
     }
 
+    // DCG Note - documentation for these events are contained within the CapacitorWatch documentation
+
     public func session(_ session: WCSession, didReceiveUserInfo userInfo: [String: Any] = [:]) {
         var args: [String: Any] = [:]
         args["userInfo"] = userInfo
@@ -31,4 +33,11 @@ extension BackgroundRunnerPlugin: WCSessionDelegate {
 
         try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_didReceiveMessage", inputArgs: args)
     }
+
+    public func session(_ session: WCSession, didReceiveApplicationContext applicationContext: [String: Any]) {
+        var args: [String: Any] = [:]
+        args["message"] = applicationContext
+
+        try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_didReceiveApplicationContext", inputArgs: args)
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/background-runner",
-  "version": "1.0.4",
+  "version": "1.0.5-dev-20230817T150324.0",
   "description": "Capacitor Background Runner",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -81,5 +81,5 @@
       "src": "android"
     }
   },
-  "gitHead": "0a4b537b808187cb2c9de0d1ac597949c8fff958"
+  "gitHead": "418d7338b1b483896e0b55636a364d9ff678ca41"
 }

package/ios/Plugin/CapacitorAPI/Wearable.swift

@@ -1,48 +0,0 @@
-import Foundation
-import JavaScriptCore
-import WatchConnectivity
-
-@objc protocol CapacitorWearableExports: JSExport {
-    func send(_ dataDict: JSValue) -> JSValue
-    func transferUserInfo(_ userInfo: JSValue) -> JSValue
-    func isReachable() -> JSValue
-}
-
-class CapacitorWearable: NSObject, CapacitorWearableExports {
-    func send(_ dataDict: JSValue) -> JSValue {
-        var dict: [String: Any] = [:]
-
-        if dataDict.isObject {
-            if let convertedDict = dataDict.toDictionary() as? [String: Any] {
-                dict = convertedDict
-            }
-        }
-
-        WCSession.default.sendMessage(dict, replyHandler: nil)
-
-        return JSValue(undefinedIn: JSContext.current())
-    }
-
-    func transferUserInfo(_ userInfo: JSValue) -> JSValue {
-        var dict: [String: Any] = [:]
-
-        if userInfo.isObject {
-            if let convertedDict = userInfo.toDictionary() as? [String: Any] {
-                dict = convertedDict
-            }
-        }
-
-        _ = WCSession.default.transferUserInfo(dict)
-
-        return JSValue(undefinedIn: JSContext.current())
-    }
-
-    func isReachable() -> JSValue {
-        if WCSession.default.isReachable {
-            return JSValue(bool: true, in: JSContext.current())
-        }
-
-        return JSValue(bool: false, in: JSContext.current())
-    }
-
-}