@capgo/capacitor-updater 4.41.0 → 4.43.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/CapgoCapacitorUpdater.podspec +7 -5
  2. package/Package.swift +40 -0
  3. package/README.md +1913 -303
  4. package/android/build.gradle +41 -8
  5. package/android/proguard-rules.pro +45 -0
  6. package/android/src/main/AndroidManifest.xml +1 -3
  7. package/android/src/main/java/ee/forgr/capacitor_updater/AppLifecycleObserver.java +88 -0
  8. package/android/src/main/java/ee/forgr/capacitor_updater/BundleInfo.java +223 -195
  9. package/android/src/main/java/ee/forgr/capacitor_updater/BundleStatus.java +23 -23
  10. package/android/src/main/java/ee/forgr/capacitor_updater/Callback.java +13 -0
  11. package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +2720 -1242
  12. package/android/src/main/java/ee/forgr/capacitor_updater/CapgoUpdater.java +1854 -0
  13. package/android/src/main/java/ee/forgr/capacitor_updater/CryptoCipher.java +359 -121
  14. package/android/src/main/java/ee/forgr/capacitor_updater/DataManager.java +28 -0
  15. package/android/src/main/java/ee/forgr/capacitor_updater/DelayCondition.java +44 -49
  16. package/android/src/main/java/ee/forgr/capacitor_updater/DelayUntilNext.java +4 -4
  17. package/android/src/main/java/ee/forgr/capacitor_updater/DelayUpdateUtils.java +296 -0
  18. package/android/src/main/java/ee/forgr/capacitor_updater/DeviceIdHelper.java +215 -0
  19. package/android/src/main/java/ee/forgr/capacitor_updater/DownloadService.java +858 -117
  20. package/android/src/main/java/ee/forgr/capacitor_updater/DownloadWorkerManager.java +156 -0
  21. package/android/src/main/java/ee/forgr/capacitor_updater/InternalUtils.java +45 -0
  22. package/android/src/main/java/ee/forgr/capacitor_updater/Logger.java +360 -0
  23. package/android/src/main/java/ee/forgr/capacitor_updater/ShakeDetector.java +72 -0
  24. package/android/src/main/java/ee/forgr/capacitor_updater/ShakeMenu.java +603 -0
  25. package/dist/docs.json +3022 -765
  26. package/dist/esm/definitions.d.ts +1717 -198
  27. package/dist/esm/definitions.js +103 -1
  28. package/dist/esm/definitions.js.map +1 -1
  29. package/dist/esm/history.d.ts +1 -0
  30. package/dist/esm/history.js +283 -0
  31. package/dist/esm/history.js.map +1 -0
  32. package/dist/esm/index.d.ts +3 -2
  33. package/dist/esm/index.js +5 -4
  34. package/dist/esm/index.js.map +1 -1
  35. package/dist/esm/web.d.ts +43 -42
  36. package/dist/esm/web.js +122 -37
  37. package/dist/esm/web.js.map +1 -1
  38. package/dist/plugin.cjs.js +512 -37
  39. package/dist/plugin.cjs.js.map +1 -1
  40. package/dist/plugin.js +512 -37
  41. package/dist/plugin.js.map +1 -1
  42. package/ios/Sources/CapacitorUpdaterPlugin/AES.swift +87 -0
  43. package/ios/Sources/CapacitorUpdaterPlugin/BigInt.swift +55 -0
  44. package/ios/Sources/CapacitorUpdaterPlugin/BundleInfo.swift +177 -0
  45. package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/BundleStatus.swift +12 -12
  46. package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift +2020 -0
  47. package/ios/Sources/CapacitorUpdaterPlugin/CapgoUpdater.swift +1959 -0
  48. package/ios/Sources/CapacitorUpdaterPlugin/CryptoCipher.swift +313 -0
  49. package/ios/Sources/CapacitorUpdaterPlugin/DelayUpdateUtils.swift +257 -0
  50. package/ios/Sources/CapacitorUpdaterPlugin/DeviceIdHelper.swift +120 -0
  51. package/ios/Sources/CapacitorUpdaterPlugin/InternalUtils.swift +392 -0
  52. package/ios/Sources/CapacitorUpdaterPlugin/Logger.swift +310 -0
  53. package/ios/Sources/CapacitorUpdaterPlugin/RSA.swift +274 -0
  54. package/ios/Sources/CapacitorUpdaterPlugin/ShakeMenu.swift +441 -0
  55. package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/UserDefaultsExtension.swift +1 -2
  56. package/package.json +49 -41
  57. package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java +0 -1131
  58. package/ios/Plugin/BundleInfo.swift +0 -113
  59. package/ios/Plugin/CapacitorUpdater.swift +0 -850
  60. package/ios/Plugin/CapacitorUpdaterPlugin.h +0 -10
  61. package/ios/Plugin/CapacitorUpdaterPlugin.m +0 -27
  62. package/ios/Plugin/CapacitorUpdaterPlugin.swift +0 -678
  63. package/ios/Plugin/CryptoCipher.swift +0 -240
  64. /package/{LICENCE → LICENSE} +0 -0
  65. /package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/DelayCondition.swift +0 -0
  66. /package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/DelayUntilNext.swift +0 -0
  67. /package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/Info.plist +0 -0
package/dist/docs.json CHANGED
@@ -7,217 +7,377 @@
7
7
  "methods": [
8
8
  {
9
9
  "name": "notifyAppReady",
10
- "signature": "() => Promise<BundleInfo>",
10
+ "signature": "() => Promise<AppReadyResult>",
11
11
  "parameters": [],
12
- "returns": "Promise<BundleInfo>",
12
+ "returns": "Promise<AppReadyResult>",
13
+ "tags": [
14
+ {
15
+ "name": "returns",
16
+ "text": "Always resolves successfully with current bundle info. This method never fails."
17
+ }
18
+ ],
19
+ "docs": "Notify the native layer that JavaScript initialized successfully.\n\n**CRITICAL: You must call this method on every app launch to prevent automatic rollback.**\n\nThis is a simple notification to confirm that your bundle's JavaScript loaded and executed.\nThe native web server successfully served the bundle files and your JS runtime started.\nThat's all it checks - nothing more complex.\n\n**What triggers rollback:**\n- NOT calling this method within the timeout (default: 10 seconds)\n- Complete JavaScript failure (bundle won't load at all)\n\n**What does NOT trigger rollback:**\n- Runtime errors after initialization (API failures, crashes, etc.)\n- Network request failures\n- Application logic errors\n\n**IMPORTANT: Call this BEFORE any network requests.**\nDon't wait for APIs, data loading, or async operations. Call it as soon as your\nJavaScript bundle starts executing to confirm the bundle itself is valid.\n\nBest practices:\n- Call immediately in your app entry point (main.js, app component mount, etc.)\n- Don't put it after network calls or heavy initialization\n- Don't wrap it in try/catch with conditions\n- Adjust {@link PluginsConfig.CapacitorUpdater.appReadyTimeout} if you need more time",
20
+ "complexTypes": [
21
+ "AppReadyResult"
22
+ ],
23
+ "slug": "notifyappready"
24
+ },
25
+ {
26
+ "name": "setUpdateUrl",
27
+ "signature": "(options: UpdateUrl) => Promise<void>",
28
+ "parameters": [
29
+ {
30
+ "name": "options",
31
+ "docs": "Contains the URL to use for checking for updates.",
32
+ "type": "UpdateUrl"
33
+ }
34
+ ],
35
+ "returns": "Promise<void>",
13
36
  "tags": [
37
+ {
38
+ "name": "param",
39
+ "text": "options Contains the URL to use for checking for updates."
40
+ },
14
41
  {
15
42
  "name": "returns",
16
- "text": "an Promise resolved directly"
43
+ "text": "Resolves when the URL is successfully updated."
17
44
  },
18
45
  {
19
46
  "name": "throws",
20
- "text": "An error if something went wrong"
47
+ "text": "{Error} If `allowModifyUrl` is false or if the operation fails."
48
+ },
49
+ {
50
+ "name": "since",
51
+ "text": "5.4.0"
21
52
  }
22
53
  ],
23
- "docs": "Notify Capacitor Updater that the current bundle is working (a rollback will occur of this method is not called on every app launch)",
54
+ "docs": "Set the update URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.updateUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.\nOtherwise, the URL will reset to the config value on next app launch.",
24
55
  "complexTypes": [
25
- "BundleInfo"
56
+ "UpdateUrl"
26
57
  ],
27
- "slug": "notifyappready"
58
+ "slug": "setupdateurl"
28
59
  },
29
60
  {
30
- "name": "download",
31
- "signature": "(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>",
61
+ "name": "setStatsUrl",
62
+ "signature": "(options: StatsUrl) => Promise<void>",
32
63
  "parameters": [
33
64
  {
34
65
  "name": "options",
35
- "docs": "",
36
- "type": "{ url: string; version: string; sessionKey?: string | undefined; checksum?: string | undefined; }"
66
+ "docs": "Contains the URL to use for sending statistics, or an empty string to disable.",
67
+ "type": "StatsUrl"
37
68
  }
38
69
  ],
39
- "returns": "Promise<BundleInfo>",
70
+ "returns": "Promise<void>",
40
71
  "tags": [
72
+ {
73
+ "name": "param",
74
+ "text": "options Contains the URL to use for sending statistics, or an empty string to disable."
75
+ },
41
76
  {
42
77
  "name": "returns",
43
- "text": "The {@link BundleInfo} for the specified bundle."
78
+ "text": "Resolves when the URL is successfully updated."
44
79
  },
45
80
  {
46
- "name": "param",
47
- "text": "url The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a github tag, any other place you've hosted your bundle.)"
81
+ "name": "throws",
82
+ "text": "{Error} If `allowModifyUrl` is false or if the operation fails."
48
83
  },
84
+ {
85
+ "name": "since",
86
+ "text": "5.4.0"
87
+ }
88
+ ],
89
+ "docs": "Set the statistics URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.statsUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nPass an empty string to disable statistics gathering entirely.\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.",
90
+ "complexTypes": [
91
+ "StatsUrl"
92
+ ],
93
+ "slug": "setstatsurl"
94
+ },
95
+ {
96
+ "name": "setChannelUrl",
97
+ "signature": "(options: ChannelUrl) => Promise<void>",
98
+ "parameters": [
99
+ {
100
+ "name": "options",
101
+ "docs": "Contains the URL to use for channel operations.",
102
+ "type": "ChannelUrl"
103
+ }
104
+ ],
105
+ "returns": "Promise<void>",
106
+ "tags": [
49
107
  {
50
108
  "name": "param",
51
- "text": "version set the version code/name of this bundle/version"
109
+ "text": "options Contains the URL to use for channel operations."
110
+ },
111
+ {
112
+ "name": "returns",
113
+ "text": "Resolves when the URL is successfully updated."
114
+ },
115
+ {
116
+ "name": "throws",
117
+ "text": "{Error} If `allowModifyUrl` is false or if the operation fails."
52
118
  },
119
+ {
120
+ "name": "since",
121
+ "text": "5.4.0"
122
+ }
123
+ ],
124
+ "docs": "Set the channel URL for the app dynamically at runtime.\n\nThis overrides the {@link PluginsConfig.CapacitorUpdater.channelUrl} config value.\nRequires {@link PluginsConfig.CapacitorUpdater.allowModifyUrl} to be set to `true`.\n\nUse {@link PluginsConfig.CapacitorUpdater.persistModifyUrl} to persist this value across app restarts.\nOtherwise, the URL will reset to the config value on next app launch.",
125
+ "complexTypes": [
126
+ "ChannelUrl"
127
+ ],
128
+ "slug": "setchannelurl"
129
+ },
130
+ {
131
+ "name": "download",
132
+ "signature": "(options: DownloadOptions) => Promise<BundleInfo>",
133
+ "parameters": [
134
+ {
135
+ "name": "options",
136
+ "docs": "The {@link DownloadOptions} for downloading a new bundle zip.",
137
+ "type": "DownloadOptions"
138
+ }
139
+ ],
140
+ "returns": "Promise<BundleInfo>",
141
+ "tags": [
53
142
  {
54
143
  "name": "example",
55
- "text": "https://example.com/versions/{version}/dist.zip"
144
+ "text": "const bundle = await CapacitorUpdater.download({\n url: `https://example.com/versions/${version}/dist.zip`,\n version: version\n});\n// Bundle is downloaded but not active yet\nawait CapacitorUpdater.next({ id: bundle.id }); // Will activate on next background"
145
+ },
146
+ {
147
+ "name": "param",
148
+ "text": "options The {@link DownloadOptions} for downloading a new bundle zip."
149
+ },
150
+ {
151
+ "name": "returns",
152
+ "text": "The {@link BundleInfo} for the downloaded bundle."
153
+ },
154
+ {
155
+ "name": "throws",
156
+ "text": "{Error} If the download fails or the bundle is invalid."
56
157
  }
57
158
  ],
58
- "docs": "Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files",
159
+ "docs": "Download a new bundle from the provided URL for later installation.\n\nThe downloaded bundle is stored locally but not activated. To use it:\n- Call {@link next} to set it for installation on next app backgrounding/restart\n- Call {@link set} to activate it immediately (destroys current JavaScript context)\n\nThe URL should point to a zip file containing either:\n- Your app files directly in the zip root, or\n- A single folder containing all your app files\n\nThe bundle must include an `index.html` file at the root level.\n\nFor encrypted bundles, provide the `sessionKey` and `checksum` parameters.\nFor multi-file delta updates, provide the `manifest` array.",
59
160
  "complexTypes": [
60
- "BundleInfo"
161
+ "BundleInfo",
162
+ "DownloadOptions"
61
163
  ],
62
164
  "slug": "download"
63
165
  },
64
166
  {
65
167
  "name": "next",
66
- "signature": "(options: { id: string; }) => Promise<BundleInfo>",
168
+ "signature": "(options: BundleId) => Promise<BundleInfo>",
67
169
  "parameters": [
68
170
  {
69
171
  "name": "options",
70
- "docs": "",
71
- "type": "{ id: string; }"
172
+ "docs": "Contains the ID of the bundle to set as next. Use {@link BundleInfo.id} from a downloaded bundle.",
173
+ "type": "BundleId"
72
174
  }
73
175
  ],
74
176
  "returns": "Promise<BundleInfo>",
75
177
  "tags": [
76
178
  {
77
- "name": "returns",
78
- "text": "The {@link BundleInfo} for the specified bundle id."
179
+ "name": "param",
180
+ "text": "options Contains the ID of the bundle to set as next. Use {@link BundleInfo.id} from a downloaded bundle."
79
181
  },
80
182
  {
81
- "name": "param",
82
- "text": "id The bundle id to set as current, next time the app is reloaded. See {@link BundleInfo.id}"
183
+ "name": "returns",
184
+ "text": "The {@link BundleInfo} for the specified bundle."
83
185
  },
84
186
  {
85
187
  "name": "throws",
86
- "text": "An error if there are is no index.html file inside the bundle folder."
188
+ "text": "{Error} When there is no index.html file inside the bundle folder or the bundle doesn't exist."
87
189
  }
88
190
  ],
89
- "docs": "Set the next bundle to be used when the app is reloaded.",
191
+ "docs": "Set the next bundle to be activated when the app backgrounds or restarts.\n\nThis is the recommended way to apply updates as it doesn't interrupt the user's current session.\nThe bundle will be activated when:\n- The app is backgrounded (user switches away), or\n- The app is killed and relaunched, or\n- {@link reload} is called manually\n\nUnlike {@link set}, this method does NOT destroy the current JavaScript context immediately.\nYour app continues running normally until one of the above events occurs.\n\nUse {@link setMultiDelay} to add additional conditions before the update is applied.",
90
192
  "complexTypes": [
91
- "BundleInfo"
193
+ "BundleInfo",
194
+ "BundleId"
92
195
  ],
93
196
  "slug": "next"
94
197
  },
95
198
  {
96
199
  "name": "set",
97
- "signature": "(options: { id: string; }) => Promise<void>",
200
+ "signature": "(options: BundleId) => Promise<void>",
98
201
  "parameters": [
99
202
  {
100
203
  "name": "options",
101
- "docs": "",
102
- "type": "{ id: string; }"
204
+ "docs": "A {@link BundleId} object containing the new bundle id to set as current.",
205
+ "type": "BundleId"
103
206
  }
104
207
  ],
105
208
  "returns": "Promise<void>",
106
209
  "tags": [
107
210
  {
108
211
  "name": "param",
109
- "text": "id The bundle id to set as current. See {@link BundleInfo.id}"
212
+ "text": "options A {@link BundleId} object containing the new bundle id to set as current."
110
213
  },
111
214
  {
112
215
  "name": "returns",
113
- "text": "An empty promise."
216
+ "text": "A promise that will never resolve because the JavaScript context is destroyed."
114
217
  },
115
218
  {
116
219
  "name": "throws",
117
- "text": "An error if there are is no index.html file inside the bundle folder."
220
+ "text": "{Error} When there is no index.html file inside the bundle folder."
118
221
  }
119
222
  ],
120
- "docs": "Set the current bundle and immediately reloads the app.",
121
- "complexTypes": [],
223
+ "docs": "Set the current bundle and immediately reloads the app.\n\n**IMPORTANT: This is a terminal operation that destroys the current JavaScript context.**\n\nWhen you call this method:\n- The entire JavaScript context is immediately destroyed\n- The app reloads from a different folder with different files\n- NO code after this call will execute\n- NO promises will resolve\n- NO callbacks will fire\n- Event listeners registered after this call are unreliable and may never fire\n\nThe reload happens automatically - you don't need to do anything else.\nIf you need to preserve state like the current URL path, use the {@link PluginsConfig.CapacitorUpdater.keepUrlPathAfterReload} config option.\nFor other state preservation needs, save your data before calling this method (e.g., to localStorage).\n\n**Do not** try to execute additional logic after calling `set()` - it won't work as expected.",
224
+ "complexTypes": [
225
+ "BundleId"
226
+ ],
122
227
  "slug": "set"
123
228
  },
124
229
  {
125
230
  "name": "delete",
126
- "signature": "(options: { id: string; }) => Promise<void>",
231
+ "signature": "(options: BundleId) => Promise<void>",
127
232
  "parameters": [
128
233
  {
129
234
  "name": "options",
130
- "docs": "",
131
- "type": "{ id: string; }"
235
+ "docs": "A {@link BundleId} object containing the bundle ID to delete.",
236
+ "type": "BundleId"
132
237
  }
133
238
  ],
134
239
  "returns": "Promise<void>",
135
240
  "tags": [
241
+ {
242
+ "name": "param",
243
+ "text": "options A {@link BundleId} object containing the bundle ID to delete."
244
+ },
136
245
  {
137
246
  "name": "returns",
138
- "text": "an empty Promise when the bundle is deleted"
247
+ "text": "Resolves when the bundle is successfully deleted."
139
248
  },
249
+ {
250
+ "name": "throws",
251
+ "text": "{Error} If the bundle is currently in use or doesn't exist."
252
+ }
253
+ ],
254
+ "docs": "Delete a bundle from local storage to free up disk space.\n\nYou cannot delete:\n- The currently active bundle\n- The `builtin` bundle (the version shipped with your app)\n- The bundle set as `next` (call {@link next} with a different bundle first)\n\nUse {@link list} to get all available bundle IDs.\n\n**Note:** The bundle ID is NOT the same as the version name.\nUse the `id` field from {@link BundleInfo}, not the `version` field.",
255
+ "complexTypes": [
256
+ "BundleId"
257
+ ],
258
+ "slug": "delete"
259
+ },
260
+ {
261
+ "name": "setBundleError",
262
+ "signature": "(options: BundleId) => Promise<BundleInfo>",
263
+ "parameters": [
264
+ {
265
+ "name": "options",
266
+ "docs": "A {@link BundleId} object containing the bundle ID to mark as errored.",
267
+ "type": "BundleId"
268
+ }
269
+ ],
270
+ "returns": "Promise<BundleInfo>",
271
+ "tags": [
140
272
  {
141
273
  "name": "param",
142
- "text": "id The bundle id to delete (note, this is the bundle id, NOT the version name)"
274
+ "text": "options A {@link BundleId} object containing the bundle ID to mark as errored."
275
+ },
276
+ {
277
+ "name": "returns",
278
+ "text": "The updated {@link BundleInfo} with status set to `error`."
143
279
  },
144
280
  {
145
281
  "name": "throws",
146
- "text": "An error if the something went wrong"
282
+ "text": "{Error} When the bundle does not exist or `allowManualBundleError` is false."
283
+ },
284
+ {
285
+ "name": "since",
286
+ "text": "7.20.0"
147
287
  }
148
288
  ],
149
- "docs": "Delete bundle in storage",
150
- "complexTypes": [],
151
- "slug": "delete"
289
+ "docs": "Manually mark a bundle as failed/errored in manual update mode.\n\nThis is useful when you detect that a bundle has critical issues and want to prevent\nit from being used again. The bundle status will be changed to `error` and the plugin\nwill avoid using this bundle in the future.\n\n**Requirements:**\n- {@link PluginsConfig.CapacitorUpdater.allowManualBundleError} must be set to `true`\n- Only works in manual update mode (when autoUpdate is disabled)\n\nCommon use case: After downloading and testing a bundle, you discover it has critical\nbugs and want to mark it as failed so it won't be retried.",
290
+ "complexTypes": [
291
+ "BundleInfo",
292
+ "BundleId"
293
+ ],
294
+ "slug": "setbundleerror"
152
295
  },
153
296
  {
154
297
  "name": "list",
155
- "signature": "() => Promise<{ bundles: BundleInfo[]; }>",
156
- "parameters": [],
157
- "returns": "Promise<{ bundles: BundleInfo[]; }>",
298
+ "signature": "(options?: ListOptions | undefined) => Promise<BundleListResult>",
299
+ "parameters": [
300
+ {
301
+ "name": "options",
302
+ "docs": "The {@link ListOptions} for customizing the bundle list output.",
303
+ "type": "ListOptions | undefined"
304
+ }
305
+ ],
306
+ "returns": "Promise<BundleListResult>",
158
307
  "tags": [
308
+ {
309
+ "name": "param",
310
+ "text": "options The {@link ListOptions} for customizing the bundle list output."
311
+ },
159
312
  {
160
313
  "name": "returns",
161
- "text": "an Promise witht the bundles list"
314
+ "text": "A promise containing the array of {@link BundleInfo} objects."
162
315
  },
163
316
  {
164
317
  "name": "throws",
165
- "text": "An error if the something went wrong"
318
+ "text": "{Error} If the operation fails."
166
319
  }
167
320
  ],
168
- "docs": "Get all available bundles",
321
+ "docs": "Get all locally downloaded bundles stored in your app.\n\nThis returns all bundles that have been downloaded and are available locally, including:\n- The currently active bundle\n- The `builtin` bundle (shipped with your app)\n- Any downloaded bundles waiting to be activated\n- Failed bundles (with `error` status)\n\nUse this to:\n- Check available disk space by counting bundles\n- Delete old bundles with {@link delete}\n- Monitor bundle download status",
169
322
  "complexTypes": [
170
- "BundleInfo"
323
+ "BundleListResult",
324
+ "ListOptions"
171
325
  ],
172
326
  "slug": "list"
173
327
  },
174
328
  {
175
329
  "name": "reset",
176
- "signature": "(options?: { toLastSuccessful?: boolean | undefined; } | undefined) => Promise<void>",
330
+ "signature": "(options?: ResetOptions | undefined) => Promise<void>",
177
331
  "parameters": [
178
332
  {
179
333
  "name": "options",
180
334
  "docs": "",
181
- "type": "{ toLastSuccessful?: boolean | undefined; } | undefined"
335
+ "type": "ResetOptions | undefined"
182
336
  }
183
337
  ],
184
338
  "returns": "Promise<void>",
185
339
  "tags": [
186
340
  {
187
- "name": "returns",
188
- "text": "an empty Promise"
341
+ "name": "param",
342
+ "text": "options"
189
343
  },
190
344
  {
191
- "name": "param",
192
- "text": "toLastSuccessful [false] if yes it reset to to the last successfully loaded bundle instead of `builtin`"
345
+ "name": "link",
346
+ "text": "ResetOptions} to control reset behavior. If `toLastSuccessful` is `false` (or omitted), resets to builtin. If `true`, resets to last successful bundle."
347
+ },
348
+ {
349
+ "name": "returns",
350
+ "text": "A promise that may never resolve because the app will be reloaded."
193
351
  },
194
352
  {
195
353
  "name": "throws",
196
- "text": "An error if the something went wrong"
354
+ "text": "{Error} If the reset operation fails."
197
355
  }
198
356
  ],
199
- "docs": "Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle",
200
- "complexTypes": [],
357
+ "docs": "Reset the app to a known good bundle.\n\nThis method helps recover from problematic updates by reverting to either:\n- The `builtin` bundle (the original version shipped with your app to App Store/Play Store)\n- The last successfully loaded bundle (most recent bundle that worked correctly)\n\n**IMPORTANT: This triggers an immediate app reload, destroying the current JavaScript context.**\nSee {@link set} for details on the implications of this operation.\n\nUse cases:\n- Emergency recovery when an update causes critical issues\n- Testing rollback functionality\n- Providing users a \"reset to factory\" option",
358
+ "complexTypes": [
359
+ "ResetOptions"
360
+ ],
201
361
  "slug": "reset"
202
362
  },
203
363
  {
204
364
  "name": "current",
205
- "signature": "() => Promise<{ bundle: BundleInfo; native: string; }>",
365
+ "signature": "() => Promise<CurrentBundleResult>",
206
366
  "parameters": [],
207
- "returns": "Promise<{ bundle: BundleInfo; native: string; }>",
367
+ "returns": "Promise<CurrentBundleResult>",
208
368
  "tags": [
209
369
  {
210
370
  "name": "returns",
211
- "text": "an Promise with the current bundle info"
371
+ "text": "A promise with the current bundle and native version info."
212
372
  },
213
373
  {
214
374
  "name": "throws",
215
- "text": "An error if the something went wrong"
375
+ "text": "{Error} If the operation fails."
216
376
  }
217
377
  ],
218
- "docs": "Get the current bundle, if none are set it returns `builtin`, currentNative is the original bundle installed on the device",
378
+ "docs": "Get information about the currently active bundle.\n\nReturns:\n- `bundle`: The currently active bundle information\n- `native`: The version of the builtin bundle (the original app version from App/Play Store)\n\nIf no updates have been applied, `bundle.id` will be `\"builtin\"`, indicating the app\nis running the original version shipped with the native app.\n\nUse this to:\n- Display the current version to users\n- Check if an update is currently active\n- Compare against available updates\n- Log the active bundle for debugging",
219
379
  "complexTypes": [
220
- "BundleInfo"
380
+ "CurrentBundleResult"
221
381
  ],
222
382
  "slug": "current"
223
383
  },
@@ -229,308 +389,447 @@
229
389
  "tags": [
230
390
  {
231
391
  "name": "returns",
232
- "text": "an Promise resolved when the view is reloaded"
392
+ "text": "A promise that may never resolve because the app will be reloaded."
233
393
  },
234
394
  {
235
395
  "name": "throws",
236
- "text": "An error if the something went wrong"
396
+ "text": "{Error} If the reload operation fails."
237
397
  }
238
398
  ],
239
- "docs": "Reload the view",
399
+ "docs": "Manually reload the app to apply a pending update.\n\nThis triggers the same reload behavior that happens automatically when the app backgrounds.\nIf you've called {@link next} to queue an update, calling `reload()` will apply it immediately.\n\n**IMPORTANT: This destroys the current JavaScript context immediately.**\nSee {@link set} for details on the implications of this operation.\n\nCommon use cases:\n- Applying an update immediately after download instead of waiting for backgrounding\n- Providing a \"Restart now\" button to users after an update is ready\n- Testing update flows during development\n\nIf no update is pending (no call to {@link next}), this simply reloads the current bundle.",
240
400
  "complexTypes": [],
241
401
  "slug": "reload"
242
402
  },
