From bd65c3c9084c0e1ab11a36b18b27ddc1f559d83a Mon Sep 17 00:00:00 2001 From: OS-pedrogustavobilro Date: Thu, 20 Aug 2026 11:18:03 +0100 Subject: [PATCH 1/2] docs: Update plugin documentation --- docs/apis/calendar.md | 2 +- docs/apis/contacts.md | 2 +- docs/apis/local-notifications.md | 25 +++++++++++++++++++ versioned_docs/version-v8/apis/calendar.md | 2 +- versioned_docs/version-v8/apis/contacts.md | 2 +- versioned_docs/version-v8/apis/file-viewer.md | 2 +- .../version-v8/apis/local-notifications.md | 25 +++++++++++++++++++ 7 files changed, 55 insertions(+), 5 deletions(-) diff --git a/docs/apis/calendar.md b/docs/apis/calendar.md index d69289aaa..6ba42e488 100644 --- a/docs/apis/calendar.md +++ b/docs/apis/calendar.md @@ -8,7 +8,7 @@ sidebar_label: Calendar # @capacitor/calendar -Create, find, modify and remove events in the device calendar. +Create, find, modify and remove events in the device calendar. Not available on web. ## Install diff --git a/docs/apis/contacts.md b/docs/apis/contacts.md index a65581165..d783a3b15 100644 --- a/docs/apis/contacts.md +++ b/docs/apis/contacts.md @@ -8,7 +8,7 @@ sidebar_label: Contacts # @capacitor/contacts -Access, search, pick, create, update and remove device contacts. +Access, search, pick, create, update and remove device contacts. Not available on web. ## Install diff --git a/docs/apis/local-notifications.md b/docs/apis/local-notifications.md index 728788ff7..df4d90e8f 100644 --- a/docs/apis/local-notifications.md +++ b/docs/apis/local-notifications.md @@ -97,6 +97,31 @@ export default config; If the device has entered [Doze](https://developer.android.com/training/monitoring-device-state/doze-standby) mode, your application may have restricted capabilities. If you need your notification to fire even during Doze, schedule your notification by using `allowWhileIdle: true`. Make use of `allowWhileIdle` judiciously, as these notifications [can only fire once per 9 minutes, per app.](https://developer.android.com/training/monitoring-device-state/doze-standby#assessing_your_app) +## Errors + +Starting on version 8.3.0, the plugin returns structured errors on Android and iOS. Each error has a `code` (e.g. `OS-PLUG-LNOT-0001`) and a `message` with a human-readable description. Codes 0001, 0002, 0005, 0006, 0011 and 0012 mean the same thing on both platforms; every other code is platform-specific. + +| Error code | Platform(s) | Description | +|---|---|---| +| OS-PLUG-LNOT-0001 | Android, iOS | Must provide a notifications array as the notifications option. | +| OS-PLUG-LNOT-0002 | Android, iOS | Notification is missing an identifier. | +| OS-PLUG-LNOT-0003 | iOS | Unable to build the notification content. | +| OS-PLUG-LNOT-0004 | iOS | Unable to create the notification, trigger construction failed. | +| OS-PLUG-LNOT-0005 | Android, iOS | Notifications are not enabled on this device. | +| OS-PLUG-LNOT-0006 | Android, iOS | Invalid color provided. Must be a hex string (e.g. #ff0000). | +| OS-PLUG-LNOT-0007 | Android | Provided notification format is invalid. | +| OS-PLUG-LNOT-0008 | Android | Invalid date format sent to the plugin. | +| OS-PLUG-LNOT-0009 | Android | The identifier must be a 32-bit integer. | +| OS-PLUG-LNOT-0010 | iOS | Unable to schedule the notification. | +| OS-PLUG-LNOT-0011 | Android, iOS | Expected notifications to be a list of notification objects. | +| OS-PLUG-LNOT-0012 | Android, iOS | Must provide an ids array. | +| OS-PLUG-LNOT-0013 | iOS | Unable to request notification permission. | +| OS-PLUG-LNOT-0014 | Android | Invalid JSON object sent to the plugin. | +| OS-PLUG-LNOT-0015 | Android | Channel is missing an identifier. | +| OS-PLUG-LNOT-0016 | Android | Channel is missing a name. | +| OS-PLUG-LNOT-0017 | Android | Unable to schedule an exact alarm due to lack of permissions. Scheduled as an inexact alarm instead. | +| OS-PLUG-LNOT-0018 | Android | Unable to schedule an exact alarm due to lack of permissions. | + ## API diff --git a/versioned_docs/version-v8/apis/calendar.md b/versioned_docs/version-v8/apis/calendar.md index d69289aaa..6ba42e488 100644 --- a/versioned_docs/version-v8/apis/calendar.md +++ b/versioned_docs/version-v8/apis/calendar.md @@ -8,7 +8,7 @@ sidebar_label: Calendar # @capacitor/calendar -Create, find, modify and remove events in the device calendar. +Create, find, modify and remove events in the device calendar. Not available on web. ## Install diff --git a/versioned_docs/version-v8/apis/contacts.md b/versioned_docs/version-v8/apis/contacts.md index a65581165..d783a3b15 100644 --- a/versioned_docs/version-v8/apis/contacts.md +++ b/versioned_docs/version-v8/apis/contacts.md @@ -8,7 +8,7 @@ sidebar_label: Contacts # @capacitor/contacts -Access, search, pick, create, update and remove device contacts. +Access, search, pick, create, update and remove device contacts. Not available on web. ## Install diff --git a/versioned_docs/version-v8/apis/file-viewer.md b/versioned_docs/version-v8/apis/file-viewer.md index a1fafeea5..dc423eced 100644 --- a/versioned_docs/version-v8/apis/file-viewer.md +++ b/versioned_docs/version-v8/apis/file-viewer.md @@ -224,6 +224,6 @@ The plugin returns the following errors with specific codes on native Android an | OS-PLUG-FLVW-0008 | Android, iOS | Could not open the file. | | OS-PLUG-FLVW-0009 | Android, iOS | Invalid parameters. | | OS-PLUG-FLVW-0010 | Android | There is no app to open this file. | -| OS-PLUG-FLVW-0011 | iOS | Cordova / Capacitor bridge isn’t initialized. | +| OS-PLUG-FLVW-0011 | iOS | Capacitor bridge isn’t initialized. | | OS-PLUG-FLVW-0012 | iOS | The download failed. | | OS-PLUG-FLVW-0013 | iOS | The file has no extension. | \ No newline at end of file diff --git a/versioned_docs/version-v8/apis/local-notifications.md b/versioned_docs/version-v8/apis/local-notifications.md index 728788ff7..df4d90e8f 100644 --- a/versioned_docs/version-v8/apis/local-notifications.md +++ b/versioned_docs/version-v8/apis/local-notifications.md @@ -97,6 +97,31 @@ export default config; If the device has entered [Doze](https://developer.android.com/training/monitoring-device-state/doze-standby) mode, your application may have restricted capabilities. If you need your notification to fire even during Doze, schedule your notification by using `allowWhileIdle: true`. Make use of `allowWhileIdle` judiciously, as these notifications [can only fire once per 9 minutes, per app.](https://developer.android.com/training/monitoring-device-state/doze-standby#assessing_your_app) +## Errors + +Starting on version 8.3.0, the plugin returns structured errors on Android and iOS. Each error has a `code` (e.g. `OS-PLUG-LNOT-0001`) and a `message` with a human-readable description. Codes 0001, 0002, 0005, 0006, 0011 and 0012 mean the same thing on both platforms; every other code is platform-specific. + +| Error code | Platform(s) | Description | +|---|---|---| +| OS-PLUG-LNOT-0001 | Android, iOS | Must provide a notifications array as the notifications option. | +| OS-PLUG-LNOT-0002 | Android, iOS | Notification is missing an identifier. | +| OS-PLUG-LNOT-0003 | iOS | Unable to build the notification content. | +| OS-PLUG-LNOT-0004 | iOS | Unable to create the notification, trigger construction failed. | +| OS-PLUG-LNOT-0005 | Android, iOS | Notifications are not enabled on this device. | +| OS-PLUG-LNOT-0006 | Android, iOS | Invalid color provided. Must be a hex string (e.g. #ff0000). | +| OS-PLUG-LNOT-0007 | Android | Provided notification format is invalid. | +| OS-PLUG-LNOT-0008 | Android | Invalid date format sent to the plugin. | +| OS-PLUG-LNOT-0009 | Android | The identifier must be a 32-bit integer. | +| OS-PLUG-LNOT-0010 | iOS | Unable to schedule the notification. | +| OS-PLUG-LNOT-0011 | Android, iOS | Expected notifications to be a list of notification objects. | +| OS-PLUG-LNOT-0012 | Android, iOS | Must provide an ids array. | +| OS-PLUG-LNOT-0013 | iOS | Unable to request notification permission. | +| OS-PLUG-LNOT-0014 | Android | Invalid JSON object sent to the plugin. | +| OS-PLUG-LNOT-0015 | Android | Channel is missing an identifier. | +| OS-PLUG-LNOT-0016 | Android | Channel is missing a name. | +| OS-PLUG-LNOT-0017 | Android | Unable to schedule an exact alarm due to lack of permissions. Scheduled as an inexact alarm instead. | +| OS-PLUG-LNOT-0018 | Android | Unable to schedule an exact alarm due to lack of permissions. | + ## API From 021f1caf360d2ef9e3f7a088e7945a1f19589bd3 Mon Sep 17 00:00:00 2001 From: OS-pedrogustavobilro Date: Mon, 24 Aug 2026 11:29:34 +0100 Subject: [PATCH 2/2] chore: update v7 docs --- versioned_docs/version-v7/apis/background-runner.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-v7/apis/background-runner.md b/versioned_docs/version-v7/apis/background-runner.md index 04debb371..9eae0814c 100644 --- a/versioned_docs/version-v7/apis/background-runner.md +++ b/versioned_docs/version-v7/apis/background-runner.md @@ -1,7 +1,7 @@ --- title: Background Runner Capacitor Plugin API description: Capacitor Background Runner -custom_edit_url: https://github.com/ionic-team/capacitor-background-runner/blob/2.x/README.md +custom_edit_url: https://github.com/ionic-team/capacitor-background-runner/blob/2.x/packages/capacitor-plugin/README.md editApiUrl: https://github.com/ionic-team/capacitor-background-runner/blob/2.x/packages/capacitor-plugin/src/definitions.ts sidebar_label: Background Runner ---