243
403
  {
244
404
  "name": "setMultiDelay",
245
- "signature": "(options: { delayConditions: DelayCondition[]; }) => Promise<void>",
405
+ "signature": "(options: MultiDelayConditions) => Promise<void>",
246
406
  "parameters": [
247
407
  {
248
408
  "name": "options",
249
- "docs": "are the {@link DelayCondition} list to set",
250
- "type": "{ delayConditions: DelayCondition[]; }"
409
+ "docs": "Contains the {@link MultiDelayConditions} array of conditions.",
410
+ "type": "MultiDelayConditions"
251
411
  }
252
412
  ],
253
413
  "returns": "Promise<void>",
254
414
  "tags": [
255
415
  {
256
- "name": "returns",
257
- "text": "an Promise resolved directly"
416
+ "name": "example",
417
+ "text": "// Update after user kills app OR after 5 minutes in background\nawait CapacitorUpdater.setMultiDelay({\n delayConditions: [\n { kind: 'kill' },\n { kind: 'background', value: '300000' }\n ]\n});"
258
418
  },
259
419
  {
260
- "name": "param",
261
- "text": "options are the {@link DelayCondition} list to set"
420
+ "name": "example",
421
+ "text": "// Update after a specific date\nawait CapacitorUpdater.setMultiDelay({\n delayConditions: [{ kind: 'date', value: '2025-12-31T23:59:59Z' }]\n});"
262
422
  },
263
423
  {
264
424
  "name": "example",
265
- "text": "setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })\n// installs the update after the user kills the app or after a background of 300000 ms (5 minutes)"
425
+ "text": "// Default behavior: update on next background\nawait CapacitorUpdater.setMultiDelay({\n delayConditions: [{ kind: 'background' }]\n});"
266
426
  },
267
427
  {
268
- "name": "example",
269
- "text": "setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })\n// installs the update after the specific iso8601 date is expired"
428
+ "name": "param",
429
+ "text": "options Contains the {@link MultiDelayConditions} array of conditions."
270
430
  },
271
431
  {
272
- "name": "example",
273
- "text": "setMultiDelay({ delayConditions: [{ kind: 'background' }] })\n// installs the update after the the first background (default behaviour without setting delay)"
432
+ "name": "returns",
433
+ "text": "Resolves when the delay conditions are set."
274
434
  },
275
435
  {
276
436
  "name": "throws",
277
- "text": "An error if the something went wrong"
437
+ "text": "{Error} If the operation fails or conditions are invalid."
278
438
  },
279
439
  {
280
440
  "name": "since",
281
441
  "text": "4.3.0"
282
442
  }
283
443
  ],
284
- "docs": "Set DelayCondition, skip updates until one of the conditions is met",
444
+ "docs": "Configure conditions that must be met before a pending update is applied.\n\nAfter calling {@link next} to queue an update, use this method to control when it gets applied.\nThe update will only be installed after ALL specified conditions are satisfied.\n\nAvailable condition types:\n- `background`: Wait for the app to be backgrounded. Optionally specify duration in milliseconds.\n- `kill`: Wait for the app to be killed and relaunched (**Note:** Current behavior triggers update immediately on kill, not on next background. This will be fixed in v8.)\n- `date`: Wait until a specific date/time (ISO 8601 format)\n- `nativeVersion`: Wait until the native app is updated to a specific version\n\nCondition value formats:\n- `background`: Number in milliseconds (e.g., `\"300000\"` for 5 minutes), or omit for immediate\n- `kill`: No value needed\n- `date`: ISO 8601 date string (e.g., `\"2025-12-31T23:59:59Z\"`)\n- `nativeVersion`: Version string (e.g., `\"2.0.0\"`)",
285
445
  "complexTypes": [
286
- "DelayCondition"
446
+ "MultiDelayConditions"
287
447
  ],
288
448
  "slug": "setmultidelay"
289
449
  },
290
450
  {
291
- "name": "setDelay",
292
- "signature": "(options: DelayCondition) => Promise<void>",
293
- "parameters": [
294
- {
295
- "name": "options",
296
- "docs": "is the {@link DelayCondition} to set",
297
- "type": "DelayCondition"
298
- }
299
- ],
451
+ "name": "cancelDelay",
452
+ "signature": "() => Promise<void>",
453
+ "parameters": [],
300
454
  "returns": "Promise<void>",
301
455
  "tags": [
302
- {
303
- "name": "deprecated",
304
- "text": "use setMultiDelay instead passing a single value in array"
305
- },
306
456
  {
307
457
  "name": "returns",
308
- "text": "an Promise resolved directly"
309
- },
310
- {
311
- "name": "param",
312
- "text": "options is the {@link DelayCondition} to set"
458
+ "text": "Resolves when the delay conditions are cleared."
313
459
  },
314
460
  {
315
461
  "name": "throws",
316
- "text": "An error if the something went wrong"
462
+ "text": "{Error} If the operation fails."
317
463
  },
318
464
  {
319
465
  "name": "since",
320
466
  "text": "4.0.0"
321
467
  }
322
468
  ],
323
- "docs": "Set DelayCondition, skip updates until the condition is met",
324
- "complexTypes": [
325
- "DelayCondition"
326
- ],
327
- "slug": "setdelay"
469
+ "docs": "Cancel all delay conditions and apply the pending update immediately.\n\nIf you've set delay conditions with {@link setMultiDelay}, this method clears them\nand triggers the pending update to be applied on the next app background or restart.\n\nThis is useful when:\n- User manually requests to update now (e.g., clicks \"Update now\" button)\n- Your app detects it's a good time to update (e.g., user finished critical task)\n- You want to override a time-based delay early",
470
+ "complexTypes": [],
471
+ "slug": "canceldelay"
328
472
  },
329
473
  {
330
- "name": "cancelDelay",
331
- "signature": "() => Promise<void>",
332
- "parameters": [],
333
- "returns": "Promise<void>",
474
+ "name": "getLatest",
475
+ "signature": "(options?: GetLatestOptions | undefined) => Promise<LatestVersion>",
476
+ "parameters": [
477
+ {
478
+ "name": "options",
479
+ "docs": "Optional {@link GetLatestOptions} to specify which channel to check.",
480
+ "type": "GetLatestOptions | undefined"
481
+ }
482
+ ],
483
+ "returns": "Promise<LatestVersion>",
334
484
  "tags": [
485
+ {
486
+ "name": "param",
487
+ "text": "options Optional {@link GetLatestOptions} to specify which channel to check."
488
+ },
335
489
  {
336
490
  "name": "returns",
337
- "text": "an Promise resolved directly"
491
+ "text": "Information about the latest available bundle version."
338
492
  },
339
493
  {
340
494
  "name": "throws",
341
- "text": "An error if the something went wrong"
495
+ "text": "{Error} Always throws when no new version is available (`error: \"no_new_version_available\"`), or when the request fails."
342
496
  },
343
497
  {
344
498
  "name": "since",
345
499
  "text": "4.0.0"
346
500
  }
347
501
  ],
348
- "docs": "Cancel delay to updates as usual",
349
- "complexTypes": [],
350
- "slug": "canceldelay"
502
+ "docs": "Check the update server for the latest available bundle version.\n\nThis queries your configured update URL (or Capgo backend) to see if a newer bundle\nis available for download. It does NOT download the bundle automatically.\n\nThe response includes:\n- `version`: The latest available version identifier\n- `url`: Download URL for the bundle (if available)\n- `breaking`: Whether this update is marked as incompatible (requires native app update)\n- `message`: Optional message from the server\n- `manifest`: File list for delta updates (if using multi-file downloads)\n\nAfter receiving the latest version info, you can:\n1. Compare it with your current version\n2. Download it using {@link download}\n3. Apply it using {@link next} or {@link set}\n\n**Important: Error handling for \"no new version available\"**\n\nWhen the device's current version matches the latest version on the server (i.e., the device is already\nup-to-date), the server returns a 200 response with `error: \"no_new_version_available\"` and\n`message: \"No new version available\"`. **This causes `getLatest()` to throw an error**, even though\nthis is a normal, expected condition.\n\nYou should catch this specific error to handle it gracefully:\n\n```typescript\ntry {\n const latest = await CapacitorUpdater.getLatest();\n // New version is available, proceed with download\n} catch (error) {\n if (error.message === 'No new version available') {\n // Device is already on the latest version - this is normal\n console.log('Already up to date');\n } else {\n // Actual error occurred\n console.error('Failed to check for updates:', error);\n }\n}\n```\n\nIn this scenario, the server:\n- Logs the request with a \"No new version available\" message\n- Sends a \"noNew\" stat action to track that the device checked for updates but was already current (done on the backend)",
503
+ "complexTypes": [
504
+ "LatestVersion",
505
+ "GetLatestOptions"
506
+ ],
507
+ "slug": "getlatest"
351
508
  },
352
509
  {
353
- "name": "getLatest",
354
- "signature": "() => Promise<latestVersion>",
355
- "parameters": [],
356
- "returns": "Promise<latestVersion>",
510
+ "name": "setChannel",
511
+ "signature": "(options: SetChannelOptions) => Promise<ChannelRes>",
512
+ "parameters": [
513
+ {
514
+ "name": "options",
515
+ "docs": "The {@link SetChannelOptions} containing the channel name and optional auto-update trigger.",
516
+ "type": "SetChannelOptions"
517
+ }
518
+ ],
519
+ "returns": "Promise<ChannelRes>",
357
520
  "tags": [
521
+ {
522
+ "name": "param",
523
+ "text": "options The {@link SetChannelOptions} containing the channel name and optional auto-update trigger."
524
+ },
358
525
  {
359
526
  "name": "returns",
360
- "text": "an Promise resolved when url is loaded"
527
+ "text": "Channel operation result with status and optional error/message."
361
528
  },
362
529
  {
363
530
  "name": "throws",
364
- "text": "An error if the something went wrong"
531
+ "text": "{Error} If the channel doesn't exist or doesn't allow self-assignment."
365
532
  },
366
533
  {
367
534
  "name": "since",
368
- "text": "4.0.0"
535
+ "text": "4.7.0"
369
536
  }
370
537
  ],
371
- "docs": "Get Latest bundle available from update Url",
538
+ "docs": "Assign this device to a specific update channel at runtime.\n\nChannels allow you to distribute different bundle versions to different groups of users\n(e.g., \"production\", \"beta\", \"staging\"). This method switches the device to a new channel.\n\n**Requirements:**\n- The target channel must allow self-assignment (configured in your Capgo dashboard or backend)\n- The backend may accept or reject the request based on channel settings\n\n**When to use:**\n- After the app is ready and the user has interacted (e.g., opted into beta program)\n- To implement in-app channel switching (beta toggle, tester access, etc.)\n- For user-driven channel changes\n\n**When NOT to use:**\n- At app boot/initialization - use {@link PluginsConfig.CapacitorUpdater.defaultChannel} config instead\n- Before user interaction\n\n**Important: Listen for the `channelPrivate` event**\n\nWhen a user attempts to set a channel that doesn't allow device self-assignment, the method will\nthrow an error AND fire a {@link addListener}('channelPrivate') event. You should listen to this event\nto provide appropriate feedback to users:\n\n```typescript\nCapacitorUpdater.addListener('channelPrivate', (data) => {\n console.warn(`Cannot access channel \"${data.channel}\": ${data.message}`);\n // Show user-friendly message\n});\n```\n\nThis sends a request to the Capgo backend linking your device ID to the specified channel.",
372
539
  "complexTypes": [
373
- "latestVersion"
540
+ "ChannelRes",
541
+ "SetChannelOptions"
374
542
  ],
375
- "slug": "getlatest"
543
+ "slug": "setchannel"
376
544
  },
377
545
  {
378
- "name": "setChannel",
379
- "signature": "(options: SetChannelOptions) => Promise<channelRes>",
546
+ "name": "unsetChannel",
547
+ "signature": "(options: UnsetChannelOptions) => Promise<void>",
380
548
  "parameters": [
381
549
  {
382
550
  "name": "options",
383
- "docs": "is the {@link SetChannelOptions} channel to set",
384
- "type": "SetChannelOptions"
551
+ "docs": "",
552
+ "type": "UnsetChannelOptions"
385
553
  }
386
554
  ],
387
- "returns": "Promise<channelRes>",
555
+ "returns": "Promise<void>",
388
556
  "tags": [
389
557
  {
390
- "name": "returns",
391
- "text": "an Promise resolved when channel is set"
558
+ "name": "param",
559
+ "text": "options"
392
560
  },
393
561
  {
394
- "name": "param",
395
- "text": "options is the {@link SetChannelOptions} channel to set"
562
+ "name": "link",
563
+ "text": "UnsetChannelOptions} containing optional auto-update trigger."
564
+ },
565
+ {
566
+ "name": "returns",
567
+ "text": "Resolves when the channel is successfully unset."
396
568
  },
397
569
  {
398
570
  "name": "throws",
399
- "text": "An error if the something went wrong"
571
+ "text": "{Error} If the operation fails."
400
572
  },
401
573
  {
402
574
  "name": "since",
403
575
  "text": "4.7.0"
404
576
  }
405
577
  ],
406
- "docs": "Set Channel for this device",
578
+ "docs": "Remove the device's channel assignment and return to the default channel.\n\nThis unlinks the device from any specifically assigned channel, causing it to fall back to:\n- The {@link PluginsConfig.CapacitorUpdater.defaultChannel} if configured, or\n- Your backend's default channel for this app\n\nUse this when:\n- Users opt out of beta/testing programs\n- You want to reset a device to standard update distribution\n- Testing channel switching behavior",
407
579
  "complexTypes": [
408
- "channelRes",
409
- "SetChannelOptions"
580
+ "UnsetChannelOptions"
410
581
  ],
411
- "slug": "setchannel"
582
+ "slug": "unsetchannel"
412
583
  },
413
584
  {
414
585
  "name": "getChannel",
415
- "signature": "() => Promise<getChannelRes>",
586
+ "signature": "() => Promise<GetChannelRes>",
416
587
  "parameters": [],
417
- "returns": "Promise<getChannelRes>",
588
+ "returns": "Promise<GetChannelRes>",
418
589
  "tags": [
419
590
  {
420
591
  "name": "returns",
421
- "text": "an Promise resolved with channel info"
592
+ "text": "The current channel information."
422
593
  },
423
594
  {
424
595
  "name": "throws",
425
- "text": "An error if the something went wrong"
596
+ "text": "{Error} If the operation fails."
426
597
  },
427
598
  {
428
599
  "name": "since",
429
600
  "text": "4.8.0"
430
601
  }
431
602
  ],
432
- "docs": "get Channel for this device",
603
+ "docs": "Get the current channel assigned to this device.\n\nReturns information about:\n- `channel`: The currently assigned channel name (if any)\n- `allowSet`: Whether the channel allows self-assignment\n- `status`: Operation status\n- `error`/`message`: Additional information (if applicable)\n\nUse this to:\n- Display current channel to users (e.g., \"You're on the Beta channel\")\n- Check if a device is on a specific channel before showing features\n- Verify channel assignment after calling {@link setChannel}",
433
604
  "complexTypes": [
434
- "getChannelRes"
605
+ "GetChannelRes"
435
606
  ],
436
607
  "slug": "getchannel"
437
608
  },
609
+ {
610
+ "name": "listChannels",
611
+ "signature": "() => Promise<ListChannelsResult>",
612
+ "parameters": [],
613
+ "returns": "Promise<ListChannelsResult>",
614
+ "tags": [
615
+ {
616
+ "name": "returns",
617
+ "text": "List of channels the device can self-assign to."
618
+ },
619
+ {
620
+ "name": "throws",
621
+ "text": "{Error} If the operation fails or the request to the backend fails."
622
+ },
623
+ {
624
+ "name": "since",
625
+ "text": "7.5.0"
626
+ }
627
+ ],
628
+ "docs": "Get a list of all channels available for this device to self-assign to.\n\nOnly returns channels where `allow_self_set` is `true`. These are channels that\nusers can switch to using {@link setChannel} without backend administrator intervention.\n\nEach channel includes:\n- `id`: Unique channel identifier\n- `name`: Human-readable channel name\n- `public`: Whether the channel is publicly visible\n- `allow_self_set`: Always `true` in results (filtered to only self-assignable channels)\n\nUse this to:\n- Build a channel selector UI for users (e.g., \"Join Beta\" button)\n- Show available testing/preview channels\n- Implement channel discovery features",
629
+ "complexTypes": [
630
+ "ListChannelsResult"
631
+ ],
632
+ "slug": "listchannels"
633
+ },
438
634
  {
439
635
  "name": "setCustomId",
440
636
  "signature": "(options: SetCustomIdOptions) => Promise<void>",
441
637
  "parameters": [
442
638
  {
443
639
  "name": "options",
444
- "docs": "is the {@link SetCustomIdOptions} customId to set",
640
+ "docs": "The {@link SetCustomIdOptions} containing the custom identifier string.",
445
641
  "type": "SetCustomIdOptions"
446
642
  }
447
643
  ],
448
644
  "returns": "Promise<void>",
449
645
  "tags": [
450
646
  {
451
- "name": "returns",
452
- "text": "an Promise resolved instantly"
647
+ "name": "param",
648
+ "text": "options The {@link SetCustomIdOptions} containing the custom identifier string."
453
649
  },
454
650
  {
455
- "name": "param",
456
- "text": "options is the {@link SetCustomIdOptions} customId to set"
651
+ "name": "returns",
652
+ "text": "Resolves immediately (synchronous operation)."
457
653
  },
458
654
  {
459
655
  "name": "throws",
460
- "text": "An error if the something went wrong"
656
+ "text": "{Error} If the operation fails."
461
657
  },
462
658
  {
463
659
  "name": "since",
464
660
  "text": "4.9.0"
465
661
  }
466
662
  ],
467
- "docs": "Set Channel for this device",
663
+ "docs": "Set a custom identifier for this device.\n\nThis allows you to identify devices by your own custom ID (user ID, account ID, etc.)\ninstead of or in addition to the device's unique hardware ID. The custom ID is sent\nto your update server and can be used for:\n- Targeting specific users for updates\n- Analytics and user tracking\n- Debugging and support (correlating devices with users)\n- A/B testing or feature flagging\n\n**Persistence:**\n- When {@link PluginsConfig.CapacitorUpdater.persistCustomId} is `true`, the ID persists across app restarts\n- When `false`, the ID is only kept for the current session\n\n**Clearing the custom ID:**\n- Pass an empty string `\"\"` to remove any stored custom ID",
468
664
  "complexTypes": [
469
665
  "SetCustomIdOptions"
470
666
  ],
471
667
  "slug": "setcustomid"
472
668
  },
473
669
  {
474
- "name": "addListener",
475
- "signature": "(eventName: \"download\", listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
476
- "parameters": [
670
+ "name": "getBuiltinVersion",
671
+ "signature": "() => Promise<BuiltinVersion>",
672
+ "parameters": [],
673
+ "returns": "Promise<BuiltinVersion>",
674
+ "tags": [
477
675
  {
478
- "name": "eventName",
479
- "docs": "",
480
- "type": "'download'"
676
+ "name": "returns",
677
+ "text": "The builtin bundle version string."
481
678
  },
482
- {
483
- "name": "listenerFunc",
484
- "docs": "",
485
- "type": "DownloadChangeListener"
486
- }
487
- ],
488
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
489
- "tags": [
490
679
  {
491
680
  "name": "since",
492
- "text": "2.0.11"
681
+ "text": "5.2.0"
493
682
  }
494
683
  ],
495
- "docs": "Listen for download event in the App, let you know when the download is started, loading and finished",
684
+ "docs": "Get the builtin bundle version (the original version shipped with your native app).\n\nThis returns the version of the bundle that was included when the app was installed\nfrom the App Store or Play Store. This is NOT the currently active bundle version -\nuse {@link current} for that.\n\nReturns:\n- The {@link PluginsConfig.CapacitorUpdater.version} config value if set, or\n- The native app version from platform configs (package.json, Info.plist, build.gradle)\n\nUse this to:\n- Display the \"factory\" version to users\n- Compare against downloaded bundle versions\n- Determine if any updates have been applied\n- Debugging version mismatches",
496
685
  "complexTypes": [
497
- "PluginListenerHandle",
498
- "DownloadChangeListener"
686
+ "BuiltinVersion"
499
687
  ],
500
- "slug": "addlistenerdownload"
688
+ "slug": "getbuiltinversion"
501
689
  },
502
690
  {
503
- "name": "addListener",
504
- "signature": "(eventName: \"noNeedUpdate\", listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
505
- "parameters": [
506
- {
507
- "name": "eventName",
691
+ "name": "getDeviceId",
692
+ "signature": "() => Promise<DeviceId>",
693
+ "parameters": [],
694
+ "returns": "Promise<DeviceId>",
695
+ "tags": [
696
+ {
697
+ "name": "returns",
698
+ "text": "The unique device identifier string."
699
+ },
700
+ {
701
+ "name": "throws",
702
+ "text": "{Error} If the operation fails."
703
+ }
704
+ ],
705
+ "docs": "Get the unique, privacy-friendly identifier for this device.\n\nThis ID is used to identify the device when communicating with update servers.\nIt's automatically generated and stored securely by the plugin.\n\n**Privacy & Security characteristics:**\n- Generated as a UUID (not based on hardware identifiers)\n- Stored securely in platform-specific secure storage\n- Android: Android Keystore (persists across app reinstalls on API 23+)\n- iOS: Keychain with `kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly`\n- Not synced to cloud (iOS)\n- Follows Apple and Google privacy best practices\n- Users can clear it via system settings (Android) or keychain access (iOS)\n\n**Persistence:**\nThe device ID persists across app reinstalls to maintain consistent device identity\nfor update tracking and analytics.\n\nUse this to:\n- Debug update delivery issues (check what ID the server sees)\n- Implement device-specific features\n- Correlate server logs with specific devices",
706
+ "complexTypes": [
707
+ "DeviceId"
708
+ ],
709
+ "slug": "getdeviceid"
710
+ },
711
+ {
712
+ "name": "getPluginVersion",
713
+ "signature": "() => Promise<PluginVersion>",
714
+ "parameters": [],
715
+ "returns": "Promise<PluginVersion>",
716
+ "tags": [
717
+ {
718
+ "name": "returns",
719
+ "text": "The Capacitor Updater plugin version string."
720
+ },
721
+ {
722
+ "name": "throws",
723
+ "text": "{Error} If the operation fails."
724
+ }
725
+ ],
726
+ "docs": "Get the version of the Capacitor Updater plugin installed in your app.\n\nThis returns the version of the native plugin code (Android/iOS), which is sent\nto the update server with each request. This is NOT your app version or bundle version.\n\nUse this to:\n- Debug plugin-specific issues (when reporting bugs)\n- Verify plugin installation and version\n- Check compatibility with backend features\n- Display in debug/about screens",
727
+ "complexTypes": [
728
+ "PluginVersion"
729
+ ],
730
+ "slug": "getpluginversion"
731
+ },
732
+ {
733
+ "name": "isAutoUpdateEnabled",
734
+ "signature": "() => Promise<AutoUpdateEnabled>",
735
+ "parameters": [],
736
+ "returns": "Promise<AutoUpdateEnabled>",
737
+ "tags": [
738
+ {
739
+ "name": "returns",
740
+ "text": "`true` if auto-update is enabled, `false` if in manual mode."
741
+ },
742
+ {
743
+ "name": "throws",
744
+ "text": "{Error} If the operation fails."
745
+ }
746
+ ],
747
+ "docs": "Check if automatic updates are currently enabled.\n\nReturns `true` if {@link PluginsConfig.CapacitorUpdater.autoUpdate} is enabled,\nmeaning the plugin will automatically check for, download, and apply updates.\n\nReturns `false` if in manual mode, where you control the update flow using\n{@link getLatest}, {@link download}, {@link next}, and {@link set}.\n\nUse this to:\n- Determine which update flow your app is using\n- Show/hide manual update UI based on mode\n- Debug update behavior",
748
+ "complexTypes": [
749
+ "AutoUpdateEnabled"
750
+ ],
751
+ "slug": "isautoupdateenabled"
752
+ },
753
+ {
754
+ "name": "removeAllListeners",
755
+ "signature": "() => Promise<void>",
756
+ "parameters": [],
757
+ "returns": "Promise<void>",
758
+ "tags": [
759
+ {
760
+ "name": "returns",
761
+ "text": "Resolves when all listeners are removed."
762
+ },
763
+ {
764
+ "name": "since",
765
+ "text": "1.0.0"
766
+ }
767
+ ],
768
+ "docs": "Remove all event listeners registered for this plugin.\n\nThis unregisters all listeners added via {@link addListener} for all event types:\n- `download`\n- `noNeedUpdate`\n- `updateAvailable`\n- `downloadComplete`\n- `downloadFailed`\n- `breakingAvailable` / `majorAvailable`\n- `updateFailed`\n- `appReloaded`\n- `appReady`\n\nUse this during cleanup (e.g., when unmounting components or closing screens)\nto prevent memory leaks from lingering event listeners.",
769
+ "complexTypes": [],
770
+ "slug": "removealllisteners"
771
+ },
772
+ {
773
+ "name": "addListener",
774
+ "signature": "(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>",
775
+ "parameters": [
776
+ {
777
+ "name": "eventName",
778
+ "docs": "",
779
+ "type": "'download'"
780
+ },
781
+ {
782
+ "name": "listenerFunc",
783
+ "docs": "",
784
+ "type": "(state: DownloadEvent) => void"
785
+ }
786
+ ],
787
+ "returns": "Promise<PluginListenerHandle>",
788
+ "tags": [
789
+ {
790
+ "name": "since",
791
+ "text": "2.0.11"
792
+ }
793
+ ],
794
+ "docs": "Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.\nThis will return you all download percent during the download",
795
+ "complexTypes": [
796
+ "PluginListenerHandle",
797
+ "DownloadEvent"
798
+ ],
799
+ "slug": "addlistenerdownload-"
800
+ },
801
+ {
802
+ "name": "addListener",
803
+ "signature": "(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>",
804
+ "parameters": [
805
+ {
806
+ "name": "eventName",
508
807
  "docs": "",
509
808
  "type": "'noNeedUpdate'"
510
809
  },
511
810
  {
512
811
  "name": "listenerFunc",
513
812
  "docs": "",
514
- "type": "NoNeedListener"
813
+ "type": "(state: NoNeedEvent) => void"
515
814
  }
516
815
  ],
517
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
816
+ "returns": "Promise<PluginListenerHandle>",
518
817
  "tags": [
519
818
  {
520
819
  "name": "since",
521
820
  "text": "4.0.0"
522
821
  }
523
822
  ],
524
- "docs": "Listen for no need to update event, usefull when you want force check every time the app is launched",
823
+ "docs": "Listen for no need to update event, useful when you want force check every time the app is launched",
525
824
  "complexTypes": [
526
825
  "PluginListenerHandle",
527
- "NoNeedListener"
826
+ "NoNeedEvent"
528
827
  ],
529
- "slug": "addlistenernoneedupdate"
828
+ "slug": "addlistenernoneedupdate-"
530
829
  },
531
830
  {
532
831
  "name": "addListener",
533
- "signature": "(eventName: \"updateAvailable\", listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
832
+ "signature": "(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>",
534
833
  "parameters": [
535
834
  {
536
835
  "name": "eventName",
@@ -540,26 +839,26 @@
540
839
  {
541
840
  "name": "listenerFunc",
542
841
  "docs": "",
543
- "type": "UpdateAvailabledListener"
842
+ "type": "(state: UpdateAvailableEvent) => void"
544
843
  }
545
844
  ],
546
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
845
+ "returns": "Promise<PluginListenerHandle>",
547
846
  "tags": [
548
847
  {
549
848
  "name": "since",
550
849
  "text": "4.0.0"
551
850
  }
552
851
  ],
553
- "docs": "Listen for availbale update event, usefull when you want to force check every time the app is launched",
852
+ "docs": "Listen for available update event, useful when you want to force check every time the app is launched",
554
853
  "complexTypes": [
555
854
  "PluginListenerHandle",
556
- "UpdateAvailabledListener"
855
+ "UpdateAvailableEvent"
557
856
  ],
558
- "slug": "addlistenerupdateavailable"
857
+ "slug": "addlistenerupdateavailable-"
559
858
  },
560
859
  {
561
860
  "name": "addListener",
562
- "signature": "(eventName: \"downloadComplete\", listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
861
+ "signature": "(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>",
563
862
  "parameters": [
564
863
  {
565
864
  "name": "eventName",
@@ -569,26 +868,55 @@
569
868
  {
570
869
  "name": "listenerFunc",
571
870
  "docs": "",
572
- "type": "DownloadCompleteListener"
871
+ "type": "(state: DownloadCompleteEvent) => void"
573
872
  }
574
873
  ],
575
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
874
+ "returns": "Promise<PluginListenerHandle>",
576
875
  "tags": [
577
876
  {
578
877
  "name": "since",
579
878
  "text": "4.0.0"
580
879
  }
581
880
  ],
582
- "docs": "Listen for download event in the App, let you know when the download is started, loading and finished",
881
+ "docs": "Listen for downloadComplete events.",
882
+ "complexTypes": [
883
+ "PluginListenerHandle",
884
+ "DownloadCompleteEvent"
885
+ ],
886
+ "slug": "addlistenerdownloadcomplete-"
887
+ },
888
+ {
889
+ "name": "addListener",
890
+ "signature": "(eventName: 'breakingAvailable', listenerFunc: (state: BreakingAvailableEvent) => void) => Promise<PluginListenerHandle>",
891
+ "parameters": [
892
+ {
893
+ "name": "eventName",
894
+ "docs": "",
895
+ "type": "'breakingAvailable'"
896
+ },
897
+ {
898
+ "name": "listenerFunc",
899
+ "docs": "",
900
+ "type": "(state: MajorAvailableEvent) => void"
901
+ }
902
+ ],
903
+ "returns": "Promise<PluginListenerHandle>",
904
+ "tags": [
905
+ {
906
+ "name": "since",
907
+ "text": "7.22.0"
908
+ }
909
+ ],
910
+ "docs": "Listen for breaking update events when the backend flags an update as incompatible with the current app.\nEmits the same payload as the legacy `majorAvailable` listener.",
583
911
  "complexTypes": [
584
912
  "PluginListenerHandle",
585
- "DownloadCompleteListener"
913
+ "BreakingAvailableEvent"
586
914
  ],
587
- "slug": "addlistenerdownloadcomplete"
915
+ "slug": "addlistenerbreakingavailable-"
588
916
  },
589
917
  {
590
918
  "name": "addListener",
591
- "signature": "(eventName: \"majorAvailable\", listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
919
+ "signature": "(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>",
592
920
  "parameters": [
593
921
  {
594
922
  "name": "eventName",
@@ -598,11 +926,15 @@
598
926
  {
599
927
  "name": "listenerFunc",
600
928
  "docs": "",
601
- "type": "MajorAvailableListener"
929
+ "type": "(state: MajorAvailableEvent) => void"
602
930
  }
603
931
  ],
604
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
932
+ "returns": "Promise<PluginListenerHandle>",
605
933
  "tags": [
934
+ {
935
+ "name": "deprecated",
936
+ "text": "Deprecated alias for {@link addListener} with `breakingAvailable`. Emits the same payload. will be removed in v8"
937
+ },
606
938
  {
607
939
  "name": "since",
608
940
  "text": "2.3.0"
@@ -611,13 +943,13 @@
611
943
  "docs": "Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking",
612
944
  "complexTypes": [
613
945
  "PluginListenerHandle",
614
- "MajorAvailableListener"
946
+ "MajorAvailableEvent"
615
947
  ],
616
- "slug": "addlistenermajoravailable"
948
+ "slug": "addlistenermajoravailable-"
617
949
  },
618
950
  {
619
951
  "name": "addListener",
620
- "signature": "(eventName: \"updateFailed\", listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
952
+ "signature": "(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>",
621
953
  "parameters": [
622
954
  {
623
955
  "name": "eventName",
@@ -627,10 +959,10 @@
627
959
  {
628
960
  "name": "listenerFunc",
629
961
  "docs": "",
630
- "type": "UpdateFailedListener"
962
+ "type": "(state: UpdateFailedEvent) => void"
631
963
  }
632
964
  ],
633
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
965
+ "returns": "Promise<PluginListenerHandle>",
634
966
  "tags": [
635
967
  {
636
968
  "name": "since",
@@ -640,13 +972,13 @@
640
972
  "docs": "Listen for update fail event in the App, let you know when update has fail to install at next app start",
641
973
  "complexTypes": [
642
974
  "PluginListenerHandle",
643
- "UpdateFailedListener"
975
+ "UpdateFailedEvent"
644
976
  ],
645
- "slug": "addlistenerupdatefailed"
977
+ "slug": "addlistenerupdatefailed-"
646
978
  },
647
979
  {
648
980
  "name": "addListener",
649
- "signature": "(eventName: \"downloadFailed\", listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
981
+ "signature": "(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>",
650
982
  "parameters": [
651
983
  {
652
984
  "name": "eventName",
@@ -656,26 +988,26 @@
656
988
  {
657
989
  "name": "listenerFunc",
658
990
  "docs": "",
659
- "type": "DownloadFailedListener"
991
+ "type": "(state: DownloadFailedEvent) => void"
660
992
  }
661
993
  ],
662
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
994
+ "returns": "Promise<PluginListenerHandle>",
663
995
  "tags": [
664
996
  {
665
997
  "name": "since",
666
998
  "text": "4.0.0"
667
999
  }
668
1000
  ],
669
- "docs": "Listen for download fail event in the App, let you know when download has fail finished",
1001
+ "docs": "Listen for download fail event in the App, let you know when a bundle download has failed",
670
1002
  "complexTypes": [
671
1003
  "PluginListenerHandle",
672
- "DownloadFailedListener"
1004
+ "DownloadFailedEvent"
673
1005
  ],
674
- "slug": "addlistenerdownloadfailed"
1006
+ "slug": "addlistenerdownloadfailed-"
675
1007
  },
676
1008
  {
677
1009
  "name": "addListener",
678
- "signature": "(eventName: \"appReloaded\", listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
1010
+ "signature": "(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>",
679
1011
  "parameters": [
680
1012
  {
681
1013
  "name": "eventName",
@@ -685,837 +1017,2762 @@
685
1017
  {
686
1018
  "name": "listenerFunc",
687
1019
  "docs": "",
688
- "type": "AppReloadedListener"
1020
+ "type": "() => void"
689
1021
  }
690
1022
  ],
691
- "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
1023
+ "returns": "Promise<PluginListenerHandle>",
692
1024
  "tags": [
693
1025
  {
694
1026
  "name": "since",
695
1027
  "text": "4.3.0"
696
1028
  }
697
1029
  ],
698
- "docs": "Listen for download fail event in the App, let you know when download has fail finished",
1030
+ "docs": "Listen for reload event in the App, let you know when reload has happened",
1031
+ "complexTypes": [
1032
+ "PluginListenerHandle"
1033
+ ],
1034
+ "slug": "addlistenerappreloaded-"
1035
+ },
1036
+ {
1037
+ "name": "addListener",
1038
+ "signature": "(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>",
1039
+ "parameters": [
1040
+ {
1041
+ "name": "eventName",
1042
+ "docs": "",
1043
+ "type": "'appReady'"
1044
+ },
1045
+ {
1046
+ "name": "listenerFunc",
1047
+ "docs": "",
1048
+ "type": "(state: AppReadyEvent) => void"
1049
+ }
1050
+ ],
1051
+ "returns": "Promise<PluginListenerHandle>",
1052
+ "tags": [
1053
+ {
1054
+ "name": "since",
1055
+ "text": "5.1.0"
1056
+ }
1057
+ ],
1058
+ "docs": "Listen for app ready event in the App, let you know when app is ready to use, this event is retain till consumed.",
699
1059
  "complexTypes": [
700
1060
  "PluginListenerHandle",
701
- "AppReloadedListener"
1061
+ "AppReadyEvent"
702
1062
  ],
703
- "slug": "addlistenerappreloaded"
1063
+ "slug": "addlistenerappready-"
704
1064
  },
705
1065
  {
706
- "name": "getDeviceId",
707
- "signature": "() => Promise<{ deviceId: string; }>",
1066
+ "name": "addListener",
1067
+ "signature": "(eventName: 'channelPrivate', listenerFunc: (state: ChannelPrivateEvent) => void) => Promise<PluginListenerHandle>",
1068
+ "parameters": [
1069
+ {
1070
+ "name": "eventName",
1071
+ "docs": "",
1072
+ "type": "'channelPrivate'"
1073
+ },
1074
+ {
1075
+ "name": "listenerFunc",
1076
+ "docs": "",
1077
+ "type": "(state: ChannelPrivateEvent) => void"
1078
+ }
1079
+ ],
1080
+ "returns": "Promise<PluginListenerHandle>",
1081
+ "tags": [
1082
+ {
1083
+ "name": "since",
1084
+ "text": "7.34.0"
1085
+ }
1086
+ ],
1087
+ "docs": "Listen for channel private event, fired when attempting to set a channel that doesn't allow device self-assignment.\n\nThis event is useful for:\n- Informing users they don't have permission to switch to a specific channel\n- Implementing custom error handling for channel restrictions\n- Logging unauthorized channel access attempts",
1088
+ "complexTypes": [
1089
+ "PluginListenerHandle",
1090
+ "ChannelPrivateEvent"
1091
+ ],
1092
+ "slug": "addlistenerchannelprivate-"
1093
+ },
1094
+ {
1095
+ "name": "addListener",
1096
+ "signature": "(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void) => Promise<PluginListenerHandle>",
1097
+ "parameters": [
1098
+ {
1099
+ "name": "eventName",
1100
+ "docs": "",
1101
+ "type": "'onFlexibleUpdateStateChange'"
1102
+ },
1103
+ {
1104
+ "name": "listenerFunc",
1105
+ "docs": "",
1106
+ "type": "(state: FlexibleUpdateState) => void"
1107
+ }
1108
+ ],
1109
+ "returns": "Promise<PluginListenerHandle>",
1110
+ "tags": [
1111
+ {
1112
+ "name": "since",
1113
+ "text": "8.0.0"
1114
+ }
1115
+ ],
1116
+ "docs": "Listen for flexible update state changes on Android.\n\nThis event fires during the flexible update download process, providing:\n- Download progress (bytes downloaded / total bytes)\n- Installation status changes\n\n**Install status values:**\n- `UNKNOWN` (0): Unknown status\n- `PENDING` (1): Download pending\n- `DOWNLOADING` (2): Download in progress\n- `INSTALLING` (3): Installing the update\n- `INSTALLED` (4): Update installed (app restart needed)\n- `FAILED` (5): Update failed\n- `CANCELED` (6): Update was canceled\n- `DOWNLOADED` (11): Download complete, ready to install\n\nWhen status is `DOWNLOADED`, you should prompt the user and call\n{@link completeFlexibleUpdate} to finish the installation.",
1117
+ "complexTypes": [
1118
+ "PluginListenerHandle",
1119
+ "FlexibleUpdateState"
1120
+ ],
1121
+ "slug": "addlisteneronflexibleupdatestatechange-"
1122
+ },
1123
+ {
1124
+ "name": "isAutoUpdateAvailable",
1125
+ "signature": "() => Promise<AutoUpdateAvailable>",
708
1126
  "parameters": [],
709
- "returns": "Promise<{ deviceId: string; }>",
1127
+ "returns": "Promise<AutoUpdateAvailable>",
710
1128
  "tags": [
711
1129
  {
712
1130
  "name": "returns",
713
- "text": "an Promise with id for this device"
1131
+ "text": "`false` when custom updateUrl is set, `true` otherwise."
714
1132
  },
715
1133
  {
716
1134
  "name": "throws",
717
- "text": "An error if the something went wrong"
1135
+ "text": "{Error} If the operation fails."
718
1136
  }
719
1137
  ],
720
- "docs": "Get unique ID used to identify device (sent to auto update server)",
721
- "complexTypes": [],
722
- "slug": "getdeviceid"
1138
+ "docs": "Check if the auto-update feature is available (not disabled by custom server configuration).\n\nReturns `false` when a custom `updateUrl` is configured, as this typically indicates\nyou're using a self-hosted update server that may not support all auto-update features.\n\nReturns `true` when using the default Capgo backend or when the feature is available.\n\nThis is different from {@link isAutoUpdateEnabled}:\n- `isAutoUpdateEnabled()`: Checks if auto-update MODE is turned on/off\n- `isAutoUpdateAvailable()`: Checks if auto-update is SUPPORTED with your current configuration",
1139
+ "complexTypes": [
1140
+ "AutoUpdateAvailable"
1141
+ ],
1142
+ "slug": "isautoupdateavailable"
723
1143
  },
724
1144
  {
725
- "name": "getPluginVersion",
726
- "signature": "() => Promise<{ version: string; }>",
1145
+ "name": "getNextBundle",
1146
+ "signature": "() => Promise<BundleInfo | null>",
727
1147
  "parameters": [],
728
- "returns": "Promise<{ version: string; }>",
1148
+ "returns": "Promise<BundleInfo | null>",
729
1149
  "tags": [
730
1150
  {
731
1151
  "name": "returns",
732
- "text": "an Promise with version for this device"
1152
+ "text": "The pending bundle info, or `null` if none is queued."
733
1153
  },
734
1154
  {
735
1155
  "name": "throws",
736
- "text": "An error if the something went wrong"
1156
+ "text": "{Error} If the operation fails."
1157
+ },
1158
+ {
1159
+ "name": "since",
1160
+ "text": "6.8.0"
737
1161
  }
738
1162
  ],
739
- "docs": "Get the native Capacitor Updater plugin version (sent to auto update server)",
740
- "complexTypes": [],
741
- "slug": "getpluginversion"
1163
+ "docs": "Get information about the bundle queued to be activated on next reload.\n\nReturns:\n- {@link BundleInfo} object if a bundle has been queued via {@link next}\n- `null` if no update is pending\n\nThis is useful to:\n- Check if an update is waiting to be applied\n- Display \"Update pending\" status to users\n- Show version info of the queued update\n- Decide whether to show a \"Restart to update\" prompt\n\nThe queued bundle will be activated when:\n- The app is backgrounded (default behavior)\n- The app is killed and restarted\n- {@link reload} is called manually\n- Delay conditions set by {@link setMultiDelay} are met",
1164
+ "complexTypes": [
1165
+ "BundleInfo"
1166
+ ],
1167
+ "slug": "getnextbundle"
742
1168
  },
743
1169
  {
744
- "name": "isAutoUpdateEnabled",
745
- "signature": "() => Promise<{ enabled: boolean; }>",
1170
+ "name": "getFailedUpdate",
1171
+ "signature": "() => Promise<UpdateFailedEvent | null>",
746
1172
  "parameters": [],
747
- "returns": "Promise<{ enabled: boolean; }>",
1173
+ "returns": "Promise<UpdateFailedEvent | null>",
748
1174
  "tags": [
749
1175
  {
750
1176
  "name": "returns",
751
- "text": "The status for auto update."
1177
+ "text": "The failed update info (cleared after first retrieval), or `null`."
752
1178
  },
753
1179
  {
754
1180
  "name": "throws",
755
- "text": "An error if the something went wrong"
1181
+ "text": "{Error} If the operation fails."
1182
+ },
1183
+ {
1184
+ "name": "since",
1185
+ "text": "7.22.0"
756
1186
  }
757
1187
  ],
758
- "docs": "Get the state of auto update config. This will return `false` in manual mode.",
759
- "complexTypes": [],
760
- "slug": "isautoupdateenabled"
1188
+ "docs": "Retrieve information about the most recent bundle that failed to load.\n\nWhen a bundle fails to load (e.g., JavaScript errors prevent initialization, missing files),\nthe plugin automatically rolls back and stores information about the failure. This method\nretrieves that failure information.\n\n**IMPORTANT: The stored value is cleared after being retrieved once.**\nCalling this method multiple times will only return the failure info on the first call,\nthen `null` on subsequent calls until another failure occurs.\n\nReturns:\n- {@link UpdateFailedEvent} with bundle info if a failure was recorded\n- `null` if no failure has occurred or if it was already retrieved\n\nUse this to:\n- Show users why an update failed\n- Log failure information for debugging\n- Implement custom error handling/reporting\n- Display rollback notifications",
1189
+ "complexTypes": [
1190
+ "UpdateFailedEvent"
1191
+ ],
1192
+ "slug": "getfailedupdate"
761
1193
  },
762
1194
  {
763
- "name": "removeAllListeners",
764
- "signature": "() => Promise<void>",
765
- "parameters": [],
1195
+ "name": "setShakeMenu",
1196
+ "signature": "(options: SetShakeMenuOptions) => Promise<void>",
1197
+ "parameters": [
1198
+ {
1199
+ "name": "options",
1200
+ "docs": "",
1201
+ "type": "SetShakeMenuOptions"
1202
+ }
1203
+ ],
766
1204
  "returns": "Promise<void>",
767
1205
  "tags": [
1206
+ {
1207
+ "name": "param",
1208
+ "text": "options"
1209
+ },
1210
+ {
1211
+ "name": "link",
1212
+ "text": "SetShakeMenuOptions} with `enabled: true` to enable or `enabled: false` to disable."
1213
+ },
1214
+ {
1215
+ "name": "returns",
1216
+ "text": "Resolves when the setting is applied."
1217
+ },
1218
+ {
1219
+ "name": "throws",
1220
+ "text": "{Error} If the operation fails."
1221
+ },
768
1222
  {
769
1223
  "name": "since",
770
- "text": "1.0.0"
1224
+ "text": "7.5.0"
771
1225
  }
772
1226
  ],
773
- "docs": "Remove all listeners for this plugin.",
774
- "complexTypes": [],
775
- "slug": "removealllisteners"
776
- }
777
- ],
778
- "properties": []
779
- },
780
- "interfaces": [
781
- {
782
- "name": "BundleInfo",
783
- "slug": "bundleinfo",
784
- "docs": "",
785
- "tags": [],
786
- "methods": [],
787
- "properties": [
788
- {
789
- "name": "id",
790
- "tags": [],
791
- "docs": "",
792
- "complexTypes": [],
793
- "type": "string"
794
- },
795
- {
796
- "name": "version",
797
- "tags": [],
798
- "docs": "",
799
- "complexTypes": [],
800
- "type": "string"
801
- },
802
- {
803
- "name": "downloaded",
804
- "tags": [],
805
- "docs": "",
806
- "complexTypes": [],
807
- "type": "string"
808
- },
809
- {
810
- "name": "checksum",
811
- "tags": [],
1227
+ "docs": "Enable or disable the shake gesture menu for debugging and testing.\n\nWhen enabled, users can shake their device to open a debug menu that shows:\n- Current bundle information\n- Available bundles\n- Options to switch bundles manually\n- Update status\n\nThis is useful during development and testing to:\n- Quickly test different bundle versions\n- Debug update flows\n- Switch between production and test bundles\n- Verify bundle installations\n\n**Important:** Disable this in production builds or only enable for internal testers.\n\nCan also be configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.",
1228
+ "complexTypes": [
1229
+ "SetShakeMenuOptions"
1230
+ ],
1231
+ "slug": "setshakemenu"
1232
+ },
1233
+ {
1234
+ "name": "isShakeMenuEnabled",
1235
+ "signature": "() => Promise<ShakeMenuEnabled>",
1236
+ "parameters": [],
1237
+ "returns": "Promise<ShakeMenuEnabled>",
1238
+ "tags": [
1239
+ {
1240
+ "name": "returns",
1241
+ "text": "Object with `enabled: true` or `enabled: false`."
1242
+ },
1243
+ {
1244
+ "name": "throws",
1245
+ "text": "{Error} If the operation fails."
1246
+ },
1247
+ {
1248
+ "name": "since",
1249
+ "text": "7.5.0"
1250
+ }
1251
+ ],
1252
+ "docs": "Check if the shake gesture debug menu is currently enabled.\n\nReturns the current state of the shake menu feature that can be toggled via\n{@link setShakeMenu} or configured via {@link PluginsConfig.CapacitorUpdater.shakeMenu}.\n\nUse this to:\n- Check if debug features are enabled\n- Show/hide debug settings UI\n- Verify configuration during testing",
1253
+ "complexTypes": [
1254
+ "ShakeMenuEnabled"
1255
+ ],
1256
+ "slug": "isshakemenuenabled"
1257
+ },
1258
+ {
1259
+ "name": "setShakeChannelSelector",
1260
+ "signature": "(options: SetShakeChannelSelectorOptions) => Promise<void>",
1261
+ "parameters": [
1262
+ {
1263
+ "name": "options",
1264
+ "docs": "",
1265
+ "type": "SetShakeChannelSelectorOptions"
1266
+ }
1267
+ ],
1268
+ "returns": "Promise<void>",
1269
+ "tags": [
1270
+ {
1271
+ "name": "param",
1272
+ "text": "options"
1273
+ },
1274
+ {
1275
+ "name": "link",
1276
+ "text": "SetShakeChannelSelectorOptions} with `enabled: true` to enable or `enabled: false` to disable."
1277
+ },
1278
+ {
1279
+ "name": "returns",
1280
+ "text": "Resolves when the setting is applied."
1281
+ },
1282
+ {
1283
+ "name": "throws",
1284
+ "text": "{Error} If the operation fails."
1285
+ },
1286
+ {
1287
+ "name": "since",
1288
+ "text": "8.43.0"
1289
+ }
1290
+ ],
1291
+ "docs": "Enable or disable the shake channel selector at runtime.\n\nWhen enabled AND shakeMenu is true, shaking the device shows a channel\nselector instead of the debug menu. This allows users to switch between\nupdate channels by shaking their device.\n\nAfter selecting a channel, the app automatically checks for updates\nand downloads if available.\n\nCan also be configured via {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.",
1292
+ "complexTypes": [
1293
+ "SetShakeChannelSelectorOptions"
1294
+ ],
1295
+ "slug": "setshakechannelselector"
1296
+ },
1297
+ {
1298
+ "name": "isShakeChannelSelectorEnabled",
1299
+ "signature": "() => Promise<ShakeChannelSelectorEnabled>",
1300
+ "parameters": [],
1301
+ "returns": "Promise<ShakeChannelSelectorEnabled>",
1302
+ "tags": [
1303
+ {
1304
+ "name": "returns",
1305
+ "text": "Object with `enabled: true` or `enabled: false`."
1306
+ },
1307
+ {
1308
+ "name": "throws",
1309
+ "text": "{Error} If the operation fails."
1310
+ },
1311
+ {
1312
+ "name": "since",
1313
+ "text": "8.43.0"
1314
+ }
1315
+ ],
1316
+ "docs": "Check if the shake channel selector is currently enabled.\n\nReturns the current state of the shake channel selector feature that can be toggled via\n{@link setShakeChannelSelector} or configured via {@link PluginsConfig.CapacitorUpdater.allowShakeChannelSelector}.",
1317
+ "complexTypes": [
1318
+ "ShakeChannelSelectorEnabled"
1319
+ ],
1320
+ "slug": "isshakechannelselectorenabled"
1321
+ },
1322
+ {
1323
+ "name": "getAppId",
1324
+ "signature": "() => Promise<GetAppIdRes>",
1325
+ "parameters": [],
1326
+ "returns": "Promise<GetAppIdRes>",
1327
+ "tags": [
1328
+ {
1329
+ "name": "returns",
1330
+ "text": "Object containing the current `appId` string."
1331
+ },
1332
+ {
1333
+ "name": "throws",
1334
+ "text": "{Error} If the operation fails."
1335
+ },
1336
+ {
1337
+ "name": "since",
1338
+ "text": "7.14.0"
1339
+ }
1340
+ ],
1341
+ "docs": "Get the currently configured App ID used for update server communication.\n\nReturns the App ID that identifies this app to the update server. This can be:\n- The value set via {@link setAppId}, or\n- The {@link PluginsConfig.CapacitorUpdater.appId} config value, or\n- The default app identifier from your native app configuration\n\nUse this to:\n- Verify which App ID is being used for updates\n- Debug update delivery issues\n- Display app configuration in debug screens\n- Confirm App ID after calling {@link setAppId}",
1342
+ "complexTypes": [
1343
+ "GetAppIdRes"
1344
+ ],
1345
+ "slug": "getappid"
1346
+ },
1347
+ {
1348
+ "name": "setAppId",
1349
+ "signature": "(options: SetAppIdOptions) => Promise<void>",
1350
+ "parameters": [
1351
+ {
1352
+ "name": "options",
1353
+ "docs": "",
1354
+ "type": "SetAppIdOptions"
1355
+ }
1356
+ ],
1357
+ "returns": "Promise<void>",
1358
+ "tags": [
1359
+ {
1360
+ "name": "param",
1361
+ "text": "options"
1362
+ },
1363
+ {
1364
+ "name": "link",
1365
+ "text": "SetAppIdOptions} containing the new App ID string."
1366
+ },
1367
+ {
1368
+ "name": "returns",
1369
+ "text": "Resolves when the App ID is successfully changed."
1370
+ },
1371
+ {
1372
+ "name": "throws",
1373
+ "text": "{Error} If `allowModifyAppId` is false or the operation fails."
1374
+ },
1375
+ {
1376
+ "name": "since",
1377
+ "text": "7.14.0"
1378
+ }
1379
+ ],
1380
+ "docs": "Dynamically change the App ID used for update server communication.\n\nThis overrides the App ID used to identify your app to the update server, allowing you\nto switch between different app configurations at runtime (e.g., production vs staging\napp IDs, or multi-tenant configurations).\n\n**Requirements:**\n- {@link PluginsConfig.CapacitorUpdater.allowModifyAppId} must be set to `true`\n\n**Important considerations:**\n- Changing the App ID will affect which updates this device receives\n- The new App ID must exist on your update server\n- This is primarily for advanced use cases (multi-tenancy, environment switching)\n- Most apps should use the config-based {@link PluginsConfig.CapacitorUpdater.appId} instead",
1381
+ "complexTypes": [
1382
+ "SetAppIdOptions"
1383
+ ],
1384
+ "slug": "setappid"
1385
+ },
1386
+ {
1387
+ "name": "getAppUpdateInfo",
1388
+ "signature": "(options?: GetAppUpdateInfoOptions | undefined) => Promise<AppUpdateInfo>",
1389
+ "parameters": [
1390
+ {
1391
+ "name": "options",
1392
+ "docs": "Optional {@link GetAppUpdateInfoOptions} with country code for iOS.",
1393
+ "type": "GetAppUpdateInfoOptions | undefined"
1394
+ }
1395
+ ],
1396
+ "returns": "Promise<AppUpdateInfo>",
1397
+ "tags": [
1398
+ {
1399
+ "name": "param",
1400
+ "text": "options Optional {@link GetAppUpdateInfoOptions} with country code for iOS."
1401
+ },
1402
+ {
1403
+ "name": "returns",
1404
+ "text": "Information about the current and available app versions."
1405
+ },
1406
+ {
1407
+ "name": "throws",
1408
+ "text": "{Error} If the operation fails or store information is unavailable."
1409
+ },
1410
+ {
1411
+ "name": "since",
1412
+ "text": "8.0.0"
1413
+ }
1414
+ ],
1415
+ "docs": "Get information about the app's availability in the App Store or Play Store.\n\nThis method checks the native app stores to see if a newer version of the app\nis available for download. This is different from Capgo's OTA updates - this\nchecks for native app updates that require going through the app stores.\n\n**Platform differences:**\n- **Android**: Uses Play Store's In-App Updates API for accurate update information\n- **iOS**: Queries the App Store lookup API (requires country code for accurate results)\n\n**Returns information about:**\n- Current installed version\n- Available version in the store (if any)\n- Whether an update is available\n- Update priority (Android only)\n- Whether immediate/flexible updates are allowed (Android only)\n\nUse this to:\n- Check if users need to update from the app store\n- Show \"Update Available\" prompts for native updates\n- Implement version gating (require minimum native version)\n- Combine with Capgo OTA updates for a complete update strategy",
1416
+ "complexTypes": [
1417
+ "AppUpdateInfo",
1418
+ "GetAppUpdateInfoOptions"
1419
+ ],
1420
+ "slug": "getappupdateinfo"
1421
+ },
1422
+ {
1423
+ "name": "openAppStore",
1424
+ "signature": "(options?: OpenAppStoreOptions | undefined) => Promise<void>",
1425
+ "parameters": [
1426
+ {
1427
+ "name": "options",
1428
+ "docs": "Optional {@link OpenAppStoreOptions} to customize which app's store page to open.",
1429
+ "type": "OpenAppStoreOptions | undefined"
1430
+ }
1431
+ ],
1432
+ "returns": "Promise<void>",
1433
+ "tags": [
1434
+ {
1435
+ "name": "param",
1436
+ "text": "options Optional {@link OpenAppStoreOptions} to customize which app's store page to open."
1437
+ },
1438
+ {
1439
+ "name": "returns",
1440
+ "text": "Resolves when the store is opened."
1441
+ },
1442
+ {
1443
+ "name": "throws",
1444
+ "text": "{Error} If the store cannot be opened."
1445
+ },
1446
+ {
1447
+ "name": "since",
1448
+ "text": "8.0.0"
1449
+ }
1450
+ ],
1451
+ "docs": "Open the app's page in the App Store or Play Store.\n\nThis navigates the user to your app's store listing where they can manually\nupdate the app. Use this as a fallback when in-app updates are not available\nor when the user needs to update on iOS.\n\n**Platform behavior:**\n- **Android**: Opens Play Store to the app's page\n- **iOS**: Opens App Store to the app's page\n\n**Customization options:**\n- `appId`: Specify a custom App Store ID (iOS) - useful for opening a different app's page\n- `packageName`: Specify a custom package name (Android) - useful for opening a different app's page",
1452
+ "complexTypes": [
1453
+ "OpenAppStoreOptions"
1454
+ ],
1455
+ "slug": "openappstore"
1456
+ },
1457
+ {
1458
+ "name": "performImmediateUpdate",
1459
+ "signature": "() => Promise<AppUpdateResult>",
1460
+ "parameters": [],
1461
+ "returns": "Promise<AppUpdateResult>",
1462
+ "tags": [
1463
+ {
1464
+ "name": "returns",
1465
+ "text": "Result indicating success, cancellation, or failure."
1466
+ },
1467
+ {
1468
+ "name": "throws",
1469
+ "text": "{Error} If not on Android, no update is available, or immediate updates not allowed."
1470
+ },
1471
+ {
1472
+ "name": "since",
1473
+ "text": "8.0.0"
1474
+ }
1475
+ ],
1476
+ "docs": "Perform an immediate in-app update on Android.\n\nThis triggers Google Play's immediate update flow, which:\n1. Shows a full-screen update UI\n2. Downloads and installs the update\n3. Restarts the app automatically\n\nThe user cannot continue using the app until the update is complete.\nThis is ideal for critical updates that must be installed immediately.\n\n**Requirements:**\n- Android only (throws error on iOS)\n- An update must be available (check with {@link getAppUpdateInfo} first)\n- The update must allow immediate updates (`immediateUpdateAllowed: true`)\n\n**User experience:**\n- Full-screen blocking UI\n- Progress shown during download\n- App automatically restarts after installation",
1477
+ "complexTypes": [
1478
+ "AppUpdateResult"
1479
+ ],
1480
+ "slug": "performimmediateupdate"
1481
+ },
1482
+ {
1483
+ "name": "startFlexibleUpdate",
1484
+ "signature": "() => Promise<AppUpdateResult>",
1485
+ "parameters": [],
1486
+ "returns": "Promise<AppUpdateResult>",
1487
+ "tags": [
1488
+ {
1489
+ "name": "returns",
1490
+ "text": "Result indicating the update was started, cancelled, or failed."
1491
+ },
1492
+ {
1493
+ "name": "throws",
1494
+ "text": "{Error} If not on Android, no update is available, or flexible updates not allowed."
1495
+ },
1496
+ {
1497
+ "name": "since",
1498
+ "text": "8.0.0"
1499
+ }
1500
+ ],
1501
+ "docs": "Start a flexible in-app update on Android.\n\nThis triggers Google Play's flexible update flow, which:\n1. Downloads the update in the background\n2. Allows the user to continue using the app\n3. Notifies when download is complete\n4. Requires calling {@link completeFlexibleUpdate} to install\n\nMonitor the download progress using the `onFlexibleUpdateStateChange` listener.\n\n**Requirements:**\n- Android only (throws error on iOS)\n- An update must be available (check with {@link getAppUpdateInfo} first)\n- The update must allow flexible updates (`flexibleUpdateAllowed: true`)\n\n**Typical flow:**\n1. Call `startFlexibleUpdate()` to begin download\n2. Listen to `onFlexibleUpdateStateChange` for progress\n3. When status is `DOWNLOADED`, prompt user to restart\n4. Call `completeFlexibleUpdate()` to install and restart",
1502
+ "complexTypes": [
1503
+ "AppUpdateResult"
1504
+ ],
1505
+ "slug": "startflexibleupdate"
1506
+ },
1507
+ {
1508
+ "name": "completeFlexibleUpdate",
1509
+ "signature": "() => Promise<void>",
1510
+ "parameters": [],
1511
+ "returns": "Promise<void>",
1512
+ "tags": [
1513
+ {
1514
+ "name": "returns",
1515
+ "text": "Resolves when the update installation begins (app will restart)."
1516
+ },
1517
+ {
1518
+ "name": "throws",
1519
+ "text": "{Error} If not on Android or no downloaded update is pending."
1520
+ },
1521
+ {
1522
+ "name": "since",
1523
+ "text": "8.0.0"
1524
+ }
1525
+ ],
1526
+ "docs": "Complete a flexible in-app update on Android.\n\nAfter a flexible update has been downloaded (status `DOWNLOADED` in\n`onFlexibleUpdateStateChange`), call this method to install the update\nand restart the app.\n\n**Important:** This will immediately restart the app. Make sure to:\n- Save any user data before calling\n- Prompt the user before restarting\n- Only call when the download status is `DOWNLOADED`",
1527
+ "complexTypes": [],
1528
+ "slug": "completeflexibleupdate"
1529
+ }
1530
+ ],
1531
+ "properties": []
1532
+ },
1533
+ "interfaces": [
1534
+ {
1535
+ "name": "AppReadyResult",
1536
+ "slug": "appreadyresult",
1537
+ "docs": "",
1538
+ "tags": [],
1539
+ "methods": [],
1540
+ "properties": [
1541
+ {
1542
+ "name": "bundle",
1543
+ "tags": [],
1544
+ "docs": "",
1545
+ "complexTypes": [
1546
+ "BundleInfo"
1547
+ ],
1548
+ "type": "BundleInfo"
1549
+ }
1550
+ ]
1551
+ },
1552
+ {
1553
+ "name": "BundleInfo",
1554
+ "slug": "bundleinfo",
1555
+ "docs": "",
1556
+ "tags": [],
1557
+ "methods": [],
1558
+ "properties": [
1559
+ {
1560
+ "name": "id",
1561
+ "tags": [],
1562
+ "docs": "",
1563
+ "complexTypes": [],
1564
+ "type": "string"
1565
+ },
1566
+ {
1567
+ "name": "version",
1568
+ "tags": [],
1569
+ "docs": "",
1570
+ "complexTypes": [],
1571
+ "type": "string"
1572
+ },
1573
+ {
1574
+ "name": "downloaded",
1575
+ "tags": [],
1576
+ "docs": "",
1577
+ "complexTypes": [],
1578
+ "type": "string"
1579
+ },
1580
+ {
1581
+ "name": "checksum",
1582
+ "tags": [],
1583
+ "docs": "",
1584
+ "complexTypes": [],
1585
+ "type": "string"
1586
+ },
1587
+ {
1588
+ "name": "status",
1589
+ "tags": [],
1590
+ "docs": "",
1591
+ "complexTypes": [
1592
+ "BundleStatus"
1593
+ ],
1594
+ "type": "BundleStatus"
1595
+ }
1596
+ ]
1597
+ },
1598
+ {
1599
+ "name": "UpdateUrl",
1600
+ "slug": "updateurl",
1601
+ "docs": "",
1602
+ "tags": [],
1603
+ "methods": [],
1604
+ "properties": [
1605
+ {
1606
+ "name": "url",
1607
+ "tags": [],
1608
+ "docs": "",
1609
+ "complexTypes": [],
1610
+ "type": "string"
1611
+ }
1612
+ ]
1613
+ },
1614
+ {
1615
+ "name": "StatsUrl",
1616
+ "slug": "statsurl",
1617
+ "docs": "",
1618
+ "tags": [],
1619
+ "methods": [],
1620
+ "properties": [
1621
+ {
1622
+ "name": "url",
1623
+ "tags": [],
1624
+ "docs": "",
1625
+ "complexTypes": [],
1626
+ "type": "string"
1627
+ }
1628
+ ]
1629
+ },
1630
+ {
1631
+ "name": "ChannelUrl",
1632
+ "slug": "channelurl",
1633
+ "docs": "",
1634
+ "tags": [],
1635
+ "methods": [],
1636
+ "properties": [
1637
+ {
1638
+ "name": "url",
1639
+ "tags": [],
1640
+ "docs": "",
1641
+ "complexTypes": [],
1642
+ "type": "string"
1643
+ }
1644
+ ]
1645
+ },
1646
+ {
1647
+ "name": "DownloadOptions",
1648
+ "slug": "downloadoptions",
1649
+ "docs": "This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest.\nIf you don't use backend, you need to provide the URL and version of the bundle. Checksum and sessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.",
1650
+ "tags": [],
1651
+ "methods": [],
1652
+ "properties": [
1653
+ {
1654
+ "name": "url",
1655
+ "tags": [],
1656
+ "docs": "The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you've hosted your bundle.)",
1657
+ "complexTypes": [],
1658
+ "type": "string"
1659
+ },
1660
+ {
1661
+ "name": "version",
1662
+ "tags": [],
1663
+ "docs": "The version code/name of this bundle/version",
1664
+ "complexTypes": [],
1665
+ "type": "string"
1666
+ },
1667
+ {
1668
+ "name": "sessionKey",
1669
+ "tags": [
1670
+ {
1671
+ "text": "4.0.0",
1672
+ "name": "since"
1673
+ },
1674
+ {
1675
+ "text": "undefined",
1676
+ "name": "default"
1677
+ }
1678
+ ],
1679
+ "docs": "The session key for the update, when the bundle is encrypted with a session key",
1680
+ "complexTypes": [],
1681
+ "type": "string | undefined"
1682
+ },
1683
+ {
1684
+ "name": "checksum",
1685
+ "tags": [
1686
+ {
1687
+ "text": "4.0.0",
1688
+ "name": "since"
1689
+ },
1690
+ {
1691
+ "text": "undefined",
1692
+ "name": "default"
1693
+ }
1694
+ ],
1695
+ "docs": "The checksum for the update, it should be in sha256 and encrypted with private key if the bundle is encrypted",
1696
+ "complexTypes": [],
1697
+ "type": "string | undefined"
1698
+ },
1699
+ {
1700
+ "name": "manifest",
1701
+ "tags": [
1702
+ {
1703
+ "text": "6.1.0",
1704
+ "name": "since"
1705
+ },
1706
+ {
1707
+ "text": "undefined",
1708
+ "name": "default"
1709
+ }
1710
+ ],
1711
+ "docs": "The manifest for multi-file downloads",
1712
+ "complexTypes": [
1713
+ "ManifestEntry"
1714
+ ],
1715
+ "type": "ManifestEntry[] | undefined"
1716
+ }
1717
+ ]
1718
+ },
1719
+ {
1720
+ "name": "ManifestEntry",
1721
+ "slug": "manifestentry",
1722
+ "docs": "",
1723
+ "tags": [],
1724
+ "methods": [],
1725
+ "properties": [
1726
+ {
1727
+ "name": "file_name",
1728
+ "tags": [],
1729
+ "docs": "",
1730
+ "complexTypes": [],
1731
+ "type": "string | null"
1732
+ },
1733
+ {
1734
+ "name": "file_hash",
1735
+ "tags": [],
1736
+ "docs": "",
1737
+ "complexTypes": [],
1738
+ "type": "string | null"
1739
+ },
1740
+ {
1741
+ "name": "download_url",
1742
+ "tags": [],
1743
+ "docs": "",
1744
+ "complexTypes": [],
1745
+ "type": "string | null"
1746
+ }
1747
+ ]
1748
+ },
1749
+ {
1750
+ "name": "BundleId",
1751
+ "slug": "bundleid",
1752
+ "docs": "",
1753
+ "tags": [],
1754
+ "methods": [],
1755
+ "properties": [
1756
+ {
1757
+ "name": "id",
1758
+ "tags": [],
1759
+ "docs": "",
1760
+ "complexTypes": [],
1761
+ "type": "string"
1762
+ }
1763
+ ]
1764
+ },
1765
+ {
1766
+ "name": "BundleListResult",
1767
+ "slug": "bundlelistresult",
1768
+ "docs": "",
1769
+ "tags": [],
1770
+ "methods": [],
1771
+ "properties": [
1772
+ {
1773
+ "name": "bundles",
1774
+ "tags": [],
1775
+ "docs": "",
1776
+ "complexTypes": [
1777
+ "BundleInfo"
1778
+ ],
1779
+ "type": "BundleInfo[]"
1780
+ }
1781
+ ]
1782
+ },
1783
+ {
1784
+ "name": "ListOptions",
1785
+ "slug": "listoptions",
1786
+ "docs": "",
1787
+ "tags": [],
1788
+ "methods": [],
1789
+ "properties": [
1790
+ {
1791
+ "name": "raw",
1792
+ "tags": [
1793
+ {
1794
+ "text": "6.14.0",
1795
+ "name": "since"
1796
+ },
1797
+ {
1798
+ "text": "false",
1799
+ "name": "default"
1800
+ }
1801
+ ],
1802
+ "docs": "Whether to return the raw bundle list or the manifest. If true, the list will attempt to read the internal database instead of files on disk.",
1803
+ "complexTypes": [],
1804
+ "type": "boolean | undefined"
1805
+ }
1806
+ ]
1807
+ },
1808
+ {
1809
+ "name": "ResetOptions",
1810
+ "slug": "resetoptions",
1811
+ "docs": "",
1812
+ "tags": [],
1813
+ "methods": [],
1814
+ "properties": [
1815
+ {
1816
+ "name": "toLastSuccessful",
1817
+ "tags": [],
1818
+ "docs": "",
1819
+ "complexTypes": [],
1820
+ "type": "boolean"
1821
+ }
1822
+ ]
1823
+ },
1824
+ {
1825
+ "name": "CurrentBundleResult",
1826
+ "slug": "currentbundleresult",
1827
+ "docs": "",
1828
+ "tags": [],
1829
+ "methods": [],
1830
+ "properties": [
1831
+ {
1832
+ "name": "bundle",
1833
+ "tags": [],
1834
+ "docs": "",
1835
+ "complexTypes": [
1836
+ "BundleInfo"
1837
+ ],
1838
+ "type": "BundleInfo"
1839
+ },
1840
+ {
1841
+ "name": "native",
1842
+ "tags": [],
1843
+ "docs": "",
1844
+ "complexTypes": [],
1845
+ "type": "string"
1846
+ }
1847
+ ]
1848
+ },
1849
+ {
1850
+ "name": "MultiDelayConditions",
1851
+ "slug": "multidelayconditions",
1852
+ "docs": "",
1853
+ "tags": [],
1854
+ "methods": [],
1855
+ "properties": [
1856
+ {
1857
+ "name": "delayConditions",
1858
+ "tags": [],
1859
+ "docs": "",
1860
+ "complexTypes": [
1861
+ "DelayCondition"
1862
+ ],
1863
+ "type": "DelayCondition[]"
1864
+ }
1865
+ ]
1866
+ },
1867
+ {
1868
+ "name": "DelayCondition",
1869
+ "slug": "delaycondition",
1870
+ "docs": "",
1871
+ "tags": [],
1872
+ "methods": [],
1873
+ "properties": [
1874
+ {
1875
+ "name": "kind",
1876
+ "tags": [
1877
+ {
1878
+ "text": "value is useless for",
1879
+ "name": "param"
1880
+ },
1881
+ {
1882
+ "text": "kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"",
1883
+ "name": "param"
1884
+ }
1885
+ ],
1886
+ "docs": "Set up delay conditions in setMultiDelay",
1887
+ "complexTypes": [
1888
+ "DelayUntilNext"
1889
+ ],
1890
+ "type": "DelayUntilNext"
1891
+ },
1892
+ {
1893
+ "name": "value",
1894
+ "tags": [],
1895
+ "docs": "",
1896
+ "complexTypes": [],
1897
+ "type": "string | undefined"
1898
+ }
1899
+ ]
1900
+ },
1901
+ {
1902
+ "name": "LatestVersion",
1903
+ "slug": "latestversion",
1904
+ "docs": "",
1905
+ "tags": [],
1906
+ "methods": [],
1907
+ "properties": [
1908
+ {
1909
+ "name": "version",
1910
+ "tags": [
1911
+ {
1912
+ "text": "4.0.0",
1913
+ "name": "since"
1914
+ }
1915
+ ],
1916
+ "docs": "Result of getLatest method",
1917
+ "complexTypes": [],
1918
+ "type": "string"
1919
+ },
1920
+ {
1921
+ "name": "checksum",
1922
+ "tags": [
1923
+ {
1924
+ "text": "6",
1925
+ "name": "since"
1926
+ }
1927
+ ],
1928
+ "docs": "",
1929
+ "complexTypes": [],
1930
+ "type": "string | undefined"
1931
+ },
1932
+ {
1933
+ "name": "breaking",
1934
+ "tags": [
1935
+ {
1936
+ "text": "7.22.0",
1937
+ "name": "since"
1938
+ }
1939
+ ],
1940
+ "docs": "Indicates whether the update was flagged as breaking by the backend.",
1941
+ "complexTypes": [],
1942
+ "type": "boolean | undefined"
1943
+ },
1944
+ {
1945
+ "name": "major",
1946
+ "tags": [
1947
+ {
1948
+ "text": "Use {@link LatestVersion.breaking} instead.",
1949
+ "name": "deprecated"
1950
+ }
1951
+ ],
1952
+ "docs": "",
1953
+ "complexTypes": [],
1954
+ "type": "boolean | undefined"
1955
+ },
1956
+ {
1957
+ "name": "message",
1958
+ "tags": [],
1959
+ "docs": "Optional message from the server.\nWhen no new version is available, this will be \"No new version available\".",
1960
+ "complexTypes": [],
1961
+ "type": "string | undefined"
1962
+ },
1963
+ {
1964
+ "name": "sessionKey",
1965
+ "tags": [],
1966
+ "docs": "",
1967
+ "complexTypes": [],
1968
+ "type": "string | undefined"
1969
+ },
1970
+ {
1971
+ "name": "error",
1972
+ "tags": [],
1973
+ "docs": "Error code from the server, if any.\nCommon values:\n- `\"no_new_version_available\"`: Device is already on the latest version (not a failure)\n- Other error codes indicate actual failures in the update process",
1974
+ "complexTypes": [],
1975
+ "type": "string | undefined"
1976
+ },
1977
+ {
1978
+ "name": "old",
1979
+ "tags": [],
1980
+ "docs": "The previous/current version name (provided for reference).",
1981
+ "complexTypes": [],
1982
+ "type": "string | undefined"
1983
+ },
1984
+ {
1985
+ "name": "url",
1986
+ "tags": [],
1987
+ "docs": "Download URL for the bundle (when a new version is available).",
1988
+ "complexTypes": [],
1989
+ "type": "string | undefined"
1990
+ },
1991
+ {
1992
+ "name": "manifest",
1993
+ "tags": [
1994
+ {
1995
+ "text": "6.1",
1996
+ "name": "since"
1997
+ }
1998
+ ],
1999
+ "docs": "File list for delta updates (when using multi-file downloads).",
2000
+ "complexTypes": [
2001
+ "ManifestEntry"
2002
+ ],
2003
+ "type": "ManifestEntry[] | undefined"
2004
+ },
2005
+ {
2006
+ "name": "link",
2007
+ "tags": [
2008
+ {
2009
+ "text": "7.35.0",
2010
+ "name": "since"
2011
+ }
2012
+ ],
2013
+ "docs": "Optional link associated with this bundle version (e.g., release notes URL, changelog, GitHub release).",
2014
+ "complexTypes": [],
2015
+ "type": "string | undefined"
2016
+ },
2017
+ {
2018
+ "name": "comment",
2019
+ "tags": [
2020
+ {
2021
+ "text": "7.35.0",
2022
+ "name": "since"
2023
+ }
2024
+ ],
2025
+ "docs": "Optional comment or description for this bundle version.",
2026
+ "complexTypes": [],
2027
+ "type": "string | undefined"
2028
+ }
2029
+ ]
2030
+ },
2031
+ {
2032
+ "name": "GetLatestOptions",
2033
+ "slug": "getlatestoptions",
2034
+ "docs": "",
2035
+ "tags": [],
2036
+ "methods": [],
2037
+ "properties": [
2038
+ {
2039
+ "name": "channel",
2040
+ "tags": [
2041
+ {
2042
+ "text": "6.8.0",
2043
+ "name": "since"
2044
+ },
2045
+ {
2046
+ "text": "undefined",
2047
+ "name": "default"
2048
+ }
2049
+ ],
2050
+ "docs": "The channel to get the latest version for\nThe channel must allow 'self_assign' for this to work",
2051
+ "complexTypes": [],
2052
+ "type": "string | undefined"
2053
+ }
2054
+ ]
2055
+ },
2056
+ {
2057
+ "name": "ChannelRes",
2058
+ "slug": "channelres",
2059
+ "docs": "",
2060
+ "tags": [],
2061
+ "methods": [],
2062
+ "properties": [
2063
+ {
2064
+ "name": "status",
2065
+ "tags": [
2066
+ {
2067
+ "text": "4.7.0",
2068
+ "name": "since"
2069
+ }
2070
+ ],
2071
+ "docs": "Current status of set channel",
2072
+ "complexTypes": [],
2073
+ "type": "string"
2074
+ },
2075
+ {
2076
+ "name": "error",
2077
+ "tags": [],
2078
+ "docs": "",
2079
+ "complexTypes": [],
2080
+ "type": "string | undefined"
2081
+ },
2082
+ {
2083
+ "name": "message",
2084
+ "tags": [],
2085
+ "docs": "",
2086
+ "complexTypes": [],
2087
+ "type": "string | undefined"
2088
+ }
2089
+ ]
2090
+ },
2091
+ {
2092
+ "name": "SetChannelOptions",
2093
+ "slug": "setchanneloptions",
2094
+ "docs": "",
2095
+ "tags": [],
2096
+ "methods": [],
2097
+ "properties": [
2098
+ {
2099
+ "name": "channel",
2100
+ "tags": [],
2101
+ "docs": "",
2102
+ "complexTypes": [],
2103
+ "type": "string"
2104
+ },
2105
+ {
2106
+ "name": "triggerAutoUpdate",
2107
+ "tags": [],
2108
+ "docs": "",
2109
+ "complexTypes": [],
2110
+ "type": "boolean | undefined"
2111
+ }
2112
+ ]
2113
+ },
2114
+ {
2115
+ "name": "UnsetChannelOptions",
2116
+ "slug": "unsetchanneloptions",
2117
+ "docs": "",
2118
+ "tags": [],
2119
+ "methods": [],
2120
+ "properties": [
2121
+ {
2122
+ "name": "triggerAutoUpdate",
2123
+ "tags": [],
2124
+ "docs": "",
2125
+ "complexTypes": [],
2126
+ "type": "boolean | undefined"
2127
+ }
2128
+ ]
2129
+ },
2130
+ {
2131
+ "name": "GetChannelRes",
2132
+ "slug": "getchannelres",
2133
+ "docs": "",
2134
+ "tags": [],
2135
+ "methods": [],
2136
+ "properties": [
2137
+ {
2138
+ "name": "channel",
2139
+ "tags": [
2140
+ {
2141
+ "text": "4.8.0",
2142
+ "name": "since"
2143
+ }
2144
+ ],
2145
+ "docs": "Current status of get channel",
2146
+ "complexTypes": [],
2147
+ "type": "string | undefined"
2148
+ },
2149
+ {
2150
+ "name": "error",
2151
+ "tags": [],
2152
+ "docs": "",
2153
+ "complexTypes": [],
2154
+ "type": "string | undefined"
2155
+ },
2156
+ {
2157
+ "name": "message",
2158
+ "tags": [],
2159
+ "docs": "",
2160
+ "complexTypes": [],
2161
+ "type": "string | undefined"
2162
+ },
2163
+ {
2164
+ "name": "status",
2165
+ "tags": [],
2166
+ "docs": "",
2167
+ "complexTypes": [],
2168
+ "type": "string | undefined"
2169
+ },
2170
+ {
2171
+ "name": "allowSet",
2172
+ "tags": [],
2173
+ "docs": "",
2174
+ "complexTypes": [],
2175
+ "type": "boolean | undefined"
2176
+ }
2177
+ ]
2178
+ },
2179
+ {
2180
+ "name": "ListChannelsResult",
2181
+ "slug": "listchannelsresult",
2182
+ "docs": "",
2183
+ "tags": [],
2184
+ "methods": [],
2185
+ "properties": [
2186
+ {
2187
+ "name": "channels",
2188
+ "tags": [
2189
+ {
2190
+ "text": "7.5.0",
2191
+ "name": "since"
2192
+ }
2193
+ ],
2194
+ "docs": "List of available channels",
2195
+ "complexTypes": [
2196
+ "ChannelInfo"
2197
+ ],
2198
+ "type": "ChannelInfo[]"
2199
+ }
2200
+ ]
2201
+ },
2202
+ {
2203
+ "name": "ChannelInfo",
2204
+ "slug": "channelinfo",
2205
+ "docs": "",
2206
+ "tags": [],
2207
+ "methods": [],
2208
+ "properties": [
2209
+ {
2210
+ "name": "id",
2211
+ "tags": [
2212
+ {
2213
+ "text": "7.5.0",
2214
+ "name": "since"
2215
+ }
2216
+ ],
2217
+ "docs": "The channel ID",
2218
+ "complexTypes": [],
2219
+ "type": "string"
2220
+ },
2221
+ {
2222
+ "name": "name",
2223
+ "tags": [
2224
+ {
2225
+ "text": "7.5.0",
2226
+ "name": "since"
2227
+ }
2228
+ ],
2229
+ "docs": "The channel name",
2230
+ "complexTypes": [],
2231
+ "type": "string"
2232
+ },
2233
+ {
2234
+ "name": "public",
2235
+ "tags": [
2236
+ {
2237
+ "text": "7.5.0",
2238
+ "name": "since"
2239
+ }
2240
+ ],
2241
+ "docs": "Whether this is a public channel",
2242
+ "complexTypes": [],
2243
+ "type": "boolean"
2244
+ },
2245
+ {
2246
+ "name": "allow_self_set",
2247
+ "tags": [
2248
+ {
2249
+ "text": "7.5.0",
2250
+ "name": "since"
2251
+ }
2252
+ ],
2253
+ "docs": "Whether devices can self-assign to this channel",
2254
+ "complexTypes": [],
2255
+ "type": "boolean"
2256
+ }
2257
+ ]
2258
+ },
2259
+ {
2260
+ "name": "SetCustomIdOptions",
2261
+ "slug": "setcustomidoptions",
2262
+ "docs": "",
2263
+ "tags": [],
2264
+ "methods": [],
2265
+ "properties": [
2266
+ {
2267
+ "name": "customId",
2268
+ "tags": [],
2269
+ "docs": "Custom identifier to associate with the device. Use an empty string to clear any saved value.",
2270
+ "complexTypes": [],
2271
+ "type": "string"
2272
+ }
2273
+ ]
2274
+ },
2275
+ {
2276
+ "name": "BuiltinVersion",
2277
+ "slug": "builtinversion",
2278
+ "docs": "",
2279
+ "tags": [],
2280
+ "methods": [],
2281
+ "properties": [
2282
+ {
2283
+ "name": "version",
2284
+ "tags": [],
2285
+ "docs": "",
2286
+ "complexTypes": [],
2287
+ "type": "string"
2288
+ }
2289
+ ]
2290
+ },
2291
+ {
2292
+ "name": "DeviceId",
2293
+ "slug": "deviceid",
2294
+ "docs": "",
2295
+ "tags": [],
2296
+ "methods": [],
2297
+ "properties": [
2298
+ {
2299
+ "name": "deviceId",
2300
+ "tags": [],
2301
+ "docs": "",
2302
+ "complexTypes": [],
2303
+ "type": "string"
2304
+ }
2305
+ ]
2306
+ },
2307
+ {
2308
+ "name": "PluginVersion",
2309
+ "slug": "pluginversion",
2310
+ "docs": "",
2311
+ "tags": [],
2312
+ "methods": [],
2313
+ "properties": [
2314
+ {
2315
+ "name": "version",
2316
+ "tags": [],
2317
+ "docs": "",
2318
+ "complexTypes": [],
2319
+ "type": "string"
2320
+ }
2321
+ ]
2322
+ },
2323
+ {
2324
+ "name": "AutoUpdateEnabled",
2325
+ "slug": "autoupdateenabled",
2326
+ "docs": "",
2327
+ "tags": [],
2328
+ "methods": [],
2329
+ "properties": [
2330
+ {
2331
+ "name": "enabled",
2332
+ "tags": [],
2333
+ "docs": "",
2334
+ "complexTypes": [],
2335
+ "type": "boolean"
2336
+ }
2337
+ ]
2338
+ },
2339
+ {
2340
+ "name": "PluginListenerHandle",
2341
+ "slug": "pluginlistenerhandle",
2342
+ "docs": "",
2343
+ "tags": [],
2344
+ "methods": [],
2345
+ "properties": [
2346
+ {
2347
+ "name": "remove",
2348
+ "tags": [],
2349
+ "docs": "",
2350
+ "complexTypes": [],
2351
+ "type": "() => Promise<void>"
2352
+ }
2353
+ ]
2354
+ },
2355
+ {
2356
+ "name": "DownloadEvent",
2357
+ "slug": "downloadevent",
2358
+ "docs": "",
2359
+ "tags": [],
2360
+ "methods": [],
2361
+ "properties": [
2362
+ {
2363
+ "name": "percent",
2364
+ "tags": [
2365
+ {
2366
+ "text": "4.0.0",
2367
+ "name": "since"
2368
+ }
2369
+ ],
2370
+ "docs": "Current status of download, between 0 and 100.",
2371
+ "complexTypes": [],
2372
+ "type": "number"
2373
+ },
2374
+ {
2375
+ "name": "bundle",
2376
+ "tags": [],
2377
+ "docs": "",
2378
+ "complexTypes": [
2379
+ "BundleInfo"
2380
+ ],
2381
+ "type": "BundleInfo"
2382
+ }
2383
+ ]
2384
+ },
2385
+ {
2386
+ "name": "NoNeedEvent",
2387
+ "slug": "noneedevent",
2388
+ "docs": "",
2389
+ "tags": [],
2390
+ "methods": [],
2391
+ "properties": [
2392
+ {
2393
+ "name": "bundle",
2394
+ "tags": [
2395
+ {
2396
+ "text": "4.0.0",
2397
+ "name": "since"
2398
+ }
2399
+ ],
2400
+ "docs": "Current status of download, between 0 and 100.",
2401
+ "complexTypes": [
2402
+ "BundleInfo"
2403
+ ],
2404
+ "type": "BundleInfo"
2405
+ }
2406
+ ]
2407
+ },
2408
+ {
2409
+ "name": "UpdateAvailableEvent",
2410
+ "slug": "updateavailableevent",
2411
+ "docs": "",
2412
+ "tags": [],
2413
+ "methods": [],
2414
+ "properties": [
2415
+ {
2416
+ "name": "bundle",
2417
+ "tags": [
2418
+ {
2419
+ "text": "4.0.0",
2420
+ "name": "since"
2421
+ }
2422
+ ],
2423
+ "docs": "Current status of download, between 0 and 100.",
2424
+ "complexTypes": [
2425
+ "BundleInfo"
2426
+ ],
2427
+ "type": "BundleInfo"
2428
+ }
2429
+ ]
2430
+ },
2431
+ {
2432
+ "name": "DownloadCompleteEvent",
2433
+ "slug": "downloadcompleteevent",
2434
+ "docs": "",
2435
+ "tags": [],
2436
+ "methods": [],
2437
+ "properties": [
2438
+ {
2439
+ "name": "bundle",
2440
+ "tags": [
2441
+ {
2442
+ "text": "4.0.0",
2443
+ "name": "since"
2444
+ }
2445
+ ],
2446
+ "docs": "Emit when a new update is available.",
2447
+ "complexTypes": [
2448
+ "BundleInfo"
2449
+ ],
2450
+ "type": "BundleInfo"
2451
+ }
2452
+ ]
2453
+ },
2454
+ {
2455
+ "name": "MajorAvailableEvent",
2456
+ "slug": "majoravailableevent",
2457
+ "docs": "",
2458
+ "tags": [],
2459
+ "methods": [],
2460
+ "properties": [
2461
+ {
2462
+ "name": "version",
2463
+ "tags": [
2464
+ {
2465
+ "text": "Deprecated alias for {@link BreakingAvailableEvent}. Receives the same payload.",
2466
+ "name": "deprecated"
2467
+ },
2468
+ {
2469
+ "text": "4.0.0",
2470
+ "name": "since"
2471
+ }
2472
+ ],
2473
+ "docs": "Emit when a breaking update is available.",
2474
+ "complexTypes": [],
2475
+ "type": "string"
2476
+ }
2477
+ ]
2478
+ },
2479
+ {
2480
+ "name": "UpdateFailedEvent",
2481
+ "slug": "updatefailedevent",
2482
+ "docs": "",
2483
+ "tags": [],
2484
+ "methods": [],
2485
+ "properties": [
2486
+ {
2487
+ "name": "bundle",
2488
+ "tags": [
2489
+ {
2490
+ "text": "4.0.0",
2491
+ "name": "since"
2492
+ }
2493
+ ],
2494
+ "docs": "Emit when a update failed to install.",
2495
+ "complexTypes": [
2496
+ "BundleInfo"
2497
+ ],
2498
+ "type": "BundleInfo"
2499
+ }
2500
+ ]
2501
+ },
2502
+ {
2503
+ "name": "DownloadFailedEvent",
2504
+ "slug": "downloadfailedevent",
2505
+ "docs": "",
2506
+ "tags": [],
2507
+ "methods": [],
2508
+ "properties": [
2509
+ {
2510
+ "name": "version",
2511
+ "tags": [
2512
+ {
2513
+ "text": "4.0.0",
2514
+ "name": "since"
2515
+ }
2516
+ ],
2517
+ "docs": "Emit when a download fail.",
2518
+ "complexTypes": [],
2519
+ "type": "string"
2520
+ }
2521
+ ]
2522
+ },
2523
+ {
2524
+ "name": "AppReadyEvent",
2525
+ "slug": "appreadyevent",
2526
+ "docs": "",
2527
+ "tags": [],
2528
+ "methods": [],
2529
+ "properties": [
2530
+ {
2531
+ "name": "bundle",
2532
+ "tags": [
2533
+ {
2534
+ "text": "5.2.0",
2535
+ "name": "since"
2536
+ }
2537
+ ],
2538
+ "docs": "Emitted when the app is ready to use.",
2539
+ "complexTypes": [
2540
+ "BundleInfo"
2541
+ ],
2542
+ "type": "BundleInfo"
2543
+ },
2544
+ {
2545
+ "name": "status",
2546
+ "tags": [],
2547
+ "docs": "",
2548
+ "complexTypes": [],
2549
+ "type": "string"
2550
+ }
2551
+ ]
2552
+ },
2553
+ {
2554
+ "name": "ChannelPrivateEvent",
2555
+ "slug": "channelprivateevent",
2556
+ "docs": "",
2557
+ "tags": [],
2558
+ "methods": [],
2559
+ "properties": [
2560
+ {
2561
+ "name": "channel",
2562
+ "tags": [
2563
+ {
2564
+ "text": "7.34.0",
2565
+ "name": "since"
2566
+ }
2567
+ ],
2568
+ "docs": "Emitted when attempting to set a channel that doesn't allow device self-assignment.",
2569
+ "complexTypes": [],
2570
+ "type": "string"
2571
+ },
2572
+ {
2573
+ "name": "message",
2574
+ "tags": [],
2575
+ "docs": "",
2576
+ "complexTypes": [],
2577
+ "type": "string"
2578
+ }
2579
+ ]
2580
+ },
2581
+ {
2582
+ "name": "FlexibleUpdateState",
2583
+ "slug": "flexibleupdatestate",
2584
+ "docs": "State information for flexible update progress (Android only).",
2585
+ "tags": [
2586
+ {
2587
+ "text": "8.0.0",
2588
+ "name": "since"
2589
+ }
2590
+ ],
2591
+ "methods": [],
2592
+ "properties": [
2593
+ {
2594
+ "name": "installStatus",
2595
+ "tags": [
2596
+ {
2597
+ "text": "8.0.0",
2598
+ "name": "since"
2599
+ }
2600
+ ],
2601
+ "docs": "The current installation status.",
2602
+ "complexTypes": [
2603
+ "FlexibleUpdateInstallStatus"
2604
+ ],
2605
+ "type": "FlexibleUpdateInstallStatus"
2606
+ },
2607
+ {
2608
+ "name": "bytesDownloaded",
2609
+ "tags": [
2610
+ {
2611
+ "text": "8.0.0",
2612
+ "name": "since"
2613
+ }
2614
+ ],
2615
+ "docs": "Number of bytes downloaded so far.\nOnly available during the `DOWNLOADING` status.",
2616
+ "complexTypes": [],
2617
+ "type": "number | undefined"
2618
+ },
2619
+ {
2620
+ "name": "totalBytesToDownload",
2621
+ "tags": [
2622
+ {
2623
+ "text": "8.0.0",
2624
+ "name": "since"
2625
+ }
2626
+ ],
2627
+ "docs": "Total number of bytes to download.\nOnly available during the `DOWNLOADING` status.",
2628
+ "complexTypes": [],
2629
+ "type": "number | undefined"
2630
+ }
2631
+ ]
2632
+ },
2633
+ {
2634
+ "name": "AutoUpdateAvailable",
2635
+ "slug": "autoupdateavailable",
2636
+ "docs": "",
2637
+ "tags": [],
2638
+ "methods": [],
2639
+ "properties": [
2640
+ {
2641
+ "name": "available",
2642
+ "tags": [],
2643
+ "docs": "",
2644
+ "complexTypes": [],
2645
+ "type": "boolean"
2646
+ }
2647
+ ]
2648
+ },
2649
+ {
2650
+ "name": "SetShakeMenuOptions",
2651
+ "slug": "setshakemenuoptions",
2652
+ "docs": "",
2653
+ "tags": [],
2654
+ "methods": [],
2655
+ "properties": [
2656
+ {
2657
+ "name": "enabled",
2658
+ "tags": [],
2659
+ "docs": "",
2660
+ "complexTypes": [],
2661
+ "type": "boolean"
2662
+ }
2663
+ ]
2664
+ },
2665
+ {
2666
+ "name": "ShakeMenuEnabled",
2667
+ "slug": "shakemenuenabled",
2668
+ "docs": "",
2669
+ "tags": [],
2670
+ "methods": [],
2671
+ "properties": [
2672
+ {
2673
+ "name": "enabled",
2674
+ "tags": [],
2675
+ "docs": "",
2676
+ "complexTypes": [],
2677
+ "type": "boolean"
2678
+ }
2679
+ ]
2680
+ },
2681
+ {
2682
+ "name": "SetShakeChannelSelectorOptions",
2683
+ "slug": "setshakechannelselectoroptions",
2684
+ "docs": "",
2685
+ "tags": [],
2686
+ "methods": [],
2687
+ "properties": [
2688
+ {
2689
+ "name": "enabled",
2690
+ "tags": [],
2691
+ "docs": "",
2692
+ "complexTypes": [],
2693
+ "type": "boolean"
2694
+ }
2695
+ ]
2696
+ },
2697
+ {
2698
+ "name": "ShakeChannelSelectorEnabled",
2699
+ "slug": "shakechannelselectorenabled",
2700
+ "docs": "",
2701
+ "tags": [],
2702
+ "methods": [],
2703
+ "properties": [
2704
+ {
2705
+ "name": "enabled",
2706
+ "tags": [],
2707
+ "docs": "",
2708
+ "complexTypes": [],
2709
+ "type": "boolean"
2710
+ }
2711
+ ]
2712
+ },
2713
+ {
2714
+ "name": "GetAppIdRes",
2715
+ "slug": "getappidres",
2716
+ "docs": "",
2717
+ "tags": [],
2718
+ "methods": [],
2719
+ "properties": [
2720
+ {
2721
+ "name": "appId",
2722
+ "tags": [],
2723
+ "docs": "",
2724
+ "complexTypes": [],
2725
+ "type": "string"
2726
+ }
2727
+ ]
2728
+ },
2729
+ {
2730
+ "name": "SetAppIdOptions",
2731
+ "slug": "setappidoptions",
2732
+ "docs": "",
2733
+ "tags": [],
2734
+ "methods": [],
2735
+ "properties": [
2736
+ {
2737
+ "name": "appId",
2738
+ "tags": [],
812
2739
  "docs": "",
813
2740
  "complexTypes": [],
814
2741
  "type": "string"
2742
+ }
2743
+ ]
2744
+ },
2745
+ {
2746
+ "name": "AppUpdateInfo",
2747
+ "slug": "appupdateinfo",
2748
+ "docs": "Information about app updates available in the App Store or Play Store.",
2749
+ "tags": [
2750
+ {
2751
+ "text": "8.0.0",
2752
+ "name": "since"
2753
+ }
2754
+ ],
2755
+ "methods": [],
2756
+ "properties": [
2757
+ {
2758
+ "name": "currentVersionName",
2759
+ "tags": [
2760
+ {
2761
+ "text": "8.0.0",
2762
+ "name": "since"
2763
+ }
2764
+ ],
2765
+ "docs": "The currently installed version name (e.g., \"1.2.3\").",
2766
+ "complexTypes": [],
2767
+ "type": "string"
2768
+ },
2769
+ {
2770
+ "name": "availableVersionName",
2771
+ "tags": [
2772
+ {
2773
+ "text": "8.0.0",
2774
+ "name": "since"
2775
+ }
2776
+ ],
2777
+ "docs": "The version name available in the store, if an update is available.\nMay be undefined if no update information is available.",
2778
+ "complexTypes": [],
2779
+ "type": "string | undefined"
2780
+ },
2781
+ {
2782
+ "name": "currentVersionCode",
2783
+ "tags": [
2784
+ {
2785
+ "text": "8.0.0",
2786
+ "name": "since"
2787
+ }
2788
+ ],
2789
+ "docs": "The currently installed version code (Android) or build number (iOS).",
2790
+ "complexTypes": [],
2791
+ "type": "string"
2792
+ },
2793
+ {
2794
+ "name": "availableVersionCode",
2795
+ "tags": [
2796
+ {
2797
+ "text": "8.0.0",
2798
+ "name": "since"
2799
+ }
2800
+ ],
2801
+ "docs": "The version code available in the store (Android only).\nOn iOS, this will be the same as `availableVersionName`.",
2802
+ "complexTypes": [],
2803
+ "type": "string | undefined"
2804
+ },
2805
+ {
2806
+ "name": "availableVersionReleaseDate",
2807
+ "tags": [
2808
+ {
2809
+ "text": "8.0.0",
2810
+ "name": "since"
2811
+ }
2812
+ ],
2813
+ "docs": "The release date of the available version (iOS only).\nFormat: ISO 8601 date string.",
2814
+ "complexTypes": [],
2815
+ "type": "string | undefined"
2816
+ },
2817
+ {
2818
+ "name": "updateAvailability",
2819
+ "tags": [
2820
+ {
2821
+ "text": "8.0.0",
2822
+ "name": "since"
2823
+ }
2824
+ ],
2825
+ "docs": "The current update availability status.",
2826
+ "complexTypes": [
2827
+ "AppUpdateAvailability"
2828
+ ],
2829
+ "type": "AppUpdateAvailability"
2830
+ },
2831
+ {
2832
+ "name": "updatePriority",
2833
+ "tags": [
2834
+ {
2835
+ "text": "8.0.0",
2836
+ "name": "since"
2837
+ }
2838
+ ],
2839
+ "docs": "The priority of the update as set by the developer in Play Console (Android only).\nValues range from 0 (default/lowest) to 5 (highest priority).\n\nUse this to decide whether to show an update prompt or force an update.",
2840
+ "complexTypes": [],
2841
+ "type": "number | undefined"
2842
+ },
2843
+ {
2844
+ "name": "immediateUpdateAllowed",
2845
+ "tags": [
2846
+ {
2847
+ "text": "8.0.0",
2848
+ "name": "since"
2849
+ }
2850
+ ],
2851
+ "docs": "Whether an immediate update is allowed (Android only).\n\nIf `true`, you can call {@link CapacitorUpdaterPlugin.performImmediateUpdate}.",
2852
+ "complexTypes": [],
2853
+ "type": "boolean | undefined"
2854
+ },
2855
+ {
2856
+ "name": "flexibleUpdateAllowed",
2857
+ "tags": [
2858
+ {
2859
+ "text": "8.0.0",
2860
+ "name": "since"
2861
+ }
2862
+ ],
2863
+ "docs": "Whether a flexible update is allowed (Android only).\n\nIf `true`, you can call {@link CapacitorUpdaterPlugin.startFlexibleUpdate}.",
2864
+ "complexTypes": [],
2865
+ "type": "boolean | undefined"
2866
+ },
2867
+ {
2868
+ "name": "clientVersionStalenessDays",
2869
+ "tags": [
2870
+ {
2871
+ "text": "8.0.0",
2872
+ "name": "since"
2873
+ }
2874
+ ],
2875
+ "docs": "Number of days since the update became available (Android only).\n\nUse this to implement \"update nagging\" - remind users more frequently\nas the update ages.",
2876
+ "complexTypes": [],
2877
+ "type": "number | undefined"
2878
+ },
2879
+ {
2880
+ "name": "installStatus",
2881
+ "tags": [
2882
+ {
2883
+ "text": "8.0.0",
2884
+ "name": "since"
2885
+ }
2886
+ ],
2887
+ "docs": "The current install status of a flexible update (Android only).",
2888
+ "complexTypes": [
2889
+ "FlexibleUpdateInstallStatus"
2890
+ ],
2891
+ "type": "FlexibleUpdateInstallStatus"
2892
+ },
2893
+ {
2894
+ "name": "minimumOsVersion",
2895
+ "tags": [
2896
+ {
2897
+ "text": "8.0.0",
2898
+ "name": "since"
2899
+ }
2900
+ ],
2901
+ "docs": "The minimum OS version required for the available update (iOS only).",
2902
+ "complexTypes": [],
2903
+ "type": "string | undefined"
2904
+ }
2905
+ ]
2906
+ },
2907
+ {
2908
+ "name": "GetAppUpdateInfoOptions",
2909
+ "slug": "getappupdateinfooptions",
2910
+ "docs": "Options for {@link CapacitorUpdaterPlugin.getAppUpdateInfo}.",
2911
+ "tags": [
2912
+ {
2913
+ "text": "8.0.0",
2914
+ "name": "since"
2915
+ }
2916
+ ],
2917
+ "methods": [],
2918
+ "properties": [
2919
+ {
2920
+ "name": "country",
2921
+ "tags": [
2922
+ {
2923
+ "text": "8.0.0",
2924
+ "name": "since"
2925
+ }
2926
+ ],
2927
+ "docs": "Two-letter country code (ISO 3166-1 alpha-2) for the App Store lookup.\n\nThis is required on iOS to get accurate App Store information, as app\navailability and versions can vary by country.\n\nExamples: \"US\", \"GB\", \"DE\", \"JP\", \"FR\"\n\nOn Android, this option is ignored as the Play Store handles region\ndetection automatically.",
2928
+ "complexTypes": [],
2929
+ "type": "string | undefined"
2930
+ }
2931
+ ]
2932
+ },
2933
+ {
2934
+ "name": "OpenAppStoreOptions",
2935
+ "slug": "openappstoreoptions",
2936
+ "docs": "Options for {@link CapacitorUpdaterPlugin.openAppStore}.",
2937
+ "tags": [
2938
+ {
2939
+ "text": "8.0.0",
2940
+ "name": "since"
2941
+ }
2942
+ ],
2943
+ "methods": [],
2944
+ "properties": [
2945
+ {
2946
+ "name": "packageName",
2947
+ "tags": [
2948
+ {
2949
+ "text": "8.0.0",
2950
+ "name": "since"
2951
+ }
2952
+ ],
2953
+ "docs": "The Android package name to open in the Play Store.\n\nIf not specified, uses the current app's package name.\nUse this to open a different app's store page.\n\nOnly used on Android.",
2954
+ "complexTypes": [],
2955
+ "type": "string | undefined"
2956
+ },
2957
+ {
2958
+ "name": "appId",
2959
+ "tags": [
2960
+ {
2961
+ "text": "8.0.0",
2962
+ "name": "since"
2963
+ }
2964
+ ],
2965
+ "docs": "The iOS App Store ID to open.\n\nIf not specified, uses the current app's bundle identifier to look up the app.\nUse this to open a different app's store page or when automatic lookup fails.\n\nOnly used on iOS.",
2966
+ "complexTypes": [],
2967
+ "type": "string | undefined"
2968
+ }
2969
+ ]
2970
+ },
2971
+ {
2972
+ "name": "AppUpdateResult",
2973
+ "slug": "appupdateresult",
2974
+ "docs": "Result of an app update operation.",
2975
+ "tags": [
2976
+ {
2977
+ "text": "8.0.0",
2978
+ "name": "since"
2979
+ }
2980
+ ],
2981
+ "methods": [],
2982
+ "properties": [
2983
+ {
2984
+ "name": "code",
2985
+ "tags": [
2986
+ {
2987
+ "text": "8.0.0",
2988
+ "name": "since"
2989
+ }
2990
+ ],
2991
+ "docs": "The result code of the update operation.",
2992
+ "complexTypes": [
2993
+ "AppUpdateResultCode"
2994
+ ],
2995
+ "type": "AppUpdateResultCode"
2996
+ }
2997
+ ]
2998
+ }
2999
+ ],
3000
+ "enums": [
3001
+ {
3002
+ "name": "FlexibleUpdateInstallStatus",
3003
+ "slug": "flexibleupdateinstallstatus",
3004
+ "members": [
3005
+ {
3006
+ "name": "UNKNOWN",
3007
+ "value": "0",
3008
+ "tags": [],
3009
+ "docs": "Unknown install status."
3010
+ },
3011
+ {
3012
+ "name": "PENDING",
3013
+ "value": "1",
3014
+ "tags": [],
3015
+ "docs": "Download is pending and will start soon."
3016
+ },
3017
+ {
3018
+ "name": "DOWNLOADING",
3019
+ "value": "2",
3020
+ "tags": [],
3021
+ "docs": "Download is in progress.\nCheck `bytesDownloaded` and `totalBytesToDownload` for progress."
3022
+ },
3023
+ {
3024
+ "name": "INSTALLING",
3025
+ "value": "3",
3026
+ "tags": [],
3027
+ "docs": "The update is being installed."
3028
+ },
3029
+ {
3030
+ "name": "INSTALLED",
3031
+ "value": "4",
3032
+ "tags": [],
3033
+ "docs": "The update has been installed.\nThe app needs to be restarted to use the new version."
3034
+ },
3035
+ {
3036
+ "name": "FAILED",
3037
+ "value": "5",
3038
+ "tags": [],
3039
+ "docs": "The update failed to download or install."
3040
+ },
3041
+ {
3042
+ "name": "CANCELED",
3043
+ "value": "6",
3044
+ "tags": [],
3045
+ "docs": "The update was canceled by the user."
3046
+ },
3047
+ {
3048
+ "name": "DOWNLOADED",
3049
+ "value": "11",
3050
+ "tags": [],
3051
+ "docs": "The update has been downloaded and is ready to install.\nCall {@link CapacitorUpdaterPlugin.completeFlexibleUpdate} to install."
3052
+ }
3053
+ ]
3054
+ },
3055
+ {
3056
+ "name": "AppUpdateAvailability",
3057
+ "slug": "appupdateavailability",
3058
+ "members": [
3059
+ {
3060
+ "name": "UNKNOWN",
3061
+ "value": "0",
3062
+ "tags": [],
3063
+ "docs": "Update availability is unknown.\nThis typically means the check hasn't completed or failed."
3064
+ },
3065
+ {
3066
+ "name": "UPDATE_NOT_AVAILABLE",
3067
+ "value": "1",
3068
+ "tags": [],
3069
+ "docs": "No update is available.\nThe installed version is the latest."
3070
+ },
3071
+ {
3072
+ "name": "UPDATE_AVAILABLE",
3073
+ "value": "2",
3074
+ "tags": [],
3075
+ "docs": "An update is available for download."
3076
+ },
3077
+ {
3078
+ "name": "UPDATE_IN_PROGRESS",
3079
+ "value": "3",
3080
+ "tags": [],
3081
+ "docs": "An update is currently being downloaded or installed."
3082
+ }
3083
+ ]
3084
+ },
3085
+ {
3086
+ "name": "AppUpdateResultCode",
3087
+ "slug": "appupdateresultcode",
3088
+ "members": [
3089
+ {
3090
+ "name": "OK",
3091
+ "value": "0",
3092
+ "tags": [],
3093
+ "docs": "The update completed successfully."
815
3094
  },
816
3095
  {
817
- "name": "status",
3096
+ "name": "CANCELED",
3097
+ "value": "1",
818
3098
  "tags": [],
819
- "docs": "",
820
- "complexTypes": [
821
- "BundleStatus"
822
- ],
823
- "type": "BundleStatus"
3099
+ "docs": "The user canceled the update."
3100
+ },
3101
+ {
3102
+ "name": "FAILED",
3103
+ "value": "2",
3104
+ "tags": [],
3105
+ "docs": "The update failed."
3106
+ },
3107
+ {
3108
+ "name": "NOT_AVAILABLE",
3109
+ "value": "3",
3110
+ "tags": [],
3111
+ "docs": "No update is available."
3112
+ },
3113
+ {
3114
+ "name": "NOT_ALLOWED",
3115
+ "value": "4",
3116
+ "tags": [],
3117
+ "docs": "The requested update type is not allowed.\nFor example, trying to perform an immediate update when only flexible is allowed."
3118
+ },
3119
+ {
3120
+ "name": "INFO_MISSING",
3121
+ "value": "5",
3122
+ "tags": [],
3123
+ "docs": "Required information is missing.\nThis can happen if {@link CapacitorUpdaterPlugin.getAppUpdateInfo} wasn't called first."
3124
+ }
3125
+ ]
3126
+ }
3127
+ ],
3128
+ "typeAliases": [
3129
+ {
3130
+ "name": "BundleStatus",
3131
+ "slug": "bundlestatus",
3132
+ "docs": "pending: The bundle is pending to be **SET** as the next bundle.\ndownloading: The bundle is being downloaded.\nsuccess: The bundle has been downloaded and is ready to be **SET** as the next bundle.\nerror: The bundle has failed to download.",
3133
+ "types": [
3134
+ {
3135
+ "text": "'success'",
3136
+ "complexTypes": []
3137
+ },
3138
+ {
3139
+ "text": "'error'",
3140
+ "complexTypes": []
3141
+ },
3142
+ {
3143
+ "text": "'pending'",
3144
+ "complexTypes": []
3145
+ },
3146
+ {
3147
+ "text": "'downloading'",
3148
+ "complexTypes": []
824
3149
  }
825
3150
  ]
826
3151
  },
827
3152
  {
828
- "name": "DelayCondition",
829
- "slug": "delaycondition",
3153
+ "name": "DelayUntilNext",
3154
+ "slug": "delayuntilnext",
830
3155
  "docs": "",
831
- "tags": [],
832
- "methods": [],
3156
+ "types": [
3157
+ {
3158
+ "text": "'background'",
3159
+ "complexTypes": []
3160
+ },
3161
+ {
3162
+ "text": "'kill'",
3163
+ "complexTypes": []
3164
+ },
3165
+ {
3166
+ "text": "'nativeVersion'",
3167
+ "complexTypes": []
3168
+ },
3169
+ {
3170
+ "text": "'date'",
3171
+ "complexTypes": []
3172
+ }
3173
+ ]
3174
+ },
3175
+ {
3176
+ "name": "BreakingAvailableEvent",
3177
+ "slug": "breakingavailableevent",
3178
+ "docs": "Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.",
3179
+ "types": [
3180
+ {
3181
+ "text": "MajorAvailableEvent",
3182
+ "complexTypes": [
3183
+ "MajorAvailableEvent"
3184
+ ]
3185
+ }
3186
+ ]
3187
+ }
3188
+ ],
3189
+ "pluginConfigs": [
3190
+ {
3191
+ "name": "CapacitorUpdater",
3192
+ "slug": "capacitorupdater",
833
3193
  "properties": [
834
3194
  {
835
- "name": "kind",
3195
+ "name": "appReadyTimeout",
836
3196
  "tags": [
837
3197
  {
838
- "text": "value is useless for",
839
- "name": "param"
3198
+ "text": "10000 // (10 seconds)",
3199
+ "name": "default"
840
3200
  },
841
3201
  {
842
- "text": "kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"",
843
- "name": "param"
3202
+ "text": "1000 // (1 second, minimum 1000)",
3203
+ "name": "example"
844
3204
  }
845
3205
  ],
846
- "docs": "Set up delay conditions in setMultiDelay",
847
- "complexTypes": [
848
- "DelayUntilNext"
3206
+ "docs": "Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n\nOnly available for Android and iOS.",
3207
+ "complexTypes": [],
3208
+ "type": "number | undefined"
3209
+ },
3210
+ {
3211
+ "name": "responseTimeout",
3212
+ "tags": [
3213
+ {
3214
+ "text": "20 // (20 second)",
3215
+ "name": "default"
3216
+ },
3217
+ {
3218
+ "text": "10 // (10 second)",
3219
+ "name": "example"
3220
+ }
849
3221
  ],
850
- "type": "DelayUntilNext"
3222
+ "docs": "Configure the number of seconds the native plugin should wait before considering API timeout.\n\nOnly available for Android and iOS.",
3223
+ "complexTypes": [],
3224
+ "type": "number | undefined"
851
3225
  },
852
3226
  {
853
- "name": "value",
854
- "tags": [],
855
- "docs": "",
3227
+ "name": "autoDeleteFailed",
3228
+ "tags": [
3229
+ {
3230
+ "text": "true",
3231
+ "name": "default"
3232
+ },
3233
+ {
3234
+ "text": "false",
3235
+ "name": "example"
3236
+ }
3237
+ ],
3238
+ "docs": "Configure whether the plugin should use automatically delete failed bundles.\n\nOnly available for Android and iOS.",
856
3239
  "complexTypes": [],
857
- "type": "string | undefined"
858
- }
859
- ]
860
- },
861
- {
862
- "name": "latestVersion",
863
- "slug": "latestversion",
864
- "docs": "",
865
- "tags": [],
866
- "methods": [],
867
- "properties": [
3240
+ "type": "boolean | undefined"
3241
+ },
868
3242
  {
869
- "name": "version",
3243
+ "name": "autoDeletePrevious",
870
3244
  "tags": [
871
3245
  {
872
- "text": "4.0.0",
873
- "name": "since"
3246
+ "text": "true",
3247
+ "name": "default"
3248
+ },
3249
+ {
3250
+ "text": "false",
3251
+ "name": "example"
874
3252
  }
875
3253
  ],
876
- "docs": "Res of getLatest method",
3254
+ "docs": "Configure whether the plugin should use automatically delete previous bundles after a successful update.\n\nOnly available for Android and iOS.",
877
3255
  "complexTypes": [],
878
- "type": "string"
3256
+ "type": "boolean | undefined"
879
3257
  },
880
3258
  {
881
- "name": "major",
882
- "tags": [],
883
- "docs": "",
3259
+ "name": "autoUpdate",
3260
+ "tags": [
3261
+ {
3262
+ "text": "true",
3263
+ "name": "default"
3264
+ },
3265
+ {
3266
+ "text": "false",
3267
+ "name": "example"
3268
+ }
3269
+ ],
3270
+ "docs": "Configure whether the plugin should use Auto Update via an update server.\n\nOnly available for Android and iOS.",
884
3271
  "complexTypes": [],
885
3272
  "type": "boolean | undefined"
886
3273
  },
887
3274
  {
888
- "name": "message",
889
- "tags": [],
890
- "docs": "",
3275
+ "name": "resetWhenUpdate",
3276
+ "tags": [
3277
+ {
3278
+ "text": "true",
3279
+ "name": "default"
3280
+ },
3281
+ {
3282
+ "text": "false",
3283
+ "name": "example"
3284
+ }
3285
+ ],
3286
+ "docs": "Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\nSetting this to false can broke the auto update flow if the user download from the store a native app bundle that is older than the current downloaded bundle. Upload will be prevented by channel setting downgrade_under_native.\nOnly available for Android and iOS.",
3287
+ "complexTypes": [],
3288
+ "type": "boolean | undefined"
3289
+ },
3290
+ {
3291
+ "name": "updateUrl",
3292
+ "tags": [
3293
+ {
3294
+ "text": "https://plugin.capgo.app/updates",
3295
+ "name": "default"
3296
+ },
3297
+ {
3298
+ "text": "https://example.com/api/auto_update",
3299
+ "name": "example"
3300
+ }
3301
+ ],
3302
+ "docs": "Configure the URL / endpoint to which update checks are sent.\n\nOnly available for Android and iOS.",
891
3303
  "complexTypes": [],
892
3304
  "type": "string | undefined"
893
3305
  },
894
3306
  {
895
- "name": "sessionKey",
896
- "tags": [],
897
- "docs": "",
3307
+ "name": "channelUrl",
3308
+ "tags": [
3309
+ {
3310
+ "text": "https://plugin.capgo.app/channel_self",
3311
+ "name": "default"
3312
+ },
3313
+ {
3314
+ "text": "https://example.com/api/channel",
3315
+ "name": "example"
3316
+ }
3317
+ ],
3318
+ "docs": "Configure the URL / endpoint for channel operations.\n\nOnly available for Android and iOS.",
898
3319
  "complexTypes": [],
899
3320
  "type": "string | undefined"
900
3321
  },
901
3322
  {
902
- "name": "error",
903
- "tags": [],
904
- "docs": "",
3323
+ "name": "statsUrl",
3324
+ "tags": [
3325
+ {
3326
+ "text": "https://plugin.capgo.app/stats",
3327
+ "name": "default"
3328
+ },
3329
+ {
3330
+ "text": "https://example.com/api/stats",
3331
+ "name": "example"
3332
+ }
3333
+ ],
3334
+ "docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
905
3335
  "complexTypes": [],
906
3336
  "type": "string | undefined"
907
3337
  },
908
3338
  {
909
- "name": "old",
910
- "tags": [],
911
- "docs": "",
3339
+ "name": "publicKey",
3340
+ "tags": [
3341
+ {
3342
+ "text": "undefined",
3343
+ "name": "default"
3344
+ },
3345
+ {
3346
+ "text": "6.2.0",
3347
+ "name": "since"
3348
+ }
3349
+ ],
3350
+ "docs": "Configure the public key for end to end live update encryption Version 2\n\nOnly available for Android and iOS.",
912
3351
  "complexTypes": [],
913
3352
  "type": "string | undefined"
914
3353
  },
915
3354
  {
916
- "name": "url",
917
- "tags": [],
918
- "docs": "",
3355
+ "name": "version",
3356
+ "tags": [
3357
+ {
3358
+ "text": "undefined",
3359
+ "name": "default"
3360
+ },
3361
+ {
3362
+ "text": "4.17.48",
3363
+ "name": "since"
3364
+ }
3365
+ ],
3366
+ "docs": "Configure the current version of the app. This will be used for the first update request.\nIf not set, the plugin will get the version from the native code.\n\nOnly available for Android and iOS.",
919
3367
  "complexTypes": [],
920
3368
  "type": "string | undefined"
921
- }
922
- ]
923
- },
924
- {
925
- "name": "channelRes",
926
- "slug": "channelres",
927
- "docs": "",
928
- "tags": [],
929
- "methods": [],
930
- "properties": [
3369
+ },
931
3370
  {
932
- "name": "status",
3371
+ "name": "directUpdate",
933
3372
  "tags": [
934
3373
  {
935
- "text": "4.7.0",
3374
+ "text": "false",
3375
+ "name": "default"
3376
+ },
3377
+ {
3378
+ "text": "5.1.0",
936
3379
  "name": "since"
937
3380
  }
938
3381
  ],
939
- "docs": "Current status of set channel",
3382
+ "docs": "Configure when the plugin should direct install updates. Only for autoUpdate mode.\nWorks well for apps less than 10MB and with uploads done using --delta flag.\nZip or apps more than 10MB will be relatively slow for users to update.\n- false: Never do direct updates (use default behavior: download at start, set when backgrounded)\n- atInstall: Direct update only when app is installed, updated from store, otherwise act as directUpdate = false\n- onLaunch: Direct update only on app installed, updated from store or after app kill, otherwise act as directUpdate = false\n- always: Direct update in all previous cases (app installed, updated from store, after app kill or app resume), never act as directUpdate = false\n- true: (deprecated) Same as \"always\" for backward compatibility\n\nActivate this flag will automatically make the CLI upload delta in CICD envs and will ask for confirmation in local uploads.\nOnly available for Android and iOS.",
940
3383
  "complexTypes": [],
941
- "type": "string"
3384
+ "type": "boolean | 'always' | 'atInstall' | 'onLaunch' | undefined"
942
3385
  },
943
3386
  {
944
- "name": "error",
945
- "tags": [],
946
- "docs": "",
3387
+ "name": "autoSplashscreen",
3388
+ "tags": [
3389
+ {
3390
+ "text": "false",
3391
+ "name": "default"
3392
+ },
3393
+ {
3394
+ "text": "7.6.0",
3395
+ "name": "since"
3396
+ }
3397
+ ],
3398
+ "docs": "Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed.\nThis removes the need to manually listen for appReady events and call SplashScreen.hide().\nOnly works when directUpdate is set to \"atInstall\", \"always\", \"onLaunch\", or true.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\nRequires autoUpdate and directUpdate to be enabled.\n\nOnly available for Android and iOS.",
947
3399
  "complexTypes": [],
948
- "type": "any"
3400
+ "type": "boolean | undefined"
949
3401
  },
950
3402
  {
951
- "name": "message",
952
- "tags": [],
953
- "docs": "",
954
- "complexTypes": [],
955
- "type": "any"
956
- }
957
- ]
958
- },
959
- {
960
- "name": "SetChannelOptions",
961
- "slug": "setchanneloptions",
962
- "docs": "",
963
- "tags": [],
964
- "methods": [],
965
- "properties": [
966
- {
967
- "name": "channel",
968
- "tags": [],
969
- "docs": "",
3403
+ "name": "autoSplashscreenLoader",
3404
+ "tags": [
3405
+ {
3406
+ "text": "false",
3407
+ "name": "default"
3408
+ },
3409
+ {
3410
+ "text": "7.19.0",
3411
+ "name": "since"
3412
+ }
3413
+ ],
3414
+ "docs": "Display a native loading indicator on top of the splashscreen while automatic direct updates are running.\nOnly takes effect when {@link autoSplashscreen} is enabled.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\n\nOnly available for Android and iOS.",
970
3415
  "complexTypes": [],
971
- "type": "string"
972
- }
973
- ]
974
- },
975
- {
976
- "name": "getChannelRes",
977
- "slug": "getchannelres",
978
- "docs": "",
979
- "tags": [],
980
- "methods": [],
981
- "properties": [
3416
+ "type": "boolean | undefined"
3417
+ },
982
3418
  {
983
- "name": "channel",
3419
+ "name": "autoSplashscreenTimeout",
984
3420
  "tags": [
985
3421
  {
986
- "text": "4.8.0",
3422
+ "text": "10000 // (10 seconds)",
3423
+ "name": "default"
3424
+ },
3425
+ {
3426
+ "text": "7.19.0",
987
3427
  "name": "since"
988
3428
  }
989
3429
  ],
990
- "docs": "Current status of get channel",
3430
+ "docs": "Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates.\nIf the timeout elapses, the update continues to download in the background while the splashscreen is dismissed.\nSet to `0` (zero) to disable the timeout.\nWhen the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch.\nRequires {@link autoSplashscreen} to be enabled.\n\nOnly available for Android and iOS.",
991
3431
  "complexTypes": [],
992
- "type": "string | undefined"
3432
+ "type": "number | undefined"
993
3433
  },
994
3434
  {
995
- "name": "error",
996
- "tags": [],
997
- "docs": "",
3435
+ "name": "periodCheckDelay",
3436
+ "tags": [
3437
+ {
3438
+ "text": "0 (disabled)",
3439
+ "name": "default"
3440
+ },
3441
+ {
3442
+ "text": "3600 (1 hour)",
3443
+ "name": "example"
3444
+ },
3445
+ {
3446
+ "text": "86400 (24 hours)",
3447
+ "name": "example"
3448
+ }
3449
+ ],
3450
+ "docs": "Configure the delay period for period update check. the unit is in seconds.\n\nOnly available for Android and iOS.\nCannot be less than 600 seconds (10 minutes).",
998
3451
  "complexTypes": [],
999
- "type": "any"
3452
+ "type": "number | undefined"
1000
3453
  },
1001
3454
  {
1002
- "name": "message",
1003
- "tags": [],
1004
- "docs": "",
3455
+ "name": "localS3",
3456
+ "tags": [
3457
+ {
3458
+ "text": "undefined",
3459
+ "name": "default"
3460
+ },
3461
+ {
3462
+ "text": "4.17.48",
3463
+ "name": "since"
3464
+ }
3465
+ ],
3466
+ "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
1005
3467
  "complexTypes": [],
1006
- "type": "any"
3468
+ "type": "boolean | undefined"
1007
3469
  },
1008
3470
  {
1009
- "name": "status",
1010
- "tags": [],
1011
- "docs": "",
3471
+ "name": "localHost",
3472
+ "tags": [
3473
+ {
3474
+ "text": "undefined",
3475
+ "name": "default"
3476
+ },
3477
+ {
3478
+ "text": "4.17.48",
3479
+ "name": "since"
3480
+ }
3481
+ ],
3482
+ "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
1012
3483
  "complexTypes": [],
1013
3484
  "type": "string | undefined"
1014
3485
  },
1015
3486
  {
1016
- "name": "allowSet",
1017
- "tags": [],
1018
- "docs": "",
1019
- "complexTypes": [],
1020
- "type": "boolean | undefined"
1021
- }
1022
- ]
1023
- },
1024
- {
1025
- "name": "SetCustomIdOptions",
1026
- "slug": "setcustomidoptions",
1027
- "docs": "",
1028
- "tags": [],
1029
- "methods": [],
1030
- "properties": [
1031
- {
1032
- "name": "customId",
1033
- "tags": [],
1034
- "docs": "",
1035
- "complexTypes": [],
1036
- "type": "string"
1037
- }
1038
- ]
1039
- },
1040
- {
1041
- "name": "PluginListenerHandle",
1042
- "slug": "pluginlistenerhandle",
1043
- "docs": "",
1044
- "tags": [],
1045
- "methods": [],
1046
- "properties": [
1047
- {
1048
- "name": "remove",
1049
- "tags": [],
1050
- "docs": "",
1051
- "complexTypes": [],
1052
- "type": "() => Promise<void>"
1053
- }
1054
- ]
1055
- },
1056
- {
1057
- "name": "DownloadEvent",
1058
- "slug": "downloadevent",
1059
- "docs": "",
1060
- "tags": [],
1061
- "methods": [],
1062
- "properties": [
1063
- {
1064
- "name": "percent",
3487
+ "name": "localWebHost",
1065
3488
  "tags": [
1066
3489
  {
1067
- "text": "4.0.0",
3490
+ "text": "undefined",
3491
+ "name": "default"
3492
+ },
3493
+ {
3494
+ "text": "4.17.48",
1068
3495
  "name": "since"
1069
3496
  }
1070
3497
  ],
1071
- "docs": "Current status of download, between 0 and 100.",
3498
+ "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
1072
3499
  "complexTypes": [],
1073
- "type": "number"
3500
+ "type": "string | undefined"
1074
3501
  },
1075
3502
  {
1076
- "name": "bundle",
1077
- "tags": [],
1078
- "docs": "",
1079
- "complexTypes": [
1080
- "BundleInfo"
1081
- ],
1082
- "type": "BundleInfo"
1083
- }
1084
- ]
1085
- },
1086
- {
1087
- "name": "noNeedEvent",
1088
- "slug": "noneedevent",
1089
- "docs": "",
1090
- "tags": [],
1091
- "methods": [],
1092
- "properties": [
1093
- {
1094
- "name": "bundle",
3503
+ "name": "localSupa",
1095
3504
  "tags": [
1096
3505
  {
1097
- "text": "4.0.0",
3506
+ "text": "undefined",
3507
+ "name": "default"
3508
+ },
3509
+ {
3510
+ "text": "4.17.48",
1098
3511
  "name": "since"
1099
3512
  }
1100
3513
  ],
1101
- "docs": "Current status of download, between 0 and 100.",
1102
- "complexTypes": [
1103
- "BundleInfo"
1104
- ],
1105
- "type": "BundleInfo"
1106
- }
1107
- ]
1108
- },
1109
- {
1110
- "name": "updateAvailableEvent",
1111
- "slug": "updateavailableevent",
1112
- "docs": "",
1113
- "tags": [],
1114
- "methods": [],
1115
- "properties": [
3514
+ "docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
3515
+ "complexTypes": [],
3516
+ "type": "string | undefined"
3517
+ },
1116
3518
  {
1117
- "name": "bundle",
3519
+ "name": "localSupaAnon",
1118
3520
  "tags": [
1119
3521
  {
1120
- "text": "4.0.0",
3522
+ "text": "undefined",
3523
+ "name": "default"
3524
+ },
3525
+ {
3526
+ "text": "4.17.48",
1121
3527
  "name": "since"
1122
3528
  }
1123
3529
  ],
1124
- "docs": "Current status of download, between 0 and 100.",
1125
- "complexTypes": [
1126
- "BundleInfo"
1127
- ],
1128
- "type": "BundleInfo"
1129
- }
1130
- ]
1131
- },
1132
- {
1133
- "name": "DownloadCompleteEvent",
1134
- "slug": "downloadcompleteevent",
1135
- "docs": "",
1136
- "tags": [],
1137
- "methods": [],
1138
- "properties": [
3530
+ "docs": "Configure the CLI to use a local server for testing.",
3531
+ "complexTypes": [],
3532
+ "type": "string | undefined"
3533
+ },
1139
3534
  {
1140
- "name": "bundle",
3535
+ "name": "localApi",
1141
3536
  "tags": [
1142
3537
  {
1143
- "text": "4.0.0",
3538
+ "text": "undefined",
3539
+ "name": "default"
3540
+ },
3541
+ {
3542
+ "text": "6.3.3",
1144
3543
  "name": "since"
1145
3544
  }
1146
3545
  ],
1147
- "docs": "Emit when a new update is available.",
1148
- "complexTypes": [
1149
- "BundleInfo"
1150
- ],
1151
- "type": "BundleInfo"
1152
- }
1153
- ]
1154
- },
1155
- {
1156
- "name": "MajorAvailableEvent",
1157
- "slug": "majoravailableevent",
1158
- "docs": "",
1159
- "tags": [],
1160
- "methods": [],
1161
- "properties": [
3546
+ "docs": "Configure the CLI to use a local api for testing.",
3547
+ "complexTypes": [],
3548
+ "type": "string | undefined"
3549
+ },
1162
3550
  {
1163
- "name": "version",
3551
+ "name": "localApiFiles",
1164
3552
  "tags": [
1165
3553
  {
1166
- "text": "4.0.0",
3554
+ "text": "undefined",
3555
+ "name": "default"
3556
+ },
3557
+ {
3558
+ "text": "6.3.3",
1167
3559
  "name": "since"
1168
3560
  }
1169
3561
  ],
1170
- "docs": "Emit when a new major bundle is available.",
3562
+ "docs": "Configure the CLI to use a local file api for testing.",
1171
3563
  "complexTypes": [],
1172
- "type": "string"
1173
- }
1174
- ]
1175
- },
1176
- {
1177
- "name": "UpdateFailedEvent",
1178
- "slug": "updatefailedevent",
1179
- "docs": "",
1180
- "tags": [],
1181
- "methods": [],
1182
- "properties": [
3564
+ "type": "string | undefined"
3565
+ },
1183
3566
  {
1184
- "name": "bundle",
3567
+ "name": "allowModifyUrl",
1185
3568
  "tags": [
1186
3569
  {
1187
- "text": "4.0.0",
3570
+ "text": "false",
3571
+ "name": "default"
3572
+ },
3573
+ {
3574
+ "text": "5.4.0",
1188
3575
  "name": "since"
1189
3576
  }
1190
3577
  ],
1191
- "docs": "Emit when a update failed to install.",
1192
- "complexTypes": [
1193
- "BundleInfo"
1194
- ],
1195
- "type": "BundleInfo"
1196
- }
1197
- ]
1198
- },
1199
- {
1200
- "name": "DownloadFailedEvent",
1201
- "slug": "downloadfailedevent",
1202
- "docs": "",
1203
- "tags": [],
1204
- "methods": [],
1205
- "properties": [
3578
+ "docs": "Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.",
3579
+ "complexTypes": [],
3580
+ "type": "boolean | undefined"
3581
+ },
1206
3582
  {
1207
- "name": "version",
3583
+ "name": "allowModifyAppId",
1208
3584
  "tags": [
1209
3585
  {
1210
- "text": "4.0.0",
3586
+ "text": "false",
3587
+ "name": "default"
3588
+ },
3589
+ {
3590
+ "text": "7.14.0",
1211
3591
  "name": "since"
1212
3592
  }
1213
3593
  ],
1214
- "docs": "Emit when a download fail.",
3594
+ "docs": "Allow the plugin to modify the appId dynamically from the JavaScript side.",
1215
3595
  "complexTypes": [],
1216
- "type": "string"
1217
- }
1218
- ]
1219
- }
1220
- ],
1221
- "enums": [],
1222
- "typeAliases": [
1223
- {
1224
- "name": "BundleStatus",
1225
- "slug": "bundlestatus",
1226
- "docs": "",
1227
- "types": [
1228
- {
1229
- "text": "\"success\"",
1230
- "complexTypes": []
1231
- },
1232
- {
1233
- "text": "\"error\"",
1234
- "complexTypes": []
1235
- },
1236
- {
1237
- "text": "\"pending\"",
1238
- "complexTypes": []
1239
- },
1240
- {
1241
- "text": "\"downloading\"",
1242
- "complexTypes": []
1243
- }
1244
- ]
1245
- },
1246
- {
1247
- "name": "DelayUntilNext",
1248
- "slug": "delayuntilnext",
1249
- "docs": "",
1250
- "types": [
1251
- {
1252
- "text": "\"background\"",
1253
- "complexTypes": []
1254
- },
1255
- {
1256
- "text": "\"kill\"",
1257
- "complexTypes": []
3596
+ "type": "boolean | undefined"
1258
3597
  },
1259
3598
  {
1260
- "text": "\"nativeVersion\"",
1261
- "complexTypes": []
3599
+ "name": "allowManualBundleError",
3600
+ "tags": [
3601
+ {
3602
+ "text": "false",
3603
+ "name": "default"
3604
+ },
3605
+ {
3606
+ "text": "7.20.0",
3607
+ "name": "since"
3608
+ }
3609
+ ],
3610
+ "docs": "Allow marking bundles as errored from JavaScript while using manual update flows.\nWhen enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`.",
3611
+ "complexTypes": [],
3612
+ "type": "boolean | undefined"
1262
3613
  },
1263
3614
  {
1264
- "text": "\"date\"",
1265
- "complexTypes": []
1266
- }
1267
- ]
1268
- },
1269
- {
1270
- "name": "DownloadChangeListener",
1271
- "slug": "downloadchangelistener",
1272
- "docs": "",
1273
- "types": [
1274
- {
1275
- "text": "(state: DownloadEvent): void",
1276
- "complexTypes": [
1277
- "DownloadEvent"
1278
- ]
1279
- }
1280
- ]
1281
- },
1282
- {
1283
- "name": "NoNeedListener",
1284
- "slug": "noneedlistener",
1285
- "docs": "",
1286
- "types": [
1287
- {
1288
- "text": "(state: noNeedEvent): void",
1289
- "complexTypes": [
1290
- "noNeedEvent"
1291
- ]
1292
- }
1293
- ]
1294
- },
1295
- {
1296
- "name": "UpdateAvailabledListener",
1297
- "slug": "updateavailabledlistener",
1298
- "docs": "",
1299
- "types": [
1300
- {
1301
- "text": "(state: updateAvailableEvent): void",
1302
- "complexTypes": [
1303
- "updateAvailableEvent"
1304
- ]
1305
- }
1306
- ]
1307
- },
1308
- {
1309
- "name": "DownloadCompleteListener",
1310
- "slug": "downloadcompletelistener",
1311
- "docs": "",
1312
- "types": [
1313
- {
1314
- "text": "(state: DownloadCompleteEvent): void",
1315
- "complexTypes": [
1316
- "DownloadCompleteEvent"
1317
- ]
1318
- }
1319
- ]
1320
- },
1321
- {
1322
- "name": "MajorAvailableListener",
1323
- "slug": "majoravailablelistener",
1324
- "docs": "",
1325
- "types": [
1326
- {
1327
- "text": "(state: MajorAvailableEvent): void",
1328
- "complexTypes": [
1329
- "MajorAvailableEvent"
1330
- ]
1331
- }
1332
- ]
1333
- },
1334
- {
1335
- "name": "UpdateFailedListener",
1336
- "slug": "updatefailedlistener",
1337
- "docs": "",
1338
- "types": [
1339
- {
1340
- "text": "(state: UpdateFailedEvent): void",
1341
- "complexTypes": [
1342
- "UpdateFailedEvent"
1343
- ]
1344
- }
1345
- ]
1346
- },
1347
- {
1348
- "name": "DownloadFailedListener",
1349
- "slug": "downloadfailedlistener",
1350
- "docs": "",
1351
- "types": [
1352
- {
1353
- "text": "(state: DownloadFailedEvent): void",
1354
- "complexTypes": [
1355
- "DownloadFailedEvent"
1356
- ]
1357
- }
1358
- ]
1359
- },
1360
- {
1361
- "name": "AppReloadedListener",
1362
- "slug": "appreloadedlistener",
1363
- "docs": "",
1364
- "types": [
1365
- {
1366
- "text": "(state: void): void",
1367
- "complexTypes": []
1368
- }
1369
- ]
1370
- }
1371
- ],
1372
- "pluginConfigs": [
1373
- {
1374
- "name": "CapacitorUpdater",
1375
- "slug": "capacitorupdater",
1376
- "properties": [
1377
- {
1378
- "name": "appReadyTimeout",
3615
+ "name": "persistCustomId",
1379
3616
  "tags": [
1380
3617
  {
1381
- "text": "10000 // (10 seconds)",
3618
+ "text": "false (will be true by default in a future major release v8.x.x)",
1382
3619
  "name": "default"
1383
3620
  },
1384
3621
  {
1385
- "text": "1000 // (1 second)",
1386
- "name": "example"
3622
+ "text": "7.17.3",
3623
+ "name": "since"
1387
3624
  }
1388
3625
  ],
1389
- "docs": "Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n\nOnly available for Android and iOS.",
3626
+ "docs": "Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts.\n\nOnly available for Android and iOS.",
1390
3627
  "complexTypes": [],
1391
- "type": "number | undefined"
3628
+ "type": "boolean | undefined"
1392
3629
  },
1393
3630
  {
1394
- "name": "autoDeleteFailed",
3631
+ "name": "persistModifyUrl",
1395
3632
  "tags": [
1396
3633
  {
1397
- "text": "true",
3634
+ "text": "false",
1398
3635
  "name": "default"
1399
3636
  },
1400
3637
  {
1401
- "text": "false",
1402
- "name": "example"
3638
+ "text": "7.20.0",
3639
+ "name": "since"
1403
3640
  }
1404
3641
  ],
1405
- "docs": "Configure whether the plugin should use automatically delete failed bundles.\n\nOnly available for Android and iOS.",
3642
+ "docs": "Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl},\n{@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts.\n\nOnly available for Android and iOS.",
1406
3643
  "complexTypes": [],
1407
3644
  "type": "boolean | undefined"
1408
3645
  },
1409
3646
  {
1410
- "name": "autoDeletePrevious",
3647
+ "name": "allowSetDefaultChannel",
1411
3648
  "tags": [
1412
3649
  {
1413
3650
  "text": "true",
1414
3651
  "name": "default"
1415
3652
  },
1416
3653
  {
1417
- "text": "false",
1418
- "name": "example"
3654
+ "text": "7.34.0",
3655
+ "name": "since"
1419
3656
  }
1420
3657
  ],
1421
- "docs": "Configure whether the plugin should use automatically delete previous bundles after a successful update.\n\nOnly available for Android and iOS.",
3658
+ "docs": "Allow or disallow the {@link CapacitorUpdaterPlugin.setChannel} method to modify the defaultChannel.\nWhen set to `false`, calling `setChannel()` will return an error with code `disabled_by_config`.",
1422
3659
  "complexTypes": [],
1423
3660
  "type": "boolean | undefined"
1424
3661
  },
1425
3662
  {
1426
- "name": "autoUpdate",
3663
+ "name": "defaultChannel",
1427
3664
  "tags": [
1428
3665
  {
1429
- "text": "true",
3666
+ "text": "undefined",
1430
3667
  "name": "default"
1431
3668
  },
1432
3669
  {
1433
- "text": "false",
1434
- "name": "example"
3670
+ "text": "5.5.0",
3671
+ "name": "since"
1435
3672
  }
1436
3673
  ],
1437
- "docs": "Configure whether the plugin should use Auto Update via an update server.\n\nOnly available for Android and iOS.",
3674
+ "docs": "Set the default channel for the app in the config. Case sensitive.\nThis will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.\nThis requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options",
1438
3675
  "complexTypes": [],
1439
- "type": "boolean | undefined"
3676
+ "type": "string | undefined"
1440
3677
  },
1441
3678
  {
1442
- "name": "resetWhenUpdate",
3679
+ "name": "appId",
1443
3680
  "tags": [
1444
3681
  {
1445
- "text": "true",
3682
+ "text": "undefined",
1446
3683
  "name": "default"
1447
3684
  },
3685
+ {
3686
+ "text": "6.0.0",
3687
+ "name": "since"
3688
+ }
3689
+ ],
3690
+ "docs": "Configure the app id for the app in the config.",
3691
+ "complexTypes": [],
3692
+ "type": "string | undefined"
3693
+ },
3694
+ {
3695
+ "name": "keepUrlPathAfterReload",
3696
+ "tags": [
1448
3697
  {
1449
3698
  "text": "false",
1450
- "name": "example"
3699
+ "name": "default"
3700
+ },
3701
+ {
3702
+ "text": "6.8.0",
3703
+ "name": "since"
1451
3704
  }
1452
3705
  ],
1453
- "docs": "Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\n\nOnly available for Android and iOS.",
3706
+ "docs": "Configure the plugin to keep the URL path after a reload.\nWARNING: When a reload is triggered, 'window.history' will be cleared.",
1454
3707
  "complexTypes": [],
1455
3708
  "type": "boolean | undefined"
1456
3709
  },
1457
3710
  {
1458
- "name": "updateUrl",
3711
+ "name": "disableJSLogging",
1459
3712
  "tags": [
1460
3713
  {
1461
- "text": "https://api.capgo.app/auto_update",
3714
+ "text": "false",
1462
3715
  "name": "default"
1463
3716
  },
1464
3717
  {
1465
- "text": "https://example.com/api/auto_update",
1466
- "name": "example"
3718
+ "text": "7.3.0",
3719
+ "name": "since"
1467
3720
  }
1468
3721
  ],
1469
- "docs": "Configure the URL / endpoint to which update checks are sent.\n\nOnly available for Android and iOS.",
3722
+ "docs": "Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done",
1470
3723
  "complexTypes": [],
1471
- "type": "string | undefined"
3724
+ "type": "boolean | undefined"
1472
3725
  },
1473
3726
  {
1474
- "name": "statsUrl",
3727
+ "name": "osLogging",
1475
3728
  "tags": [
1476
3729
  {
1477
- "text": "https://api.capgo.app/stats",
3730
+ "text": "true",
1478
3731
  "name": "default"
1479
3732
  },
1480
3733
  {
1481
- "text": "https://example.com/api/stats",
1482
- "name": "example"
3734
+ "text": "8.42.0",
3735
+ "name": "since"
1483
3736
  }
1484
3737
  ],
1485
- "docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
3738
+ "docs": "Enable OS-level logging. When enabled, logs are written to the system log which can be inspected in production builds.\n\n- **iOS**: Uses os_log instead of Swift.print, logs accessible via Console.app or Instruments\n- **Android**: Logs to Logcat (android.util.Log)\n\nWhen set to false, system logging is disabled on both platforms (only JavaScript console logging will occur if enabled).\n\nThis is useful for debugging production apps (App Store/TestFlight builds on iOS, or production APKs on Android).",
1486
3739
  "complexTypes": [],
1487
- "type": "string | undefined"
3740
+ "type": "boolean | undefined"
1488
3741
  },
1489
3742
  {
1490
- "name": "privateKey",
3743
+ "name": "shakeMenu",
1491
3744
  "tags": [
1492
3745
  {
1493
- "text": "undefined",
3746
+ "text": "false",
1494
3747
  "name": "default"
3748
+ },
3749
+ {
3750
+ "text": "7.5.0",
3751
+ "name": "since"
1495
3752
  }
1496
3753
  ],
1497
- "docs": "Configure the private key for end to end live update encryption.\n\nOnly available for Android and iOS.",
3754
+ "docs": "Enable shake gesture to show update menu for debugging/testing purposes",
1498
3755
  "complexTypes": [],
1499
- "type": "string | undefined"
3756
+ "type": "boolean | undefined"
1500
3757
  },
1501
3758
  {
1502
- "name": "version",
3759
+ "name": "allowShakeChannelSelector",
1503
3760
  "tags": [
1504
3761
  {
1505
- "text": "undefined",
3762
+ "text": "false",
1506
3763
  "name": "default"
1507
3764
  },
1508
3765
  {
1509
- "text": "4.17.48",
3766
+ "text": "8.43.0",
1510
3767
  "name": "since"
1511
3768
  }
1512
3769
  ],
1513
- "docs": "Configure the current version of the app. This will be used for the first update request.\nIf not set, the plugin will get the version from the native code.\n\nOnly available for Android and iOS.",
3770
+ "docs": "Enable the shake gesture to show a channel selector menu for switching between update channels.\nWhen enabled AND `shakeMenu` is true, the shake gesture shows a channel selector\ninstead of the default debug menu (Go Home/Reload/Close).\n\nAfter selecting a channel, the app automatically checks for updates and downloads if available.\nOnly works if channels have `allow_self_set` enabled on the backend.\n\nOnly available for Android and iOS.",
1514
3771
  "complexTypes": [],
1515
- "type": "string | undefined"
3772
+ "type": "boolean | undefined"
1516
3773
  }
1517
3774
  ],
1518
- "docs": "These configuration values are available:"
3775
+ "docs": "CapacitorUpdater can be configured with these options:"
1519
3776
  }
1520
3777
  ]
1521
3778
  }