@capgo/capacitor-updater 8.0.0 → 8.1.0
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.
- package/CapgoCapacitorUpdater.podspec +7 -5
- package/Package.swift +37 -0
- package/README.md +1461 -231
- package/android/build.gradle +29 -12
- package/android/proguard-rules.pro +45 -0
- package/android/src/main/AndroidManifest.xml +0 -1
- package/android/src/main/java/ee/forgr/capacitor_updater/BundleInfo.java +223 -195
- package/android/src/main/java/ee/forgr/capacitor_updater/BundleStatus.java +23 -23
- package/android/src/main/java/ee/forgr/capacitor_updater/Callback.java +13 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +2159 -1234
- package/android/src/main/java/ee/forgr/capacitor_updater/CapgoUpdater.java +1507 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/CryptoCipher.java +330 -121
- package/android/src/main/java/ee/forgr/capacitor_updater/DataManager.java +28 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/DelayCondition.java +43 -49
- package/android/src/main/java/ee/forgr/capacitor_updater/DelayUntilNext.java +4 -4
- package/android/src/main/java/ee/forgr/capacitor_updater/DelayUpdateUtils.java +260 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/DeviceIdHelper.java +221 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/DownloadService.java +808 -117
- package/android/src/main/java/ee/forgr/capacitor_updater/DownloadWorkerManager.java +156 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/InternalUtils.java +32 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/Logger.java +338 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/ShakeDetector.java +72 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/ShakeMenu.java +169 -0
- package/dist/docs.json +2187 -625
- package/dist/esm/definitions.d.ts +1286 -249
- package/dist/esm/definitions.js.map +1 -1
- package/dist/esm/history.d.ts +1 -0
- package/dist/esm/history.js +283 -0
- package/dist/esm/history.js.map +1 -0
- package/dist/esm/index.d.ts +3 -2
- package/dist/esm/index.js +5 -4
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/web.d.ts +36 -41
- package/dist/esm/web.js +94 -35
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +376 -35
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +376 -35
- package/dist/plugin.js.map +1 -1
- package/ios/Sources/CapacitorUpdaterPlugin/AES.swift +69 -0
- package/ios/Sources/CapacitorUpdaterPlugin/BigInt.swift +55 -0
- package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/BundleInfo.swift +37 -10
- package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/BundleStatus.swift +1 -1
- package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift +1605 -0
- package/ios/Sources/CapacitorUpdaterPlugin/CapgoUpdater.swift +1526 -0
- package/ios/Sources/CapacitorUpdaterPlugin/CryptoCipher.swift +267 -0
- package/ios/Sources/CapacitorUpdaterPlugin/DelayUpdateUtils.swift +220 -0
- package/ios/Sources/CapacitorUpdaterPlugin/DeviceIdHelper.swift +120 -0
- package/ios/Sources/CapacitorUpdaterPlugin/InternalUtils.swift +311 -0
- package/ios/Sources/CapacitorUpdaterPlugin/Logger.swift +310 -0
- package/ios/Sources/CapacitorUpdaterPlugin/RSA.swift +274 -0
- package/ios/Sources/CapacitorUpdaterPlugin/ShakeMenu.swift +112 -0
- package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/UserDefaultsExtension.swift +0 -2
- package/package.json +41 -35
- package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java +0 -1130
- package/ios/Plugin/CapacitorUpdater.swift +0 -858
- package/ios/Plugin/CapacitorUpdaterPlugin.h +0 -10
- package/ios/Plugin/CapacitorUpdaterPlugin.m +0 -27
- package/ios/Plugin/CapacitorUpdaterPlugin.swift +0 -675
- package/ios/Plugin/CryptoCipher.swift +0 -240
- /package/{LICENCE → LICENSE} +0 -0
- /package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/DelayCondition.swift +0 -0
- /package/ios/{Plugin → Sources/CapacitorUpdaterPlugin}/DelayUntilNext.swift +0 -0
- /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<
|
|
10
|
+
"signature": "() => Promise<AppReadyResult>",
|
|
11
11
|
"parameters": [],
|
|
12
|
-
"returns": "Promise<
|
|
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": "
|
|
43
|
+
"text": "Resolves when the URL is successfully updated."
|
|
17
44
|
},
|
|
18
45
|
{
|
|
19
46
|
"name": "throws",
|
|
20
|
-
"text": "
|
|
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": "
|
|
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
|
-
"
|
|
56
|
+
"UpdateUrl"
|
|
26
57
|
],
|
|
27
|
-
"slug": "
|
|
58
|
+
"slug": "setupdateurl"
|
|
28
59
|
},
|
|
29
60
|
{
|
|
30
|
-
"name": "
|
|
31
|
-
"signature": "(options:
|
|
61
|
+
"name": "setStatsUrl",
|
|
62
|
+
"signature": "(options: StatsUrl) => Promise<void>",
|
|
32
63
|
"parameters": [
|
|
33
64
|
{
|
|
34
65
|
"name": "options",
|
|
35
|
-
"docs": "",
|
|
36
|
-
"type": "
|
|
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<
|
|
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": "
|
|
78
|
+
"text": "Resolves when the URL is successfully updated."
|
|
44
79
|
},
|
|
45
80
|
{
|
|
46
|
-
"name": "
|
|
47
|
-
"text": "
|
|
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": "
|
|
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
|
|
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
|
|
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 partial 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:
|
|
168
|
+
"signature": "(options: BundleId) => Promise<BundleInfo>",
|
|
67
169
|
"parameters": [
|
|
68
170
|
{
|
|
69
171
|
"name": "options",
|
|
70
|
-
"docs": "",
|
|
71
|
-
"type": "
|
|
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": "
|
|
78
|
-
"text": "
|
|
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": "
|
|
82
|
-
"text": "
|
|
183
|
+
"name": "returns",
|
|
184
|
+
"text": "The {@link BundleInfo} for the specified bundle."
|
|
83
185
|
},
|
|
84
186
|
{
|
|
85
187
|
"name": "throws",
|
|
86
|
-
"text": "
|
|
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
|
|
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:
|
|
200
|
+
"signature": "(options: BundleId) => Promise<void>",
|
|
98
201
|
"parameters": [
|
|
99
202
|
{
|
|
100
203
|
"name": "options",
|
|
101
|
-
"docs": "",
|
|
102
|
-
"type": "
|
|
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": "
|
|
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": "
|
|
216
|
+
"text": "A promise that will never resolve because the JavaScript context is destroyed."
|
|
114
217
|
},
|
|
115
218
|
{
|
|
116
219
|
"name": "throws",
|
|
117
|
-
"text": "
|
|
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:
|
|
231
|
+
"signature": "(options: BundleId) => Promise<void>",
|
|
127
232
|
"parameters": [
|
|
128
233
|
{
|
|
129
234
|
"name": "options",
|
|
130
|
-
"docs": "",
|
|
131
|
-
"type": "
|
|
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": "
|
|
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": "
|
|
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": "
|
|
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": "
|
|
150
|
-
"complexTypes": [
|
|
151
|
-
|
|
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<
|
|
156
|
-
"parameters": [
|
|
157
|
-
|
|
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": "
|
|
314
|
+
"text": "A promise containing the array of {@link BundleInfo} objects."
|
|
162
315
|
},
|
|
163
316
|
{
|
|
164
317
|
"name": "throws",
|
|
165
|
-
"text": "
|
|
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
|
-
"
|
|
323
|
+
"BundleListResult",
|
|
324
|
+
"ListOptions"
|
|
171
325
|
],
|
|
172
326
|
"slug": "list"
|
|
173
327
|
},
|
|
174
328
|
{
|
|
175
329
|
"name": "reset",
|
|
176
|
-
"signature": "(options?:
|
|
330
|
+
"signature": "(options?: ResetOptions | undefined) => Promise<void>",
|
|
177
331
|
"parameters": [
|
|
178
332
|
{
|
|
179
333
|
"name": "options",
|
|
180
334
|
"docs": "",
|
|
181
|
-
"type": "
|
|
335
|
+
"type": "ResetOptions | undefined"
|
|
182
336
|
}
|
|
183
337
|
],
|
|
184
338
|
"returns": "Promise<void>",
|
|
185
339
|
"tags": [
|
|
186
340
|
{
|
|
187
|
-
"name": "
|
|
188
|
-
"text": "
|
|
341
|
+
"name": "param",
|
|
342
|
+
"text": "options"
|
|
189
343
|
},
|
|
190
344
|
{
|
|
191
|
-
"name": "
|
|
192
|
-
"text": "toLastSuccessful
|
|
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": "
|
|
354
|
+
"text": "{Error} If the reset operation fails."
|
|
197
355
|
}
|
|
198
356
|
],
|
|
199
|
-
"docs": "
|
|
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<
|
|
365
|
+
"signature": "() => Promise<CurrentBundleResult>",
|
|
206
366
|
"parameters": [],
|
|
207
|
-
"returns": "Promise<
|
|
367
|
+
"returns": "Promise<CurrentBundleResult>",
|
|
208
368
|
"tags": [
|
|
209
369
|
{
|
|
210
370
|
"name": "returns",
|
|
211
|
-
"text": "
|
|
371
|
+
"text": "A promise with the current bundle and native version info."
|
|
212
372
|
},
|
|
213
373
|
{
|
|
214
374
|
"name": "throws",
|
|
215
|
-
"text": "
|
|
375
|
+
"text": "{Error} If the operation fails."
|
|
216
376
|
}
|
|
217
377
|
],
|
|
218
|
-
"docs": "Get the
|
|
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
|
-
"
|
|
380
|
+
"CurrentBundleResult"
|
|
221
381
|
],
|
|
222
382
|
"slug": "current"
|
|
223
383
|
},
|
|
@@ -229,61 +389,61 @@
|
|
|
229
389
|
"tags": [
|
|
230
390
|
{
|
|
231
391
|
"name": "returns",
|
|
232
|
-
"text": "
|
|
392
|
+
"text": "A promise that may never resolve because the app will be reloaded."
|
|
233
393
|
},
|
|
234
394
|
{
|
|
235
395
|
"name": "throws",
|
|
236
|
-
"text": "
|
|
396
|
+
"text": "{Error} If the reload operation fails."
|
|
237
397
|
}
|
|
238
398
|
],
|
|
239
|
-
"docs": "
|
|
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:
|
|
405
|
+
"signature": "(options: MultiDelayConditions) => Promise<void>",
|
|
246
406
|
"parameters": [
|
|
247
407
|
{
|
|
248
408
|
"name": "options",
|
|
249
|
-
"docs": "
|
|
250
|
-
"type": "
|
|
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": "
|
|
257
|
-
"text": "
|
|
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": "
|
|
261
|
-
"text": "
|
|
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({
|
|
425
|
+
"text": "// Default behavior: update on next background\nawait CapacitorUpdater.setMultiDelay({\n delayConditions: [{ kind: 'background' }]\n});"
|
|
266
426
|
},
|
|
267
427
|
{
|
|
268
|
-
"name": "
|
|
269
|
-
"text": "
|
|
428
|
+
"name": "param",
|
|
429
|
+
"text": "options Contains the {@link MultiDelayConditions} array of conditions."
|
|
270
430
|
},
|
|
271
431
|
{
|
|
272
|
-
"name": "
|
|
273
|
-
"text": "
|
|
432
|
+
"name": "returns",
|
|
433
|
+
"text": "Resolves when the delay conditions are set."
|
|
274
434
|
},
|
|
275
435
|
{
|
|
276
436
|
"name": "throws",
|
|
277
|
-
"text": "
|
|
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": "
|
|
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
|
-
"
|
|
446
|
+
"MultiDelayConditions"
|
|
287
447
|
],
|
|
288
448
|
"slug": "setmultidelay"
|
|
289
449
|
},
|
|
@@ -295,203 +455,381 @@
|
|
|
295
455
|
"tags": [
|
|
296
456
|
{
|
|
297
457
|
"name": "returns",
|
|
298
|
-
"text": "
|
|
458
|
+
"text": "Resolves when the delay conditions are cleared."
|
|
299
459
|
},
|
|
300
460
|
{
|
|
301
461
|
"name": "throws",
|
|
302
|
-
"text": "
|
|
462
|
+
"text": "{Error} If the operation fails."
|
|
303
463
|
},
|
|
304
464
|
{
|
|
305
465
|
"name": "since",
|
|
306
466
|
"text": "4.0.0"
|
|
307
467
|
}
|
|
308
468
|
],
|
|
309
|
-
"docs": "Cancel delay to
|
|
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",
|
|
310
470
|
"complexTypes": [],
|
|
311
471
|
"slug": "canceldelay"
|
|
312
472
|
},
|
|
313
473
|
{
|
|
314
474
|
"name": "getLatest",
|
|
315
|
-
"signature": "() => Promise<
|
|
316
|
-
"parameters": [
|
|
317
|
-
|
|
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>",
|
|
318
484
|
"tags": [
|
|
485
|
+
{
|
|
486
|
+
"name": "param",
|
|
487
|
+
"text": "options Optional {@link GetLatestOptions} to specify which channel to check."
|
|
488
|
+
},
|
|
319
489
|
{
|
|
320
490
|
"name": "returns",
|
|
321
|
-
"text": "
|
|
491
|
+
"text": "Information about the latest available bundle version."
|
|
322
492
|
},
|
|
323
493
|
{
|
|
324
494
|
"name": "throws",
|
|
325
|
-
"text": "
|
|
495
|
+
"text": "{Error} Always throws when no new version is available (`error: \"no_new_version_available\"`), or when the request fails."
|
|
326
496
|
},
|
|
327
497
|
{
|
|
328
498
|
"name": "since",
|
|
329
499
|
"text": "4.0.0"
|
|
330
500
|
}
|
|
331
501
|
],
|
|
332
|
-
"docs": "
|
|
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 partial 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)",
|
|
333
503
|
"complexTypes": [
|
|
334
|
-
"
|
|
504
|
+
"LatestVersion",
|
|
505
|
+
"GetLatestOptions"
|
|
335
506
|
],
|
|
336
507
|
"slug": "getlatest"
|
|
337
508
|
},
|
|
338
509
|
{
|
|
339
510
|
"name": "setChannel",
|
|
340
|
-
"signature": "(options: SetChannelOptions) => Promise<
|
|
511
|
+
"signature": "(options: SetChannelOptions) => Promise<ChannelRes>",
|
|
341
512
|
"parameters": [
|
|
342
513
|
{
|
|
343
514
|
"name": "options",
|
|
344
|
-
"docs": "
|
|
515
|
+
"docs": "The {@link SetChannelOptions} containing the channel name and optional auto-update trigger.",
|
|
345
516
|
"type": "SetChannelOptions"
|
|
346
517
|
}
|
|
347
518
|
],
|
|
348
|
-
"returns": "Promise<
|
|
519
|
+
"returns": "Promise<ChannelRes>",
|
|
349
520
|
"tags": [
|
|
350
521
|
{
|
|
351
|
-
"name": "
|
|
352
|
-
"text": "
|
|
522
|
+
"name": "param",
|
|
523
|
+
"text": "options The {@link SetChannelOptions} containing the channel name and optional auto-update trigger."
|
|
353
524
|
},
|
|
354
525
|
{
|
|
355
|
-
"name": "
|
|
356
|
-
"text": "
|
|
526
|
+
"name": "returns",
|
|
527
|
+
"text": "Channel operation result with status and optional error/message."
|
|
357
528
|
},
|
|
358
529
|
{
|
|
359
530
|
"name": "throws",
|
|
360
|
-
"text": "
|
|
531
|
+
"text": "{Error} If the channel doesn't exist or doesn't allow self-assignment."
|
|
361
532
|
},
|
|
362
533
|
{
|
|
363
534
|
"name": "since",
|
|
364
535
|
"text": "4.7.0"
|
|
365
536
|
}
|
|
366
537
|
],
|
|
367
|
-
"docs": "
|
|
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.",
|
|
368
539
|
"complexTypes": [
|
|
369
|
-
"
|
|
540
|
+
"ChannelRes",
|
|
370
541
|
"SetChannelOptions"
|
|
371
542
|
],
|
|
372
543
|
"slug": "setchannel"
|
|
373
544
|
},
|
|
545
|
+
{
|
|
546
|
+
"name": "unsetChannel",
|
|
547
|
+
"signature": "(options: UnsetChannelOptions) => Promise<void>",
|
|
548
|
+
"parameters": [
|
|
549
|
+
{
|
|
550
|
+
"name": "options",
|
|
551
|
+
"docs": "",
|
|
552
|
+
"type": "UnsetChannelOptions"
|
|
553
|
+
}
|
|
554
|
+
],
|
|
555
|
+
"returns": "Promise<void>",
|
|
556
|
+
"tags": [
|
|
557
|
+
{
|
|
558
|
+
"name": "param",
|
|
559
|
+
"text": "options"
|
|
560
|
+
},
|
|
561
|
+
{
|
|
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."
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"name": "throws",
|
|
571
|
+
"text": "{Error} If the operation fails."
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"name": "since",
|
|
575
|
+
"text": "4.7.0"
|
|
576
|
+
}
|
|
577
|
+
],
|
|
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",
|
|
579
|
+
"complexTypes": [
|
|
580
|
+
"UnsetChannelOptions"
|
|
581
|
+
],
|
|
582
|
+
"slug": "unsetchannel"
|
|
583
|
+
},
|
|
374
584
|
{
|
|
375
585
|
"name": "getChannel",
|
|
376
|
-
"signature": "() => Promise<
|
|
586
|
+
"signature": "() => Promise<GetChannelRes>",
|
|
377
587
|
"parameters": [],
|
|
378
|
-
"returns": "Promise<
|
|
588
|
+
"returns": "Promise<GetChannelRes>",
|
|
379
589
|
"tags": [
|
|
380
590
|
{
|
|
381
591
|
"name": "returns",
|
|
382
|
-
"text": "
|
|
592
|
+
"text": "The current channel information."
|
|
383
593
|
},
|
|
384
594
|
{
|
|
385
595
|
"name": "throws",
|
|
386
|
-
"text": "
|
|
596
|
+
"text": "{Error} If the operation fails."
|
|
387
597
|
},
|
|
388
598
|
{
|
|
389
599
|
"name": "since",
|
|
390
600
|
"text": "4.8.0"
|
|
391
601
|
}
|
|
392
602
|
],
|
|
393
|
-
"docs": "
|
|
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}",
|
|
394
604
|
"complexTypes": [
|
|
395
|
-
"
|
|
605
|
+
"GetChannelRes"
|
|
396
606
|
],
|
|
397
607
|
"slug": "getchannel"
|
|
398
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
|
+
},
|
|
399
634
|
{
|
|
400
635
|
"name": "setCustomId",
|
|
401
636
|
"signature": "(options: SetCustomIdOptions) => Promise<void>",
|
|
402
637
|
"parameters": [
|
|
403
638
|
{
|
|
404
639
|
"name": "options",
|
|
405
|
-
"docs": "
|
|
640
|
+
"docs": "The {@link SetCustomIdOptions} containing the custom identifier string.",
|
|
406
641
|
"type": "SetCustomIdOptions"
|
|
407
642
|
}
|
|
408
643
|
],
|
|
409
644
|
"returns": "Promise<void>",
|
|
410
645
|
"tags": [
|
|
411
646
|
{
|
|
412
|
-
"name": "
|
|
413
|
-
"text": "
|
|
647
|
+
"name": "param",
|
|
648
|
+
"text": "options The {@link SetCustomIdOptions} containing the custom identifier string."
|
|
414
649
|
},
|
|
415
650
|
{
|
|
416
|
-
"name": "
|
|
417
|
-
"text": "
|
|
651
|
+
"name": "returns",
|
|
652
|
+
"text": "Resolves immediately (synchronous operation)."
|
|
418
653
|
},
|
|
419
654
|
{
|
|
420
655
|
"name": "throws",
|
|
421
|
-
"text": "
|
|
656
|
+
"text": "{Error} If the operation fails."
|
|
422
657
|
},
|
|
423
658
|
{
|
|
424
659
|
"name": "since",
|
|
425
660
|
"text": "4.9.0"
|
|
426
661
|
}
|
|
427
662
|
],
|
|
428
|
-
"docs": "Set
|
|
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",
|
|
429
664
|
"complexTypes": [
|
|
430
665
|
"SetCustomIdOptions"
|
|
431
666
|
],
|
|
432
667
|
"slug": "setcustomid"
|
|
433
668
|
},
|
|
434
669
|
{
|
|
435
|
-
"name": "
|
|
436
|
-
"signature": "(
|
|
437
|
-
"parameters": [
|
|
670
|
+
"name": "getBuiltinVersion",
|
|
671
|
+
"signature": "() => Promise<BuiltinVersion>",
|
|
672
|
+
"parameters": [],
|
|
673
|
+
"returns": "Promise<BuiltinVersion>",
|
|
674
|
+
"tags": [
|
|
438
675
|
{
|
|
439
|
-
"name": "
|
|
440
|
-
"
|
|
441
|
-
"type": "'download'"
|
|
676
|
+
"name": "returns",
|
|
677
|
+
"text": "The builtin bundle version string."
|
|
442
678
|
},
|
|
443
|
-
{
|
|
444
|
-
"name": "listenerFunc",
|
|
445
|
-
"docs": "",
|
|
446
|
-
"type": "DownloadChangeListener"
|
|
447
|
-
}
|
|
448
|
-
],
|
|
449
|
-
"returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
450
|
-
"tags": [
|
|
451
679
|
{
|
|
452
680
|
"name": "since",
|
|
453
|
-
"text": "2.0
|
|
681
|
+
"text": "5.2.0"
|
|
454
682
|
}
|
|
455
683
|
],
|
|
456
|
-
"docs": "
|
|
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",
|
|
457
685
|
"complexTypes": [
|
|
458
|
-
"
|
|
459
|
-
"DownloadChangeListener"
|
|
686
|
+
"BuiltinVersion"
|
|
460
687
|
],
|
|
461
|
-
"slug": "
|
|
688
|
+
"slug": "getbuiltinversion"
|
|
462
689
|
},
|
|
463
690
|
{
|
|
464
|
-
"name": "
|
|
465
|
-
"signature": "(
|
|
466
|
-
"parameters": [
|
|
691
|
+
"name": "getDeviceId",
|
|
692
|
+
"signature": "() => Promise<DeviceId>",
|
|
693
|
+
"parameters": [],
|
|
694
|
+
"returns": "Promise<DeviceId>",
|
|
695
|
+
"tags": [
|
|
467
696
|
{
|
|
468
|
-
"name": "
|
|
469
|
-
"
|
|
470
|
-
"type": "'noNeedUpdate'"
|
|
697
|
+
"name": "returns",
|
|
698
|
+
"text": "The unique device identifier string."
|
|
471
699
|
},
|
|
472
700
|
{
|
|
473
|
-
"name": "
|
|
474
|
-
"
|
|
475
|
-
"type": "NoNeedListener"
|
|
701
|
+
"name": "throws",
|
|
702
|
+
"text": "{Error} If the operation fails."
|
|
476
703
|
}
|
|
477
704
|
],
|
|
478
|
-
"
|
|
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>",
|
|
479
716
|
"tags": [
|
|
480
717
|
{
|
|
481
|
-
"name": "
|
|
482
|
-
"text": "
|
|
718
|
+
"name": "returns",
|
|
719
|
+
"text": "The Capacitor Updater plugin version string."
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"name": "throws",
|
|
723
|
+
"text": "{Error} If the operation fails."
|
|
483
724
|
}
|
|
484
725
|
],
|
|
485
|
-
"docs": "
|
|
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",
|
|
486
727
|
"complexTypes": [
|
|
487
|
-
"
|
|
488
|
-
"NoNeedListener"
|
|
728
|
+
"PluginVersion"
|
|
489
729
|
],
|
|
490
|
-
"slug": "
|
|
730
|
+
"slug": "getpluginversion"
|
|
491
731
|
},
|
|
492
732
|
{
|
|
493
|
-
"name": "
|
|
494
|
-
"signature": "(
|
|
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",
|
|
807
|
+
"docs": "",
|
|
808
|
+
"type": "'noNeedUpdate'"
|
|
809
|
+
},
|
|
810
|
+
{
|
|
811
|
+
"name": "listenerFunc",
|
|
812
|
+
"docs": "",
|
|
813
|
+
"type": "(state: NoNeedEvent) => void"
|
|
814
|
+
}
|
|
815
|
+
],
|
|
816
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
817
|
+
"tags": [
|
|
818
|
+
{
|
|
819
|
+
"name": "since",
|
|
820
|
+
"text": "4.0.0"
|
|
821
|
+
}
|
|
822
|
+
],
|
|
823
|
+
"docs": "Listen for no need to update event, useful when you want force check every time the app is launched",
|
|
824
|
+
"complexTypes": [
|
|
825
|
+
"PluginListenerHandle",
|
|
826
|
+
"NoNeedEvent"
|
|
827
|
+
],
|
|
828
|
+
"slug": "addlistenernoneedupdate-"
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"name": "addListener",
|
|
832
|
+
"signature": "(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>",
|
|
495
833
|
"parameters": [
|
|
496
834
|
{
|
|
497
835
|
"name": "eventName",
|
|
@@ -501,26 +839,26 @@
|
|
|
501
839
|
{
|
|
502
840
|
"name": "listenerFunc",
|
|
503
841
|
"docs": "",
|
|
504
|
-
"type": "
|
|
842
|
+
"type": "(state: UpdateAvailableEvent) => void"
|
|
505
843
|
}
|
|
506
844
|
],
|
|
507
|
-
"returns": "Promise<PluginListenerHandle>
|
|
845
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
508
846
|
"tags": [
|
|
509
847
|
{
|
|
510
848
|
"name": "since",
|
|
511
849
|
"text": "4.0.0"
|
|
512
850
|
}
|
|
513
851
|
],
|
|
514
|
-
"docs": "Listen for
|
|
852
|
+
"docs": "Listen for available update event, useful when you want to force check every time the app is launched",
|
|
515
853
|
"complexTypes": [
|
|
516
854
|
"PluginListenerHandle",
|
|
517
|
-
"
|
|
855
|
+
"UpdateAvailableEvent"
|
|
518
856
|
],
|
|
519
|
-
"slug": "addlistenerupdateavailable"
|
|
857
|
+
"slug": "addlistenerupdateavailable-"
|
|
520
858
|
},
|
|
521
859
|
{
|
|
522
860
|
"name": "addListener",
|
|
523
|
-
"signature": "(eventName:
|
|
861
|
+
"signature": "(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>",
|
|
524
862
|
"parameters": [
|
|
525
863
|
{
|
|
526
864
|
"name": "eventName",
|
|
@@ -530,26 +868,55 @@
|
|
|
530
868
|
{
|
|
531
869
|
"name": "listenerFunc",
|
|
532
870
|
"docs": "",
|
|
533
|
-
"type": "
|
|
871
|
+
"type": "(state: DownloadCompleteEvent) => void"
|
|
534
872
|
}
|
|
535
873
|
],
|
|
536
|
-
"returns": "Promise<PluginListenerHandle>
|
|
874
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
537
875
|
"tags": [
|
|
538
876
|
{
|
|
539
877
|
"name": "since",
|
|
540
878
|
"text": "4.0.0"
|
|
541
879
|
}
|
|
542
880
|
],
|
|
543
|
-
"docs": "Listen for
|
|
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.",
|
|
544
911
|
"complexTypes": [
|
|
545
912
|
"PluginListenerHandle",
|
|
546
|
-
"
|
|
913
|
+
"BreakingAvailableEvent"
|
|
547
914
|
],
|
|
548
|
-
"slug": "
|
|
915
|
+
"slug": "addlistenerbreakingavailable-"
|
|
549
916
|
},
|
|
550
917
|
{
|
|
551
918
|
"name": "addListener",
|
|
552
|
-
"signature": "(eventName:
|
|
919
|
+
"signature": "(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>",
|
|
553
920
|
"parameters": [
|
|
554
921
|
{
|
|
555
922
|
"name": "eventName",
|
|
@@ -559,11 +926,15 @@
|
|
|
559
926
|
{
|
|
560
927
|
"name": "listenerFunc",
|
|
561
928
|
"docs": "",
|
|
562
|
-
"type": "
|
|
929
|
+
"type": "(state: MajorAvailableEvent) => void"
|
|
563
930
|
}
|
|
564
931
|
],
|
|
565
|
-
"returns": "Promise<PluginListenerHandle>
|
|
932
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
566
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
|
+
},
|
|
567
938
|
{
|
|
568
939
|
"name": "since",
|
|
569
940
|
"text": "2.3.0"
|
|
@@ -572,13 +943,13 @@
|
|
|
572
943
|
"docs": "Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking",
|
|
573
944
|
"complexTypes": [
|
|
574
945
|
"PluginListenerHandle",
|
|
575
|
-
"
|
|
946
|
+
"MajorAvailableEvent"
|
|
576
947
|
],
|
|
577
|
-
"slug": "addlistenermajoravailable"
|
|
948
|
+
"slug": "addlistenermajoravailable-"
|
|
578
949
|
},
|
|
579
950
|
{
|
|
580
951
|
"name": "addListener",
|
|
581
|
-
"signature": "(eventName:
|
|
952
|
+
"signature": "(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>",
|
|
582
953
|
"parameters": [
|
|
583
954
|
{
|
|
584
955
|
"name": "eventName",
|
|
@@ -588,10 +959,10 @@
|
|
|
588
959
|
{
|
|
589
960
|
"name": "listenerFunc",
|
|
590
961
|
"docs": "",
|
|
591
|
-
"type": "
|
|
962
|
+
"type": "(state: UpdateFailedEvent) => void"
|
|
592
963
|
}
|
|
593
964
|
],
|
|
594
|
-
"returns": "Promise<PluginListenerHandle>
|
|
965
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
595
966
|
"tags": [
|
|
596
967
|
{
|
|
597
968
|
"name": "since",
|
|
@@ -601,13 +972,13 @@
|
|
|
601
972
|
"docs": "Listen for update fail event in the App, let you know when update has fail to install at next app start",
|
|
602
973
|
"complexTypes": [
|
|
603
974
|
"PluginListenerHandle",
|
|
604
|
-
"
|
|
975
|
+
"UpdateFailedEvent"
|
|
605
976
|
],
|
|
606
|
-
"slug": "addlistenerupdatefailed"
|
|
977
|
+
"slug": "addlistenerupdatefailed-"
|
|
607
978
|
},
|
|
608
979
|
{
|
|
609
980
|
"name": "addListener",
|
|
610
|
-
"signature": "(eventName:
|
|
981
|
+
"signature": "(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>",
|
|
611
982
|
"parameters": [
|
|
612
983
|
{
|
|
613
984
|
"name": "eventName",
|
|
@@ -617,26 +988,26 @@
|
|
|
617
988
|
{
|
|
618
989
|
"name": "listenerFunc",
|
|
619
990
|
"docs": "",
|
|
620
|
-
"type": "
|
|
991
|
+
"type": "(state: DownloadFailedEvent) => void"
|
|
621
992
|
}
|
|
622
993
|
],
|
|
623
|
-
"returns": "Promise<PluginListenerHandle>
|
|
994
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
624
995
|
"tags": [
|
|
625
996
|
{
|
|
626
997
|
"name": "since",
|
|
627
998
|
"text": "4.0.0"
|
|
628
999
|
}
|
|
629
1000
|
],
|
|
630
|
-
"docs": "Listen for download fail event in the App, let you know when download has
|
|
1001
|
+
"docs": "Listen for download fail event in the App, let you know when a bundle download has failed",
|
|
631
1002
|
"complexTypes": [
|
|
632
1003
|
"PluginListenerHandle",
|
|
633
|
-
"
|
|
1004
|
+
"DownloadFailedEvent"
|
|
634
1005
|
],
|
|
635
|
-
"slug": "addlistenerdownloadfailed"
|
|
1006
|
+
"slug": "addlistenerdownloadfailed-"
|
|
636
1007
|
},
|
|
637
1008
|
{
|
|
638
1009
|
"name": "addListener",
|
|
639
|
-
"signature": "(eventName:
|
|
1010
|
+
"signature": "(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>",
|
|
640
1011
|
"parameters": [
|
|
641
1012
|
{
|
|
642
1013
|
"name": "eventName",
|
|
@@ -646,115 +1017,317 @@
|
|
|
646
1017
|
{
|
|
647
1018
|
"name": "listenerFunc",
|
|
648
1019
|
"docs": "",
|
|
649
|
-
"type": "
|
|
1020
|
+
"type": "() => void"
|
|
650
1021
|
}
|
|
651
1022
|
],
|
|
652
|
-
"returns": "Promise<PluginListenerHandle>
|
|
1023
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
653
1024
|
"tags": [
|
|
654
1025
|
{
|
|
655
1026
|
"name": "since",
|
|
656
1027
|
"text": "4.3.0"
|
|
657
1028
|
}
|
|
658
1029
|
],
|
|
659
|
-
"docs": "Listen for
|
|
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.",
|
|
660
1059
|
"complexTypes": [
|
|
661
1060
|
"PluginListenerHandle",
|
|
662
|
-
"
|
|
1061
|
+
"AppReadyEvent"
|
|
663
1062
|
],
|
|
664
|
-
"slug": "
|
|
1063
|
+
"slug": "addlistenerappready-"
|
|
665
1064
|
},
|
|
666
1065
|
{
|
|
667
|
-
"name": "
|
|
668
|
-
"signature": "() => Promise<
|
|
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": "isAutoUpdateAvailable",
|
|
1096
|
+
"signature": "() => Promise<AutoUpdateAvailable>",
|
|
669
1097
|
"parameters": [],
|
|
670
|
-
"returns": "Promise<
|
|
1098
|
+
"returns": "Promise<AutoUpdateAvailable>",
|
|
671
1099
|
"tags": [
|
|
672
1100
|
{
|
|
673
1101
|
"name": "returns",
|
|
674
|
-
"text": "
|
|
1102
|
+
"text": "`false` when custom updateUrl is set, `true` otherwise."
|
|
675
1103
|
},
|
|
676
1104
|
{
|
|
677
1105
|
"name": "throws",
|
|
678
|
-
"text": "
|
|
1106
|
+
"text": "{Error} If the operation fails."
|
|
679
1107
|
}
|
|
680
1108
|
],
|
|
681
|
-
"docs": "
|
|
682
|
-
"complexTypes": [
|
|
683
|
-
|
|
1109
|
+
"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",
|
|
1110
|
+
"complexTypes": [
|
|
1111
|
+
"AutoUpdateAvailable"
|
|
1112
|
+
],
|
|
1113
|
+
"slug": "isautoupdateavailable"
|
|
684
1114
|
},
|
|
685
1115
|
{
|
|
686
|
-
"name": "
|
|
687
|
-
"signature": "() => Promise<
|
|
1116
|
+
"name": "getNextBundle",
|
|
1117
|
+
"signature": "() => Promise<BundleInfo | null>",
|
|
688
1118
|
"parameters": [],
|
|
689
|
-
"returns": "Promise<
|
|
1119
|
+
"returns": "Promise<BundleInfo | null>",
|
|
690
1120
|
"tags": [
|
|
691
1121
|
{
|
|
692
1122
|
"name": "returns",
|
|
693
|
-
"text": "
|
|
1123
|
+
"text": "The pending bundle info, or `null` if none is queued."
|
|
694
1124
|
},
|
|
695
1125
|
{
|
|
696
1126
|
"name": "throws",
|
|
697
|
-
"text": "
|
|
1127
|
+
"text": "{Error} If the operation fails."
|
|
1128
|
+
},
|
|
1129
|
+
{
|
|
1130
|
+
"name": "since",
|
|
1131
|
+
"text": "6.8.0"
|
|
698
1132
|
}
|
|
699
1133
|
],
|
|
700
|
-
"docs": "Get the
|
|
701
|
-
"complexTypes": [
|
|
702
|
-
|
|
1134
|
+
"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",
|
|
1135
|
+
"complexTypes": [
|
|
1136
|
+
"BundleInfo"
|
|
1137
|
+
],
|
|
1138
|
+
"slug": "getnextbundle"
|
|
703
1139
|
},
|
|
704
1140
|
{
|
|
705
|
-
"name": "
|
|
706
|
-
"signature": "() => Promise<
|
|
1141
|
+
"name": "getFailedUpdate",
|
|
1142
|
+
"signature": "() => Promise<UpdateFailedEvent | null>",
|
|
707
1143
|
"parameters": [],
|
|
708
|
-
"returns": "Promise<
|
|
1144
|
+
"returns": "Promise<UpdateFailedEvent | null>",
|
|
709
1145
|
"tags": [
|
|
710
1146
|
{
|
|
711
1147
|
"name": "returns",
|
|
712
|
-
"text": "The
|
|
1148
|
+
"text": "The failed update info (cleared after first retrieval), or `null`."
|
|
713
1149
|
},
|
|
714
1150
|
{
|
|
715
1151
|
"name": "throws",
|
|
716
|
-
"text": "
|
|
1152
|
+
"text": "{Error} If the operation fails."
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "since",
|
|
1156
|
+
"text": "7.22.0"
|
|
717
1157
|
}
|
|
718
1158
|
],
|
|
719
|
-
"docs": "
|
|
720
|
-
"complexTypes": [
|
|
721
|
-
|
|
1159
|
+
"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",
|
|
1160
|
+
"complexTypes": [
|
|
1161
|
+
"UpdateFailedEvent"
|
|
1162
|
+
],
|
|
1163
|
+
"slug": "getfailedupdate"
|
|
722
1164
|
},
|
|
723
1165
|
{
|
|
724
|
-
"name": "
|
|
725
|
-
"signature": "() => Promise<void>",
|
|
1166
|
+
"name": "setShakeMenu",
|
|
1167
|
+
"signature": "(options: SetShakeMenuOptions) => Promise<void>",
|
|
1168
|
+
"parameters": [
|
|
1169
|
+
{
|
|
1170
|
+
"name": "options",
|
|
1171
|
+
"docs": "",
|
|
1172
|
+
"type": "SetShakeMenuOptions"
|
|
1173
|
+
}
|
|
1174
|
+
],
|
|
1175
|
+
"returns": "Promise<void>",
|
|
1176
|
+
"tags": [
|
|
1177
|
+
{
|
|
1178
|
+
"name": "param",
|
|
1179
|
+
"text": "options"
|
|
1180
|
+
},
|
|
1181
|
+
{
|
|
1182
|
+
"name": "link",
|
|
1183
|
+
"text": "SetShakeMenuOptions} with `enabled: true` to enable or `enabled: false` to disable."
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"name": "returns",
|
|
1187
|
+
"text": "Resolves when the setting is applied."
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
"name": "throws",
|
|
1191
|
+
"text": "{Error} If the operation fails."
|
|
1192
|
+
},
|
|
1193
|
+
{
|
|
1194
|
+
"name": "since",
|
|
1195
|
+
"text": "7.5.0"
|
|
1196
|
+
}
|
|
1197
|
+
],
|
|
1198
|
+
"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}.",
|
|
1199
|
+
"complexTypes": [
|
|
1200
|
+
"SetShakeMenuOptions"
|
|
1201
|
+
],
|
|
1202
|
+
"slug": "setshakemenu"
|
|
1203
|
+
},
|
|
1204
|
+
{
|
|
1205
|
+
"name": "isShakeMenuEnabled",
|
|
1206
|
+
"signature": "() => Promise<ShakeMenuEnabled>",
|
|
1207
|
+
"parameters": [],
|
|
1208
|
+
"returns": "Promise<ShakeMenuEnabled>",
|
|
1209
|
+
"tags": [
|
|
1210
|
+
{
|
|
1211
|
+
"name": "returns",
|
|
1212
|
+
"text": "Object with `enabled: true` or `enabled: false`."
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
"name": "throws",
|
|
1216
|
+
"text": "{Error} If the operation fails."
|
|
1217
|
+
},
|
|
1218
|
+
{
|
|
1219
|
+
"name": "since",
|
|
1220
|
+
"text": "7.5.0"
|
|
1221
|
+
}
|
|
1222
|
+
],
|
|
1223
|
+
"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",
|
|
1224
|
+
"complexTypes": [
|
|
1225
|
+
"ShakeMenuEnabled"
|
|
1226
|
+
],
|
|
1227
|
+
"slug": "isshakemenuenabled"
|
|
1228
|
+
},
|
|
1229
|
+
{
|
|
1230
|
+
"name": "getAppId",
|
|
1231
|
+
"signature": "() => Promise<GetAppIdRes>",
|
|
726
1232
|
"parameters": [],
|
|
1233
|
+
"returns": "Promise<GetAppIdRes>",
|
|
1234
|
+
"tags": [
|
|
1235
|
+
{
|
|
1236
|
+
"name": "returns",
|
|
1237
|
+
"text": "Object containing the current `appId` string."
|
|
1238
|
+
},
|
|
1239
|
+
{
|
|
1240
|
+
"name": "throws",
|
|
1241
|
+
"text": "{Error} If the operation fails."
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"name": "since",
|
|
1245
|
+
"text": "7.14.0"
|
|
1246
|
+
}
|
|
1247
|
+
],
|
|
1248
|
+
"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}",
|
|
1249
|
+
"complexTypes": [
|
|
1250
|
+
"GetAppIdRes"
|
|
1251
|
+
],
|
|
1252
|
+
"slug": "getappid"
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "setAppId",
|
|
1256
|
+
"signature": "(options: SetAppIdOptions) => Promise<void>",
|
|
1257
|
+
"parameters": [
|
|
1258
|
+
{
|
|
1259
|
+
"name": "options",
|
|
1260
|
+
"docs": "",
|
|
1261
|
+
"type": "SetAppIdOptions"
|
|
1262
|
+
}
|
|
1263
|
+
],
|
|
727
1264
|
"returns": "Promise<void>",
|
|
728
1265
|
"tags": [
|
|
1266
|
+
{
|
|
1267
|
+
"name": "param",
|
|
1268
|
+
"text": "options"
|
|
1269
|
+
},
|
|
1270
|
+
{
|
|
1271
|
+
"name": "link",
|
|
1272
|
+
"text": "SetAppIdOptions} containing the new App ID string."
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
"name": "returns",
|
|
1276
|
+
"text": "Resolves when the App ID is successfully changed."
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1279
|
+
"name": "throws",
|
|
1280
|
+
"text": "{Error} If `allowModifyAppId` is false or the operation fails."
|
|
1281
|
+
},
|
|
729
1282
|
{
|
|
730
1283
|
"name": "since",
|
|
731
|
-
"text": "
|
|
1284
|
+
"text": "7.14.0"
|
|
732
1285
|
}
|
|
733
1286
|
],
|
|
734
|
-
"docs": "
|
|
735
|
-
"complexTypes": [
|
|
736
|
-
|
|
1287
|
+
"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",
|
|
1288
|
+
"complexTypes": [
|
|
1289
|
+
"SetAppIdOptions"
|
|
1290
|
+
],
|
|
1291
|
+
"slug": "setappid"
|
|
737
1292
|
}
|
|
738
1293
|
],
|
|
739
1294
|
"properties": []
|
|
740
1295
|
},
|
|
741
1296
|
"interfaces": [
|
|
742
1297
|
{
|
|
743
|
-
"name": "
|
|
744
|
-
"slug": "
|
|
1298
|
+
"name": "AppReadyResult",
|
|
1299
|
+
"slug": "appreadyresult",
|
|
745
1300
|
"docs": "",
|
|
746
1301
|
"tags": [],
|
|
747
1302
|
"methods": [],
|
|
748
1303
|
"properties": [
|
|
749
1304
|
{
|
|
750
|
-
"name": "
|
|
1305
|
+
"name": "bundle",
|
|
751
1306
|
"tags": [],
|
|
752
1307
|
"docs": "",
|
|
753
|
-
"complexTypes": [
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
1308
|
+
"complexTypes": [
|
|
1309
|
+
"BundleInfo"
|
|
1310
|
+
],
|
|
1311
|
+
"type": "BundleInfo"
|
|
1312
|
+
}
|
|
1313
|
+
]
|
|
1314
|
+
},
|
|
1315
|
+
{
|
|
1316
|
+
"name": "BundleInfo",
|
|
1317
|
+
"slug": "bundleinfo",
|
|
1318
|
+
"docs": "",
|
|
1319
|
+
"tags": [],
|
|
1320
|
+
"methods": [],
|
|
1321
|
+
"properties": [
|
|
1322
|
+
{
|
|
1323
|
+
"name": "id",
|
|
1324
|
+
"tags": [],
|
|
1325
|
+
"docs": "",
|
|
1326
|
+
"complexTypes": [],
|
|
1327
|
+
"type": "string"
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"name": "version",
|
|
758
1331
|
"tags": [],
|
|
759
1332
|
"docs": "",
|
|
760
1333
|
"complexTypes": [],
|
|
@@ -786,146 +1359,165 @@
|
|
|
786
1359
|
]
|
|
787
1360
|
},
|
|
788
1361
|
{
|
|
789
|
-
"name": "
|
|
790
|
-
"slug": "
|
|
1362
|
+
"name": "UpdateUrl",
|
|
1363
|
+
"slug": "updateurl",
|
|
791
1364
|
"docs": "",
|
|
792
1365
|
"tags": [],
|
|
793
1366
|
"methods": [],
|
|
794
1367
|
"properties": [
|
|
795
1368
|
{
|
|
796
|
-
"name": "
|
|
797
|
-
"tags": [
|
|
798
|
-
{
|
|
799
|
-
"text": "value is useless for",
|
|
800
|
-
"name": "param"
|
|
801
|
-
},
|
|
802
|
-
{
|
|
803
|
-
"text": "kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"",
|
|
804
|
-
"name": "param"
|
|
805
|
-
}
|
|
806
|
-
],
|
|
807
|
-
"docs": "Set up delay conditions in setMultiDelay",
|
|
808
|
-
"complexTypes": [
|
|
809
|
-
"DelayUntilNext"
|
|
810
|
-
],
|
|
811
|
-
"type": "DelayUntilNext"
|
|
812
|
-
},
|
|
813
|
-
{
|
|
814
|
-
"name": "value",
|
|
1369
|
+
"name": "url",
|
|
815
1370
|
"tags": [],
|
|
816
1371
|
"docs": "",
|
|
817
1372
|
"complexTypes": [],
|
|
818
|
-
"type": "string
|
|
1373
|
+
"type": "string"
|
|
819
1374
|
}
|
|
820
1375
|
]
|
|
821
1376
|
},
|
|
822
1377
|
{
|
|
823
|
-
"name": "
|
|
824
|
-
"slug": "
|
|
1378
|
+
"name": "StatsUrl",
|
|
1379
|
+
"slug": "statsurl",
|
|
825
1380
|
"docs": "",
|
|
826
1381
|
"tags": [],
|
|
827
1382
|
"methods": [],
|
|
828
1383
|
"properties": [
|
|
829
1384
|
{
|
|
830
|
-
"name": "
|
|
831
|
-
"tags": [
|
|
832
|
-
|
|
833
|
-
"text": "4.0.0",
|
|
834
|
-
"name": "since"
|
|
835
|
-
}
|
|
836
|
-
],
|
|
837
|
-
"docs": "Res of getLatest method",
|
|
1385
|
+
"name": "url",
|
|
1386
|
+
"tags": [],
|
|
1387
|
+
"docs": "",
|
|
838
1388
|
"complexTypes": [],
|
|
839
1389
|
"type": "string"
|
|
840
|
-
}
|
|
1390
|
+
}
|
|
1391
|
+
]
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"name": "ChannelUrl",
|
|
1395
|
+
"slug": "channelurl",
|
|
1396
|
+
"docs": "",
|
|
1397
|
+
"tags": [],
|
|
1398
|
+
"methods": [],
|
|
1399
|
+
"properties": [
|
|
841
1400
|
{
|
|
842
|
-
"name": "
|
|
1401
|
+
"name": "url",
|
|
843
1402
|
"tags": [],
|
|
844
1403
|
"docs": "",
|
|
845
1404
|
"complexTypes": [],
|
|
846
|
-
"type": "
|
|
847
|
-
}
|
|
1405
|
+
"type": "string"
|
|
1406
|
+
}
|
|
1407
|
+
]
|
|
1408
|
+
},
|
|
1409
|
+
{
|
|
1410
|
+
"name": "DownloadOptions",
|
|
1411
|
+
"slug": "downloadoptions",
|
|
1412
|
+
"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.",
|
|
1413
|
+
"tags": [],
|
|
1414
|
+
"methods": [],
|
|
1415
|
+
"properties": [
|
|
848
1416
|
{
|
|
849
|
-
"name": "
|
|
1417
|
+
"name": "url",
|
|
850
1418
|
"tags": [],
|
|
851
|
-
"docs": "",
|
|
1419
|
+
"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.)",
|
|
852
1420
|
"complexTypes": [],
|
|
853
|
-
"type": "string
|
|
1421
|
+
"type": "string"
|
|
854
1422
|
},
|
|
855
1423
|
{
|
|
856
|
-
"name": "
|
|
1424
|
+
"name": "version",
|
|
857
1425
|
"tags": [],
|
|
858
|
-
"docs": "",
|
|
1426
|
+
"docs": "The version code/name of this bundle/version",
|
|
859
1427
|
"complexTypes": [],
|
|
860
|
-
"type": "string
|
|
1428
|
+
"type": "string"
|
|
861
1429
|
},
|
|
862
1430
|
{
|
|
863
|
-
"name": "
|
|
864
|
-
"tags": [
|
|
865
|
-
|
|
1431
|
+
"name": "sessionKey",
|
|
1432
|
+
"tags": [
|
|
1433
|
+
{
|
|
1434
|
+
"text": "4.0.0",
|
|
1435
|
+
"name": "since"
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
"text": "undefined",
|
|
1439
|
+
"name": "default"
|
|
1440
|
+
}
|
|
1441
|
+
],
|
|
1442
|
+
"docs": "The session key for the update, when the bundle is encrypted with a session key",
|
|
866
1443
|
"complexTypes": [],
|
|
867
1444
|
"type": "string | undefined"
|
|
868
1445
|
},
|
|
869
1446
|
{
|
|
870
|
-
"name": "
|
|
871
|
-
"tags": [
|
|
872
|
-
|
|
1447
|
+
"name": "checksum",
|
|
1448
|
+
"tags": [
|
|
1449
|
+
{
|
|
1450
|
+
"text": "4.0.0",
|
|
1451
|
+
"name": "since"
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"text": "undefined",
|
|
1455
|
+
"name": "default"
|
|
1456
|
+
}
|
|
1457
|
+
],
|
|
1458
|
+
"docs": "The checksum for the update, it should be in sha256 and encrypted with private key if the bundle is encrypted",
|
|
873
1459
|
"complexTypes": [],
|
|
874
1460
|
"type": "string | undefined"
|
|
875
1461
|
},
|
|
876
1462
|
{
|
|
877
|
-
"name": "
|
|
878
|
-
"tags": [
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
1463
|
+
"name": "manifest",
|
|
1464
|
+
"tags": [
|
|
1465
|
+
{
|
|
1466
|
+
"text": "6.1.0",
|
|
1467
|
+
"name": "since"
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
"text": "undefined",
|
|
1471
|
+
"name": "default"
|
|
1472
|
+
}
|
|
1473
|
+
],
|
|
1474
|
+
"docs": "The manifest for multi-file downloads",
|
|
1475
|
+
"complexTypes": [
|
|
1476
|
+
"ManifestEntry"
|
|
1477
|
+
],
|
|
1478
|
+
"type": "ManifestEntry[] | undefined"
|
|
882
1479
|
}
|
|
883
1480
|
]
|
|
884
1481
|
},
|
|
885
1482
|
{
|
|
886
|
-
"name": "
|
|
887
|
-
"slug": "
|
|
1483
|
+
"name": "ManifestEntry",
|
|
1484
|
+
"slug": "manifestentry",
|
|
888
1485
|
"docs": "",
|
|
889
1486
|
"tags": [],
|
|
890
1487
|
"methods": [],
|
|
891
1488
|
"properties": [
|
|
892
1489
|
{
|
|
893
|
-
"name": "
|
|
894
|
-
"tags": [
|
|
895
|
-
|
|
896
|
-
"text": "4.7.0",
|
|
897
|
-
"name": "since"
|
|
898
|
-
}
|
|
899
|
-
],
|
|
900
|
-
"docs": "Current status of set channel",
|
|
1490
|
+
"name": "file_name",
|
|
1491
|
+
"tags": [],
|
|
1492
|
+
"docs": "",
|
|
901
1493
|
"complexTypes": [],
|
|
902
|
-
"type": "string"
|
|
1494
|
+
"type": "string | null"
|
|
903
1495
|
},
|
|
904
1496
|
{
|
|
905
|
-
"name": "
|
|
1497
|
+
"name": "file_hash",
|
|
906
1498
|
"tags": [],
|
|
907
1499
|
"docs": "",
|
|
908
1500
|
"complexTypes": [],
|
|
909
|
-
"type": "
|
|
1501
|
+
"type": "string | null"
|
|
910
1502
|
},
|
|
911
1503
|
{
|
|
912
|
-
"name": "
|
|
1504
|
+
"name": "download_url",
|
|
913
1505
|
"tags": [],
|
|
914
1506
|
"docs": "",
|
|
915
1507
|
"complexTypes": [],
|
|
916
|
-
"type": "
|
|
1508
|
+
"type": "string | null"
|
|
917
1509
|
}
|
|
918
1510
|
]
|
|
919
1511
|
},
|
|
920
1512
|
{
|
|
921
|
-
"name": "
|
|
922
|
-
"slug": "
|
|
1513
|
+
"name": "BundleId",
|
|
1514
|
+
"slug": "bundleid",
|
|
923
1515
|
"docs": "",
|
|
924
1516
|
"tags": [],
|
|
925
1517
|
"methods": [],
|
|
926
1518
|
"properties": [
|
|
927
1519
|
{
|
|
928
|
-
"name": "
|
|
1520
|
+
"name": "id",
|
|
929
1521
|
"tags": [],
|
|
930
1522
|
"docs": "",
|
|
931
1523
|
"complexTypes": [],
|
|
@@ -934,105 +1526,71 @@
|
|
|
934
1526
|
]
|
|
935
1527
|
},
|
|
936
1528
|
{
|
|
937
|
-
"name": "
|
|
938
|
-
"slug": "
|
|
1529
|
+
"name": "BundleListResult",
|
|
1530
|
+
"slug": "bundlelistresult",
|
|
939
1531
|
"docs": "",
|
|
940
1532
|
"tags": [],
|
|
941
1533
|
"methods": [],
|
|
942
1534
|
"properties": [
|
|
943
1535
|
{
|
|
944
|
-
"name": "
|
|
945
|
-
"tags": [
|
|
946
|
-
{
|
|
947
|
-
"text": "4.8.0",
|
|
948
|
-
"name": "since"
|
|
949
|
-
}
|
|
950
|
-
],
|
|
951
|
-
"docs": "Current status of get channel",
|
|
952
|
-
"complexTypes": [],
|
|
953
|
-
"type": "string | undefined"
|
|
954
|
-
},
|
|
955
|
-
{
|
|
956
|
-
"name": "error",
|
|
957
|
-
"tags": [],
|
|
958
|
-
"docs": "",
|
|
959
|
-
"complexTypes": [],
|
|
960
|
-
"type": "any"
|
|
961
|
-
},
|
|
962
|
-
{
|
|
963
|
-
"name": "message",
|
|
964
|
-
"tags": [],
|
|
965
|
-
"docs": "",
|
|
966
|
-
"complexTypes": [],
|
|
967
|
-
"type": "any"
|
|
968
|
-
},
|
|
969
|
-
{
|
|
970
|
-
"name": "status",
|
|
971
|
-
"tags": [],
|
|
972
|
-
"docs": "",
|
|
973
|
-
"complexTypes": [],
|
|
974
|
-
"type": "string | undefined"
|
|
975
|
-
},
|
|
976
|
-
{
|
|
977
|
-
"name": "allowSet",
|
|
1536
|
+
"name": "bundles",
|
|
978
1537
|
"tags": [],
|
|
979
1538
|
"docs": "",
|
|
980
|
-
"complexTypes": [
|
|
981
|
-
|
|
1539
|
+
"complexTypes": [
|
|
1540
|
+
"BundleInfo"
|
|
1541
|
+
],
|
|
1542
|
+
"type": "BundleInfo[]"
|
|
982
1543
|
}
|
|
983
1544
|
]
|
|
984
1545
|
},
|
|
985
1546
|
{
|
|
986
|
-
"name": "
|
|
987
|
-
"slug": "
|
|
1547
|
+
"name": "ListOptions",
|
|
1548
|
+
"slug": "listoptions",
|
|
988
1549
|
"docs": "",
|
|
989
1550
|
"tags": [],
|
|
990
1551
|
"methods": [],
|
|
991
1552
|
"properties": [
|
|
992
1553
|
{
|
|
993
|
-
"name": "
|
|
994
|
-
"tags": [
|
|
995
|
-
|
|
1554
|
+
"name": "raw",
|
|
1555
|
+
"tags": [
|
|
1556
|
+
{
|
|
1557
|
+
"text": "6.14.0",
|
|
1558
|
+
"name": "since"
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
"text": "false",
|
|
1562
|
+
"name": "default"
|
|
1563
|
+
}
|
|
1564
|
+
],
|
|
1565
|
+
"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.",
|
|
996
1566
|
"complexTypes": [],
|
|
997
|
-
"type": "
|
|
1567
|
+
"type": "boolean | undefined"
|
|
998
1568
|
}
|
|
999
1569
|
]
|
|
1000
1570
|
},
|
|
1001
1571
|
{
|
|
1002
|
-
"name": "
|
|
1003
|
-
"slug": "
|
|
1572
|
+
"name": "ResetOptions",
|
|
1573
|
+
"slug": "resetoptions",
|
|
1004
1574
|
"docs": "",
|
|
1005
1575
|
"tags": [],
|
|
1006
1576
|
"methods": [],
|
|
1007
1577
|
"properties": [
|
|
1008
1578
|
{
|
|
1009
|
-
"name": "
|
|
1579
|
+
"name": "toLastSuccessful",
|
|
1010
1580
|
"tags": [],
|
|
1011
1581
|
"docs": "",
|
|
1012
1582
|
"complexTypes": [],
|
|
1013
|
-
"type": "
|
|
1583
|
+
"type": "boolean"
|
|
1014
1584
|
}
|
|
1015
1585
|
]
|
|
1016
1586
|
},
|
|
1017
1587
|
{
|
|
1018
|
-
"name": "
|
|
1019
|
-
"slug": "
|
|
1588
|
+
"name": "CurrentBundleResult",
|
|
1589
|
+
"slug": "currentbundleresult",
|
|
1020
1590
|
"docs": "",
|
|
1021
1591
|
"tags": [],
|
|
1022
1592
|
"methods": [],
|
|
1023
1593
|
"properties": [
|
|
1024
|
-
{
|
|
1025
|
-
"name": "percent",
|
|
1026
|
-
"tags": [
|
|
1027
|
-
{
|
|
1028
|
-
"text": "4.0.0",
|
|
1029
|
-
"name": "since"
|
|
1030
|
-
}
|
|
1031
|
-
],
|
|
1032
|
-
"docs": "Current status of download, between 0 and 100.",
|
|
1033
|
-
"complexTypes": [],
|
|
1034
|
-
"type": "number"
|
|
1035
|
-
},
|
|
1036
1594
|
{
|
|
1037
1595
|
"name": "bundle",
|
|
1038
1596
|
"tags": [],
|
|
@@ -1041,442 +1599,1446 @@
|
|
|
1041
1599
|
"BundleInfo"
|
|
1042
1600
|
],
|
|
1043
1601
|
"type": "BundleInfo"
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "native",
|
|
1605
|
+
"tags": [],
|
|
1606
|
+
"docs": "",
|
|
1607
|
+
"complexTypes": [],
|
|
1608
|
+
"type": "string"
|
|
1044
1609
|
}
|
|
1045
1610
|
]
|
|
1046
1611
|
},
|
|
1047
1612
|
{
|
|
1048
|
-
"name": "
|
|
1049
|
-
"slug": "
|
|
1613
|
+
"name": "MultiDelayConditions",
|
|
1614
|
+
"slug": "multidelayconditions",
|
|
1050
1615
|
"docs": "",
|
|
1051
1616
|
"tags": [],
|
|
1052
1617
|
"methods": [],
|
|
1053
1618
|
"properties": [
|
|
1054
1619
|
{
|
|
1055
|
-
"name": "
|
|
1056
|
-
"tags": [
|
|
1057
|
-
|
|
1058
|
-
"text": "4.0.0",
|
|
1059
|
-
"name": "since"
|
|
1060
|
-
}
|
|
1061
|
-
],
|
|
1062
|
-
"docs": "Current status of download, between 0 and 100.",
|
|
1620
|
+
"name": "delayConditions",
|
|
1621
|
+
"tags": [],
|
|
1622
|
+
"docs": "",
|
|
1063
1623
|
"complexTypes": [
|
|
1064
|
-
"
|
|
1624
|
+
"DelayCondition"
|
|
1065
1625
|
],
|
|
1066
|
-
"type": "
|
|
1626
|
+
"type": "DelayCondition[]"
|
|
1067
1627
|
}
|
|
1068
1628
|
]
|
|
1069
1629
|
},
|
|
1070
1630
|
{
|
|
1071
|
-
"name": "
|
|
1072
|
-
"slug": "
|
|
1631
|
+
"name": "DelayCondition",
|
|
1632
|
+
"slug": "delaycondition",
|
|
1073
1633
|
"docs": "",
|
|
1074
1634
|
"tags": [],
|
|
1075
1635
|
"methods": [],
|
|
1076
1636
|
"properties": [
|
|
1077
1637
|
{
|
|
1078
|
-
"name": "
|
|
1638
|
+
"name": "kind",
|
|
1079
1639
|
"tags": [
|
|
1080
1640
|
{
|
|
1081
|
-
"text": "
|
|
1082
|
-
"name": "
|
|
1641
|
+
"text": "value is useless for",
|
|
1642
|
+
"name": "param"
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
"text": "kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"",
|
|
1646
|
+
"name": "param"
|
|
1083
1647
|
}
|
|
1084
1648
|
],
|
|
1085
|
-
"docs": "
|
|
1649
|
+
"docs": "Set up delay conditions in setMultiDelay",
|
|
1086
1650
|
"complexTypes": [
|
|
1087
|
-
"
|
|
1651
|
+
"DelayUntilNext"
|
|
1088
1652
|
],
|
|
1089
|
-
"type": "
|
|
1653
|
+
"type": "DelayUntilNext"
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
"name": "value",
|
|
1657
|
+
"tags": [],
|
|
1658
|
+
"docs": "",
|
|
1659
|
+
"complexTypes": [],
|
|
1660
|
+
"type": "string | undefined"
|
|
1090
1661
|
}
|
|
1091
1662
|
]
|
|
1092
1663
|
},
|
|
1093
1664
|
{
|
|
1094
|
-
"name": "
|
|
1095
|
-
"slug": "
|
|
1665
|
+
"name": "LatestVersion",
|
|
1666
|
+
"slug": "latestversion",
|
|
1096
1667
|
"docs": "",
|
|
1097
1668
|
"tags": [],
|
|
1098
1669
|
"methods": [],
|
|
1099
1670
|
"properties": [
|
|
1100
1671
|
{
|
|
1101
|
-
"name": "
|
|
1672
|
+
"name": "version",
|
|
1102
1673
|
"tags": [
|
|
1103
1674
|
{
|
|
1104
1675
|
"text": "4.0.0",
|
|
1105
1676
|
"name": "since"
|
|
1106
1677
|
}
|
|
1107
1678
|
],
|
|
1108
|
-
"docs": "
|
|
1679
|
+
"docs": "Result of getLatest method",
|
|
1680
|
+
"complexTypes": [],
|
|
1681
|
+
"type": "string"
|
|
1682
|
+
},
|
|
1683
|
+
{
|
|
1684
|
+
"name": "checksum",
|
|
1685
|
+
"tags": [
|
|
1686
|
+
{
|
|
1687
|
+
"text": "6",
|
|
1688
|
+
"name": "since"
|
|
1689
|
+
}
|
|
1690
|
+
],
|
|
1691
|
+
"docs": "",
|
|
1692
|
+
"complexTypes": [],
|
|
1693
|
+
"type": "string | undefined"
|
|
1694
|
+
},
|
|
1695
|
+
{
|
|
1696
|
+
"name": "breaking",
|
|
1697
|
+
"tags": [
|
|
1698
|
+
{
|
|
1699
|
+
"text": "7.22.0",
|
|
1700
|
+
"name": "since"
|
|
1701
|
+
}
|
|
1702
|
+
],
|
|
1703
|
+
"docs": "Indicates whether the update was flagged as breaking by the backend.",
|
|
1704
|
+
"complexTypes": [],
|
|
1705
|
+
"type": "boolean | undefined"
|
|
1706
|
+
},
|
|
1707
|
+
{
|
|
1708
|
+
"name": "major",
|
|
1709
|
+
"tags": [
|
|
1710
|
+
{
|
|
1711
|
+
"text": "Use {@link LatestVersion.breaking} instead.",
|
|
1712
|
+
"name": "deprecated"
|
|
1713
|
+
}
|
|
1714
|
+
],
|
|
1715
|
+
"docs": "",
|
|
1716
|
+
"complexTypes": [],
|
|
1717
|
+
"type": "boolean | undefined"
|
|
1718
|
+
},
|
|
1719
|
+
{
|
|
1720
|
+
"name": "message",
|
|
1721
|
+
"tags": [],
|
|
1722
|
+
"docs": "Optional message from the server.\nWhen no new version is available, this will be \"No new version available\".",
|
|
1723
|
+
"complexTypes": [],
|
|
1724
|
+
"type": "string | undefined"
|
|
1725
|
+
},
|
|
1726
|
+
{
|
|
1727
|
+
"name": "sessionKey",
|
|
1728
|
+
"tags": [],
|
|
1729
|
+
"docs": "",
|
|
1730
|
+
"complexTypes": [],
|
|
1731
|
+
"type": "string | undefined"
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
"name": "error",
|
|
1735
|
+
"tags": [],
|
|
1736
|
+
"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",
|
|
1737
|
+
"complexTypes": [],
|
|
1738
|
+
"type": "string | undefined"
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"name": "old",
|
|
1742
|
+
"tags": [],
|
|
1743
|
+
"docs": "The previous/current version name (provided for reference).",
|
|
1744
|
+
"complexTypes": [],
|
|
1745
|
+
"type": "string | undefined"
|
|
1746
|
+
},
|
|
1747
|
+
{
|
|
1748
|
+
"name": "url",
|
|
1749
|
+
"tags": [],
|
|
1750
|
+
"docs": "Download URL for the bundle (when a new version is available).",
|
|
1751
|
+
"complexTypes": [],
|
|
1752
|
+
"type": "string | undefined"
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"name": "manifest",
|
|
1756
|
+
"tags": [
|
|
1757
|
+
{
|
|
1758
|
+
"text": "6.1",
|
|
1759
|
+
"name": "since"
|
|
1760
|
+
}
|
|
1761
|
+
],
|
|
1762
|
+
"docs": "File list for partial updates (when using multi-file downloads).",
|
|
1109
1763
|
"complexTypes": [
|
|
1110
|
-
"
|
|
1764
|
+
"ManifestEntry"
|
|
1111
1765
|
],
|
|
1112
|
-
"type": "
|
|
1766
|
+
"type": "ManifestEntry[] | undefined"
|
|
1767
|
+
},
|
|
1768
|
+
{
|
|
1769
|
+
"name": "link",
|
|
1770
|
+
"tags": [
|
|
1771
|
+
{
|
|
1772
|
+
"text": "7.35.0",
|
|
1773
|
+
"name": "since"
|
|
1774
|
+
}
|
|
1775
|
+
],
|
|
1776
|
+
"docs": "Optional link associated with this bundle version (e.g., release notes URL, changelog, GitHub release).",
|
|
1777
|
+
"complexTypes": [],
|
|
1778
|
+
"type": "string | undefined"
|
|
1779
|
+
},
|
|
1780
|
+
{
|
|
1781
|
+
"name": "comment",
|
|
1782
|
+
"tags": [
|
|
1783
|
+
{
|
|
1784
|
+
"text": "7.35.0",
|
|
1785
|
+
"name": "since"
|
|
1786
|
+
}
|
|
1787
|
+
],
|
|
1788
|
+
"docs": "Optional comment or description for this bundle version.",
|
|
1789
|
+
"complexTypes": [],
|
|
1790
|
+
"type": "string | undefined"
|
|
1113
1791
|
}
|
|
1114
1792
|
]
|
|
1115
1793
|
},
|
|
1116
1794
|
{
|
|
1117
|
-
"name": "
|
|
1118
|
-
"slug": "
|
|
1795
|
+
"name": "GetLatestOptions",
|
|
1796
|
+
"slug": "getlatestoptions",
|
|
1797
|
+
"docs": "",
|
|
1798
|
+
"tags": [],
|
|
1799
|
+
"methods": [],
|
|
1800
|
+
"properties": [
|
|
1801
|
+
{
|
|
1802
|
+
"name": "channel",
|
|
1803
|
+
"tags": [
|
|
1804
|
+
{
|
|
1805
|
+
"text": "6.8.0",
|
|
1806
|
+
"name": "since"
|
|
1807
|
+
},
|
|
1808
|
+
{
|
|
1809
|
+
"text": "undefined",
|
|
1810
|
+
"name": "default"
|
|
1811
|
+
}
|
|
1812
|
+
],
|
|
1813
|
+
"docs": "The channel to get the latest version for\nThe channel must allow 'self_assign' for this to work",
|
|
1814
|
+
"complexTypes": [],
|
|
1815
|
+
"type": "string | undefined"
|
|
1816
|
+
}
|
|
1817
|
+
]
|
|
1818
|
+
},
|
|
1819
|
+
{
|
|
1820
|
+
"name": "ChannelRes",
|
|
1821
|
+
"slug": "channelres",
|
|
1822
|
+
"docs": "",
|
|
1823
|
+
"tags": [],
|
|
1824
|
+
"methods": [],
|
|
1825
|
+
"properties": [
|
|
1826
|
+
{
|
|
1827
|
+
"name": "status",
|
|
1828
|
+
"tags": [
|
|
1829
|
+
{
|
|
1830
|
+
"text": "4.7.0",
|
|
1831
|
+
"name": "since"
|
|
1832
|
+
}
|
|
1833
|
+
],
|
|
1834
|
+
"docs": "Current status of set channel",
|
|
1835
|
+
"complexTypes": [],
|
|
1836
|
+
"type": "string"
|
|
1837
|
+
},
|
|
1838
|
+
{
|
|
1839
|
+
"name": "error",
|
|
1840
|
+
"tags": [],
|
|
1841
|
+
"docs": "",
|
|
1842
|
+
"complexTypes": [],
|
|
1843
|
+
"type": "string | undefined"
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"name": "message",
|
|
1847
|
+
"tags": [],
|
|
1848
|
+
"docs": "",
|
|
1849
|
+
"complexTypes": [],
|
|
1850
|
+
"type": "string | undefined"
|
|
1851
|
+
}
|
|
1852
|
+
]
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "SetChannelOptions",
|
|
1856
|
+
"slug": "setchanneloptions",
|
|
1857
|
+
"docs": "",
|
|
1858
|
+
"tags": [],
|
|
1859
|
+
"methods": [],
|
|
1860
|
+
"properties": [
|
|
1861
|
+
{
|
|
1862
|
+
"name": "channel",
|
|
1863
|
+
"tags": [],
|
|
1864
|
+
"docs": "",
|
|
1865
|
+
"complexTypes": [],
|
|
1866
|
+
"type": "string"
|
|
1867
|
+
},
|
|
1868
|
+
{
|
|
1869
|
+
"name": "triggerAutoUpdate",
|
|
1870
|
+
"tags": [],
|
|
1871
|
+
"docs": "",
|
|
1872
|
+
"complexTypes": [],
|
|
1873
|
+
"type": "boolean | undefined"
|
|
1874
|
+
}
|
|
1875
|
+
]
|
|
1876
|
+
},
|
|
1877
|
+
{
|
|
1878
|
+
"name": "UnsetChannelOptions",
|
|
1879
|
+
"slug": "unsetchanneloptions",
|
|
1880
|
+
"docs": "",
|
|
1881
|
+
"tags": [],
|
|
1882
|
+
"methods": [],
|
|
1883
|
+
"properties": [
|
|
1884
|
+
{
|
|
1885
|
+
"name": "triggerAutoUpdate",
|
|
1886
|
+
"tags": [],
|
|
1887
|
+
"docs": "",
|
|
1888
|
+
"complexTypes": [],
|
|
1889
|
+
"type": "boolean | undefined"
|
|
1890
|
+
}
|
|
1891
|
+
]
|
|
1892
|
+
},
|
|
1893
|
+
{
|
|
1894
|
+
"name": "GetChannelRes",
|
|
1895
|
+
"slug": "getchannelres",
|
|
1896
|
+
"docs": "",
|
|
1897
|
+
"tags": [],
|
|
1898
|
+
"methods": [],
|
|
1899
|
+
"properties": [
|
|
1900
|
+
{
|
|
1901
|
+
"name": "channel",
|
|
1902
|
+
"tags": [
|
|
1903
|
+
{
|
|
1904
|
+
"text": "4.8.0",
|
|
1905
|
+
"name": "since"
|
|
1906
|
+
}
|
|
1907
|
+
],
|
|
1908
|
+
"docs": "Current status of get channel",
|
|
1909
|
+
"complexTypes": [],
|
|
1910
|
+
"type": "string | undefined"
|
|
1911
|
+
},
|
|
1912
|
+
{
|
|
1913
|
+
"name": "error",
|
|
1914
|
+
"tags": [],
|
|
1915
|
+
"docs": "",
|
|
1916
|
+
"complexTypes": [],
|
|
1917
|
+
"type": "string | undefined"
|
|
1918
|
+
},
|
|
1919
|
+
{
|
|
1920
|
+
"name": "message",
|
|
1921
|
+
"tags": [],
|
|
1922
|
+
"docs": "",
|
|
1923
|
+
"complexTypes": [],
|
|
1924
|
+
"type": "string | undefined"
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"name": "status",
|
|
1928
|
+
"tags": [],
|
|
1929
|
+
"docs": "",
|
|
1930
|
+
"complexTypes": [],
|
|
1931
|
+
"type": "string | undefined"
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"name": "allowSet",
|
|
1935
|
+
"tags": [],
|
|
1936
|
+
"docs": "",
|
|
1937
|
+
"complexTypes": [],
|
|
1938
|
+
"type": "boolean | undefined"
|
|
1939
|
+
}
|
|
1940
|
+
]
|
|
1941
|
+
},
|
|
1942
|
+
{
|
|
1943
|
+
"name": "ListChannelsResult",
|
|
1944
|
+
"slug": "listchannelsresult",
|
|
1119
1945
|
"docs": "",
|
|
1120
1946
|
"tags": [],
|
|
1121
1947
|
"methods": [],
|
|
1122
1948
|
"properties": [
|
|
1123
1949
|
{
|
|
1124
|
-
"name": "
|
|
1950
|
+
"name": "channels",
|
|
1951
|
+
"tags": [
|
|
1952
|
+
{
|
|
1953
|
+
"text": "7.5.0",
|
|
1954
|
+
"name": "since"
|
|
1955
|
+
}
|
|
1956
|
+
],
|
|
1957
|
+
"docs": "List of available channels",
|
|
1958
|
+
"complexTypes": [
|
|
1959
|
+
"ChannelInfo"
|
|
1960
|
+
],
|
|
1961
|
+
"type": "ChannelInfo[]"
|
|
1962
|
+
}
|
|
1963
|
+
]
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"name": "ChannelInfo",
|
|
1967
|
+
"slug": "channelinfo",
|
|
1968
|
+
"docs": "",
|
|
1969
|
+
"tags": [],
|
|
1970
|
+
"methods": [],
|
|
1971
|
+
"properties": [
|
|
1972
|
+
{
|
|
1973
|
+
"name": "id",
|
|
1974
|
+
"tags": [
|
|
1975
|
+
{
|
|
1976
|
+
"text": "7.5.0",
|
|
1977
|
+
"name": "since"
|
|
1978
|
+
}
|
|
1979
|
+
],
|
|
1980
|
+
"docs": "The channel ID",
|
|
1981
|
+
"complexTypes": [],
|
|
1982
|
+
"type": "string"
|
|
1983
|
+
},
|
|
1984
|
+
{
|
|
1985
|
+
"name": "name",
|
|
1986
|
+
"tags": [
|
|
1987
|
+
{
|
|
1988
|
+
"text": "7.5.0",
|
|
1989
|
+
"name": "since"
|
|
1990
|
+
}
|
|
1991
|
+
],
|
|
1992
|
+
"docs": "The channel name",
|
|
1993
|
+
"complexTypes": [],
|
|
1994
|
+
"type": "string"
|
|
1995
|
+
},
|
|
1996
|
+
{
|
|
1997
|
+
"name": "public",
|
|
1998
|
+
"tags": [
|
|
1999
|
+
{
|
|
2000
|
+
"text": "7.5.0",
|
|
2001
|
+
"name": "since"
|
|
2002
|
+
}
|
|
2003
|
+
],
|
|
2004
|
+
"docs": "Whether this is a public channel",
|
|
2005
|
+
"complexTypes": [],
|
|
2006
|
+
"type": "boolean"
|
|
2007
|
+
},
|
|
2008
|
+
{
|
|
2009
|
+
"name": "allow_self_set",
|
|
2010
|
+
"tags": [
|
|
2011
|
+
{
|
|
2012
|
+
"text": "7.5.0",
|
|
2013
|
+
"name": "since"
|
|
2014
|
+
}
|
|
2015
|
+
],
|
|
2016
|
+
"docs": "Whether devices can self-assign to this channel",
|
|
2017
|
+
"complexTypes": [],
|
|
2018
|
+
"type": "boolean"
|
|
2019
|
+
}
|
|
2020
|
+
]
|
|
2021
|
+
},
|
|
2022
|
+
{
|
|
2023
|
+
"name": "SetCustomIdOptions",
|
|
2024
|
+
"slug": "setcustomidoptions",
|
|
2025
|
+
"docs": "",
|
|
2026
|
+
"tags": [],
|
|
2027
|
+
"methods": [],
|
|
2028
|
+
"properties": [
|
|
2029
|
+
{
|
|
2030
|
+
"name": "customId",
|
|
2031
|
+
"tags": [],
|
|
2032
|
+
"docs": "Custom identifier to associate with the device. Use an empty string to clear any saved value.",
|
|
2033
|
+
"complexTypes": [],
|
|
2034
|
+
"type": "string"
|
|
2035
|
+
}
|
|
2036
|
+
]
|
|
2037
|
+
},
|
|
2038
|
+
{
|
|
2039
|
+
"name": "BuiltinVersion",
|
|
2040
|
+
"slug": "builtinversion",
|
|
2041
|
+
"docs": "",
|
|
2042
|
+
"tags": [],
|
|
2043
|
+
"methods": [],
|
|
2044
|
+
"properties": [
|
|
2045
|
+
{
|
|
2046
|
+
"name": "version",
|
|
2047
|
+
"tags": [],
|
|
2048
|
+
"docs": "",
|
|
2049
|
+
"complexTypes": [],
|
|
2050
|
+
"type": "string"
|
|
2051
|
+
}
|
|
2052
|
+
]
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "DeviceId",
|
|
2056
|
+
"slug": "deviceid",
|
|
2057
|
+
"docs": "",
|
|
2058
|
+
"tags": [],
|
|
2059
|
+
"methods": [],
|
|
2060
|
+
"properties": [
|
|
2061
|
+
{
|
|
2062
|
+
"name": "deviceId",
|
|
2063
|
+
"tags": [],
|
|
2064
|
+
"docs": "",
|
|
2065
|
+
"complexTypes": [],
|
|
2066
|
+
"type": "string"
|
|
2067
|
+
}
|
|
2068
|
+
]
|
|
2069
|
+
},
|
|
2070
|
+
{
|
|
2071
|
+
"name": "PluginVersion",
|
|
2072
|
+
"slug": "pluginversion",
|
|
2073
|
+
"docs": "",
|
|
2074
|
+
"tags": [],
|
|
2075
|
+
"methods": [],
|
|
2076
|
+
"properties": [
|
|
2077
|
+
{
|
|
2078
|
+
"name": "version",
|
|
2079
|
+
"tags": [],
|
|
2080
|
+
"docs": "",
|
|
2081
|
+
"complexTypes": [],
|
|
2082
|
+
"type": "string"
|
|
2083
|
+
}
|
|
2084
|
+
]
|
|
2085
|
+
},
|
|
2086
|
+
{
|
|
2087
|
+
"name": "AutoUpdateEnabled",
|
|
2088
|
+
"slug": "autoupdateenabled",
|
|
2089
|
+
"docs": "",
|
|
2090
|
+
"tags": [],
|
|
2091
|
+
"methods": [],
|
|
2092
|
+
"properties": [
|
|
2093
|
+
{
|
|
2094
|
+
"name": "enabled",
|
|
2095
|
+
"tags": [],
|
|
2096
|
+
"docs": "",
|
|
2097
|
+
"complexTypes": [],
|
|
2098
|
+
"type": "boolean"
|
|
2099
|
+
}
|
|
2100
|
+
]
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"name": "PluginListenerHandle",
|
|
2104
|
+
"slug": "pluginlistenerhandle",
|
|
2105
|
+
"docs": "",
|
|
2106
|
+
"tags": [],
|
|
2107
|
+
"methods": [],
|
|
2108
|
+
"properties": [
|
|
2109
|
+
{
|
|
2110
|
+
"name": "remove",
|
|
2111
|
+
"tags": [],
|
|
2112
|
+
"docs": "",
|
|
2113
|
+
"complexTypes": [],
|
|
2114
|
+
"type": "() => Promise<void>"
|
|
2115
|
+
}
|
|
2116
|
+
]
|
|
2117
|
+
},
|
|
2118
|
+
{
|
|
2119
|
+
"name": "DownloadEvent",
|
|
2120
|
+
"slug": "downloadevent",
|
|
2121
|
+
"docs": "",
|
|
2122
|
+
"tags": [],
|
|
2123
|
+
"methods": [],
|
|
2124
|
+
"properties": [
|
|
2125
|
+
{
|
|
2126
|
+
"name": "percent",
|
|
2127
|
+
"tags": [
|
|
2128
|
+
{
|
|
2129
|
+
"text": "4.0.0",
|
|
2130
|
+
"name": "since"
|
|
2131
|
+
}
|
|
2132
|
+
],
|
|
2133
|
+
"docs": "Current status of download, between 0 and 100.",
|
|
2134
|
+
"complexTypes": [],
|
|
2135
|
+
"type": "number"
|
|
2136
|
+
},
|
|
2137
|
+
{
|
|
2138
|
+
"name": "bundle",
|
|
2139
|
+
"tags": [],
|
|
2140
|
+
"docs": "",
|
|
2141
|
+
"complexTypes": [
|
|
2142
|
+
"BundleInfo"
|
|
2143
|
+
],
|
|
2144
|
+
"type": "BundleInfo"
|
|
2145
|
+
}
|
|
2146
|
+
]
|
|
2147
|
+
},
|
|
2148
|
+
{
|
|
2149
|
+
"name": "NoNeedEvent",
|
|
2150
|
+
"slug": "noneedevent",
|
|
2151
|
+
"docs": "",
|
|
2152
|
+
"tags": [],
|
|
2153
|
+
"methods": [],
|
|
2154
|
+
"properties": [
|
|
2155
|
+
{
|
|
2156
|
+
"name": "bundle",
|
|
2157
|
+
"tags": [
|
|
2158
|
+
{
|
|
2159
|
+
"text": "4.0.0",
|
|
2160
|
+
"name": "since"
|
|
2161
|
+
}
|
|
2162
|
+
],
|
|
2163
|
+
"docs": "Current status of download, between 0 and 100.",
|
|
2164
|
+
"complexTypes": [
|
|
2165
|
+
"BundleInfo"
|
|
2166
|
+
],
|
|
2167
|
+
"type": "BundleInfo"
|
|
2168
|
+
}
|
|
2169
|
+
]
|
|
2170
|
+
},
|
|
2171
|
+
{
|
|
2172
|
+
"name": "UpdateAvailableEvent",
|
|
2173
|
+
"slug": "updateavailableevent",
|
|
2174
|
+
"docs": "",
|
|
2175
|
+
"tags": [],
|
|
2176
|
+
"methods": [],
|
|
2177
|
+
"properties": [
|
|
2178
|
+
{
|
|
2179
|
+
"name": "bundle",
|
|
2180
|
+
"tags": [
|
|
2181
|
+
{
|
|
2182
|
+
"text": "4.0.0",
|
|
2183
|
+
"name": "since"
|
|
2184
|
+
}
|
|
2185
|
+
],
|
|
2186
|
+
"docs": "Current status of download, between 0 and 100.",
|
|
2187
|
+
"complexTypes": [
|
|
2188
|
+
"BundleInfo"
|
|
2189
|
+
],
|
|
2190
|
+
"type": "BundleInfo"
|
|
2191
|
+
}
|
|
2192
|
+
]
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
"name": "DownloadCompleteEvent",
|
|
2196
|
+
"slug": "downloadcompleteevent",
|
|
2197
|
+
"docs": "",
|
|
2198
|
+
"tags": [],
|
|
2199
|
+
"methods": [],
|
|
2200
|
+
"properties": [
|
|
2201
|
+
{
|
|
2202
|
+
"name": "bundle",
|
|
2203
|
+
"tags": [
|
|
2204
|
+
{
|
|
2205
|
+
"text": "4.0.0",
|
|
2206
|
+
"name": "since"
|
|
2207
|
+
}
|
|
2208
|
+
],
|
|
2209
|
+
"docs": "Emit when a new update is available.",
|
|
2210
|
+
"complexTypes": [
|
|
2211
|
+
"BundleInfo"
|
|
2212
|
+
],
|
|
2213
|
+
"type": "BundleInfo"
|
|
2214
|
+
}
|
|
2215
|
+
]
|
|
2216
|
+
},
|
|
2217
|
+
{
|
|
2218
|
+
"name": "MajorAvailableEvent",
|
|
2219
|
+
"slug": "majoravailableevent",
|
|
2220
|
+
"docs": "",
|
|
2221
|
+
"tags": [],
|
|
2222
|
+
"methods": [],
|
|
2223
|
+
"properties": [
|
|
2224
|
+
{
|
|
2225
|
+
"name": "version",
|
|
2226
|
+
"tags": [
|
|
2227
|
+
{
|
|
2228
|
+
"text": "Deprecated alias for {@link BreakingAvailableEvent}. Receives the same payload.",
|
|
2229
|
+
"name": "deprecated"
|
|
2230
|
+
},
|
|
2231
|
+
{
|
|
2232
|
+
"text": "4.0.0",
|
|
2233
|
+
"name": "since"
|
|
2234
|
+
}
|
|
2235
|
+
],
|
|
2236
|
+
"docs": "Emit when a breaking update is available.",
|
|
2237
|
+
"complexTypes": [],
|
|
2238
|
+
"type": "string"
|
|
2239
|
+
}
|
|
2240
|
+
]
|
|
2241
|
+
},
|
|
2242
|
+
{
|
|
2243
|
+
"name": "UpdateFailedEvent",
|
|
2244
|
+
"slug": "updatefailedevent",
|
|
2245
|
+
"docs": "",
|
|
2246
|
+
"tags": [],
|
|
2247
|
+
"methods": [],
|
|
2248
|
+
"properties": [
|
|
2249
|
+
{
|
|
2250
|
+
"name": "bundle",
|
|
2251
|
+
"tags": [
|
|
2252
|
+
{
|
|
2253
|
+
"text": "4.0.0",
|
|
2254
|
+
"name": "since"
|
|
2255
|
+
}
|
|
2256
|
+
],
|
|
2257
|
+
"docs": "Emit when a update failed to install.",
|
|
2258
|
+
"complexTypes": [
|
|
2259
|
+
"BundleInfo"
|
|
2260
|
+
],
|
|
2261
|
+
"type": "BundleInfo"
|
|
2262
|
+
}
|
|
2263
|
+
]
|
|
2264
|
+
},
|
|
2265
|
+
{
|
|
2266
|
+
"name": "DownloadFailedEvent",
|
|
2267
|
+
"slug": "downloadfailedevent",
|
|
2268
|
+
"docs": "",
|
|
2269
|
+
"tags": [],
|
|
2270
|
+
"methods": [],
|
|
2271
|
+
"properties": [
|
|
2272
|
+
{
|
|
2273
|
+
"name": "version",
|
|
2274
|
+
"tags": [
|
|
2275
|
+
{
|
|
2276
|
+
"text": "4.0.0",
|
|
2277
|
+
"name": "since"
|
|
2278
|
+
}
|
|
2279
|
+
],
|
|
2280
|
+
"docs": "Emit when a download fail.",
|
|
2281
|
+
"complexTypes": [],
|
|
2282
|
+
"type": "string"
|
|
2283
|
+
}
|
|
2284
|
+
]
|
|
2285
|
+
},
|
|
2286
|
+
{
|
|
2287
|
+
"name": "AppReadyEvent",
|
|
2288
|
+
"slug": "appreadyevent",
|
|
2289
|
+
"docs": "",
|
|
2290
|
+
"tags": [],
|
|
2291
|
+
"methods": [],
|
|
2292
|
+
"properties": [
|
|
2293
|
+
{
|
|
2294
|
+
"name": "bundle",
|
|
2295
|
+
"tags": [
|
|
2296
|
+
{
|
|
2297
|
+
"text": "5.2.0",
|
|
2298
|
+
"name": "since"
|
|
2299
|
+
}
|
|
2300
|
+
],
|
|
2301
|
+
"docs": "Emitted when the app is ready to use.",
|
|
2302
|
+
"complexTypes": [
|
|
2303
|
+
"BundleInfo"
|
|
2304
|
+
],
|
|
2305
|
+
"type": "BundleInfo"
|
|
2306
|
+
},
|
|
2307
|
+
{
|
|
2308
|
+
"name": "status",
|
|
2309
|
+
"tags": [],
|
|
2310
|
+
"docs": "",
|
|
2311
|
+
"complexTypes": [],
|
|
2312
|
+
"type": "string"
|
|
2313
|
+
}
|
|
2314
|
+
]
|
|
2315
|
+
},
|
|
2316
|
+
{
|
|
2317
|
+
"name": "ChannelPrivateEvent",
|
|
2318
|
+
"slug": "channelprivateevent",
|
|
2319
|
+
"docs": "",
|
|
2320
|
+
"tags": [],
|
|
2321
|
+
"methods": [],
|
|
2322
|
+
"properties": [
|
|
2323
|
+
{
|
|
2324
|
+
"name": "channel",
|
|
2325
|
+
"tags": [
|
|
2326
|
+
{
|
|
2327
|
+
"text": "7.34.0",
|
|
2328
|
+
"name": "since"
|
|
2329
|
+
}
|
|
2330
|
+
],
|
|
2331
|
+
"docs": "Emitted when attempting to set a channel that doesn't allow device self-assignment.",
|
|
2332
|
+
"complexTypes": [],
|
|
2333
|
+
"type": "string"
|
|
2334
|
+
},
|
|
2335
|
+
{
|
|
2336
|
+
"name": "message",
|
|
2337
|
+
"tags": [],
|
|
2338
|
+
"docs": "",
|
|
2339
|
+
"complexTypes": [],
|
|
2340
|
+
"type": "string"
|
|
2341
|
+
}
|
|
2342
|
+
]
|
|
2343
|
+
},
|
|
2344
|
+
{
|
|
2345
|
+
"name": "AutoUpdateAvailable",
|
|
2346
|
+
"slug": "autoupdateavailable",
|
|
2347
|
+
"docs": "",
|
|
2348
|
+
"tags": [],
|
|
2349
|
+
"methods": [],
|
|
2350
|
+
"properties": [
|
|
2351
|
+
{
|
|
2352
|
+
"name": "available",
|
|
2353
|
+
"tags": [],
|
|
2354
|
+
"docs": "",
|
|
2355
|
+
"complexTypes": [],
|
|
2356
|
+
"type": "boolean"
|
|
2357
|
+
}
|
|
2358
|
+
]
|
|
2359
|
+
},
|
|
2360
|
+
{
|
|
2361
|
+
"name": "SetShakeMenuOptions",
|
|
2362
|
+
"slug": "setshakemenuoptions",
|
|
2363
|
+
"docs": "",
|
|
2364
|
+
"tags": [],
|
|
2365
|
+
"methods": [],
|
|
2366
|
+
"properties": [
|
|
2367
|
+
{
|
|
2368
|
+
"name": "enabled",
|
|
2369
|
+
"tags": [],
|
|
2370
|
+
"docs": "",
|
|
2371
|
+
"complexTypes": [],
|
|
2372
|
+
"type": "boolean"
|
|
2373
|
+
}
|
|
2374
|
+
]
|
|
2375
|
+
},
|
|
2376
|
+
{
|
|
2377
|
+
"name": "ShakeMenuEnabled",
|
|
2378
|
+
"slug": "shakemenuenabled",
|
|
2379
|
+
"docs": "",
|
|
2380
|
+
"tags": [],
|
|
2381
|
+
"methods": [],
|
|
2382
|
+
"properties": [
|
|
2383
|
+
{
|
|
2384
|
+
"name": "enabled",
|
|
2385
|
+
"tags": [],
|
|
2386
|
+
"docs": "",
|
|
2387
|
+
"complexTypes": [],
|
|
2388
|
+
"type": "boolean"
|
|
2389
|
+
}
|
|
2390
|
+
]
|
|
2391
|
+
},
|
|
2392
|
+
{
|
|
2393
|
+
"name": "GetAppIdRes",
|
|
2394
|
+
"slug": "getappidres",
|
|
2395
|
+
"docs": "",
|
|
2396
|
+
"tags": [],
|
|
2397
|
+
"methods": [],
|
|
2398
|
+
"properties": [
|
|
2399
|
+
{
|
|
2400
|
+
"name": "appId",
|
|
2401
|
+
"tags": [],
|
|
2402
|
+
"docs": "",
|
|
2403
|
+
"complexTypes": [],
|
|
2404
|
+
"type": "string"
|
|
2405
|
+
}
|
|
2406
|
+
]
|
|
2407
|
+
},
|
|
2408
|
+
{
|
|
2409
|
+
"name": "SetAppIdOptions",
|
|
2410
|
+
"slug": "setappidoptions",
|
|
2411
|
+
"docs": "",
|
|
2412
|
+
"tags": [],
|
|
2413
|
+
"methods": [],
|
|
2414
|
+
"properties": [
|
|
2415
|
+
{
|
|
2416
|
+
"name": "appId",
|
|
2417
|
+
"tags": [],
|
|
2418
|
+
"docs": "",
|
|
2419
|
+
"complexTypes": [],
|
|
2420
|
+
"type": "string"
|
|
2421
|
+
}
|
|
2422
|
+
]
|
|
2423
|
+
}
|
|
2424
|
+
],
|
|
2425
|
+
"enums": [],
|
|
2426
|
+
"typeAliases": [
|
|
2427
|
+
{
|
|
2428
|
+
"name": "BundleStatus",
|
|
2429
|
+
"slug": "bundlestatus",
|
|
2430
|
+
"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.",
|
|
2431
|
+
"types": [
|
|
2432
|
+
{
|
|
2433
|
+
"text": "'success'",
|
|
2434
|
+
"complexTypes": []
|
|
2435
|
+
},
|
|
2436
|
+
{
|
|
2437
|
+
"text": "'error'",
|
|
2438
|
+
"complexTypes": []
|
|
2439
|
+
},
|
|
2440
|
+
{
|
|
2441
|
+
"text": "'pending'",
|
|
2442
|
+
"complexTypes": []
|
|
2443
|
+
},
|
|
2444
|
+
{
|
|
2445
|
+
"text": "'downloading'",
|
|
2446
|
+
"complexTypes": []
|
|
2447
|
+
}
|
|
2448
|
+
]
|
|
2449
|
+
},
|
|
2450
|
+
{
|
|
2451
|
+
"name": "DelayUntilNext",
|
|
2452
|
+
"slug": "delayuntilnext",
|
|
2453
|
+
"docs": "",
|
|
2454
|
+
"types": [
|
|
2455
|
+
{
|
|
2456
|
+
"text": "'background'",
|
|
2457
|
+
"complexTypes": []
|
|
2458
|
+
},
|
|
2459
|
+
{
|
|
2460
|
+
"text": "'kill'",
|
|
2461
|
+
"complexTypes": []
|
|
2462
|
+
},
|
|
2463
|
+
{
|
|
2464
|
+
"text": "'nativeVersion'",
|
|
2465
|
+
"complexTypes": []
|
|
2466
|
+
},
|
|
2467
|
+
{
|
|
2468
|
+
"text": "'date'",
|
|
2469
|
+
"complexTypes": []
|
|
2470
|
+
}
|
|
2471
|
+
]
|
|
2472
|
+
},
|
|
2473
|
+
{
|
|
2474
|
+
"name": "BreakingAvailableEvent",
|
|
2475
|
+
"slug": "breakingavailableevent",
|
|
2476
|
+
"docs": "Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.",
|
|
2477
|
+
"types": [
|
|
2478
|
+
{
|
|
2479
|
+
"text": "MajorAvailableEvent",
|
|
2480
|
+
"complexTypes": [
|
|
2481
|
+
"MajorAvailableEvent"
|
|
2482
|
+
]
|
|
2483
|
+
}
|
|
2484
|
+
]
|
|
2485
|
+
}
|
|
2486
|
+
],
|
|
2487
|
+
"pluginConfigs": [
|
|
2488
|
+
{
|
|
2489
|
+
"name": "CapacitorUpdater",
|
|
2490
|
+
"slug": "capacitorupdater",
|
|
2491
|
+
"properties": [
|
|
2492
|
+
{
|
|
2493
|
+
"name": "appReadyTimeout",
|
|
2494
|
+
"tags": [
|
|
2495
|
+
{
|
|
2496
|
+
"text": "10000 // (10 seconds)",
|
|
2497
|
+
"name": "default"
|
|
2498
|
+
},
|
|
2499
|
+
{
|
|
2500
|
+
"text": "1000 // (1 second)",
|
|
2501
|
+
"name": "example"
|
|
2502
|
+
}
|
|
2503
|
+
],
|
|
2504
|
+
"docs": "Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n\nOnly available for Android and iOS.",
|
|
2505
|
+
"complexTypes": [],
|
|
2506
|
+
"type": "number | undefined"
|
|
2507
|
+
},
|
|
2508
|
+
{
|
|
2509
|
+
"name": "responseTimeout",
|
|
2510
|
+
"tags": [
|
|
2511
|
+
{
|
|
2512
|
+
"text": "20 // (20 second)",
|
|
2513
|
+
"name": "default"
|
|
2514
|
+
},
|
|
2515
|
+
{
|
|
2516
|
+
"text": "10 // (10 second)",
|
|
2517
|
+
"name": "example"
|
|
2518
|
+
}
|
|
2519
|
+
],
|
|
2520
|
+
"docs": "Configure the number of seconds the native plugin should wait before considering API timeout.\n\nOnly available for Android and iOS.",
|
|
2521
|
+
"complexTypes": [],
|
|
2522
|
+
"type": "number | undefined"
|
|
2523
|
+
},
|
|
2524
|
+
{
|
|
2525
|
+
"name": "autoDeleteFailed",
|
|
2526
|
+
"tags": [
|
|
2527
|
+
{
|
|
2528
|
+
"text": "true",
|
|
2529
|
+
"name": "default"
|
|
2530
|
+
},
|
|
2531
|
+
{
|
|
2532
|
+
"text": "false",
|
|
2533
|
+
"name": "example"
|
|
2534
|
+
}
|
|
2535
|
+
],
|
|
2536
|
+
"docs": "Configure whether the plugin should use automatically delete failed bundles.\n\nOnly available for Android and iOS.",
|
|
2537
|
+
"complexTypes": [],
|
|
2538
|
+
"type": "boolean | undefined"
|
|
2539
|
+
},
|
|
2540
|
+
{
|
|
2541
|
+
"name": "autoDeletePrevious",
|
|
2542
|
+
"tags": [
|
|
2543
|
+
{
|
|
2544
|
+
"text": "true",
|
|
2545
|
+
"name": "default"
|
|
2546
|
+
},
|
|
2547
|
+
{
|
|
2548
|
+
"text": "false",
|
|
2549
|
+
"name": "example"
|
|
2550
|
+
}
|
|
2551
|
+
],
|
|
2552
|
+
"docs": "Configure whether the plugin should use automatically delete previous bundles after a successful update.\n\nOnly available for Android and iOS.",
|
|
2553
|
+
"complexTypes": [],
|
|
2554
|
+
"type": "boolean | undefined"
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
"name": "autoUpdate",
|
|
2558
|
+
"tags": [
|
|
2559
|
+
{
|
|
2560
|
+
"text": "true",
|
|
2561
|
+
"name": "default"
|
|
2562
|
+
},
|
|
2563
|
+
{
|
|
2564
|
+
"text": "false",
|
|
2565
|
+
"name": "example"
|
|
2566
|
+
}
|
|
2567
|
+
],
|
|
2568
|
+
"docs": "Configure whether the plugin should use Auto Update via an update server.\n\nOnly available for Android and iOS.",
|
|
2569
|
+
"complexTypes": [],
|
|
2570
|
+
"type": "boolean | undefined"
|
|
2571
|
+
},
|
|
2572
|
+
{
|
|
2573
|
+
"name": "resetWhenUpdate",
|
|
2574
|
+
"tags": [
|
|
2575
|
+
{
|
|
2576
|
+
"text": "true",
|
|
2577
|
+
"name": "default"
|
|
2578
|
+
},
|
|
2579
|
+
{
|
|
2580
|
+
"text": "false",
|
|
2581
|
+
"name": "example"
|
|
2582
|
+
}
|
|
2583
|
+
],
|
|
2584
|
+
"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.",
|
|
2585
|
+
"complexTypes": [],
|
|
2586
|
+
"type": "boolean | undefined"
|
|
2587
|
+
},
|
|
2588
|
+
{
|
|
2589
|
+
"name": "updateUrl",
|
|
2590
|
+
"tags": [
|
|
2591
|
+
{
|
|
2592
|
+
"text": "https://plugin.capgo.app/updates",
|
|
2593
|
+
"name": "default"
|
|
2594
|
+
},
|
|
2595
|
+
{
|
|
2596
|
+
"text": "https://example.com/api/auto_update",
|
|
2597
|
+
"name": "example"
|
|
2598
|
+
}
|
|
2599
|
+
],
|
|
2600
|
+
"docs": "Configure the URL / endpoint to which update checks are sent.\n\nOnly available for Android and iOS.",
|
|
2601
|
+
"complexTypes": [],
|
|
2602
|
+
"type": "string | undefined"
|
|
2603
|
+
},
|
|
2604
|
+
{
|
|
2605
|
+
"name": "channelUrl",
|
|
2606
|
+
"tags": [
|
|
2607
|
+
{
|
|
2608
|
+
"text": "https://plugin.capgo.app/channel_self",
|
|
2609
|
+
"name": "default"
|
|
2610
|
+
},
|
|
2611
|
+
{
|
|
2612
|
+
"text": "https://example.com/api/channel",
|
|
2613
|
+
"name": "example"
|
|
2614
|
+
}
|
|
2615
|
+
],
|
|
2616
|
+
"docs": "Configure the URL / endpoint for channel operations.\n\nOnly available for Android and iOS.",
|
|
2617
|
+
"complexTypes": [],
|
|
2618
|
+
"type": "string | undefined"
|
|
2619
|
+
},
|
|
2620
|
+
{
|
|
2621
|
+
"name": "statsUrl",
|
|
2622
|
+
"tags": [
|
|
2623
|
+
{
|
|
2624
|
+
"text": "https://plugin.capgo.app/stats",
|
|
2625
|
+
"name": "default"
|
|
2626
|
+
},
|
|
2627
|
+
{
|
|
2628
|
+
"text": "https://example.com/api/stats",
|
|
2629
|
+
"name": "example"
|
|
2630
|
+
}
|
|
2631
|
+
],
|
|
2632
|
+
"docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
|
|
2633
|
+
"complexTypes": [],
|
|
2634
|
+
"type": "string | undefined"
|
|
2635
|
+
},
|
|
2636
|
+
{
|
|
2637
|
+
"name": "publicKey",
|
|
2638
|
+
"tags": [
|
|
2639
|
+
{
|
|
2640
|
+
"text": "undefined",
|
|
2641
|
+
"name": "default"
|
|
2642
|
+
},
|
|
2643
|
+
{
|
|
2644
|
+
"text": "6.2.0",
|
|
2645
|
+
"name": "since"
|
|
2646
|
+
}
|
|
2647
|
+
],
|
|
2648
|
+
"docs": "Configure the public key for end to end live update encryption Version 2\n\nOnly available for Android and iOS.",
|
|
2649
|
+
"complexTypes": [],
|
|
2650
|
+
"type": "string | undefined"
|
|
2651
|
+
},
|
|
2652
|
+
{
|
|
2653
|
+
"name": "version",
|
|
2654
|
+
"tags": [
|
|
2655
|
+
{
|
|
2656
|
+
"text": "undefined",
|
|
2657
|
+
"name": "default"
|
|
2658
|
+
},
|
|
2659
|
+
{
|
|
2660
|
+
"text": "4.17.48",
|
|
2661
|
+
"name": "since"
|
|
2662
|
+
}
|
|
2663
|
+
],
|
|
2664
|
+
"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.",
|
|
2665
|
+
"complexTypes": [],
|
|
2666
|
+
"type": "string | undefined"
|
|
2667
|
+
},
|
|
2668
|
+
{
|
|
2669
|
+
"name": "directUpdate",
|
|
2670
|
+
"tags": [
|
|
2671
|
+
{
|
|
2672
|
+
"text": "false",
|
|
2673
|
+
"name": "default"
|
|
2674
|
+
},
|
|
2675
|
+
{
|
|
2676
|
+
"text": "5.1.0",
|
|
2677
|
+
"name": "since"
|
|
2678
|
+
}
|
|
2679
|
+
],
|
|
2680
|
+
"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 --partial 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\nOnly available for Android and iOS.",
|
|
2681
|
+
"complexTypes": [],
|
|
2682
|
+
"type": "boolean | 'always' | 'atInstall' | 'onLaunch' | undefined"
|
|
2683
|
+
},
|
|
2684
|
+
{
|
|
2685
|
+
"name": "autoSplashscreen",
|
|
2686
|
+
"tags": [
|
|
2687
|
+
{
|
|
2688
|
+
"text": "false",
|
|
2689
|
+
"name": "default"
|
|
2690
|
+
},
|
|
2691
|
+
{
|
|
2692
|
+
"text": "7.6.0",
|
|
2693
|
+
"name": "since"
|
|
2694
|
+
}
|
|
2695
|
+
],
|
|
2696
|
+
"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.",
|
|
2697
|
+
"complexTypes": [],
|
|
2698
|
+
"type": "boolean | undefined"
|
|
2699
|
+
},
|
|
2700
|
+
{
|
|
2701
|
+
"name": "autoSplashscreenLoader",
|
|
2702
|
+
"tags": [
|
|
2703
|
+
{
|
|
2704
|
+
"text": "false",
|
|
2705
|
+
"name": "default"
|
|
2706
|
+
},
|
|
2707
|
+
{
|
|
2708
|
+
"text": "7.19.0",
|
|
2709
|
+
"name": "since"
|
|
2710
|
+
}
|
|
2711
|
+
],
|
|
2712
|
+
"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.",
|
|
2713
|
+
"complexTypes": [],
|
|
2714
|
+
"type": "boolean | undefined"
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
"name": "autoSplashscreenTimeout",
|
|
2718
|
+
"tags": [
|
|
2719
|
+
{
|
|
2720
|
+
"text": "10000 // (10 seconds)",
|
|
2721
|
+
"name": "default"
|
|
2722
|
+
},
|
|
2723
|
+
{
|
|
2724
|
+
"text": "7.19.0",
|
|
2725
|
+
"name": "since"
|
|
2726
|
+
}
|
|
2727
|
+
],
|
|
2728
|
+
"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.",
|
|
2729
|
+
"complexTypes": [],
|
|
2730
|
+
"type": "number | undefined"
|
|
2731
|
+
},
|
|
2732
|
+
{
|
|
2733
|
+
"name": "periodCheckDelay",
|
|
2734
|
+
"tags": [
|
|
2735
|
+
{
|
|
2736
|
+
"text": "0 (disabled)",
|
|
2737
|
+
"name": "default"
|
|
2738
|
+
},
|
|
2739
|
+
{
|
|
2740
|
+
"text": "3600 (1 hour)",
|
|
2741
|
+
"name": "example"
|
|
2742
|
+
},
|
|
2743
|
+
{
|
|
2744
|
+
"text": "86400 (24 hours)",
|
|
2745
|
+
"name": "example"
|
|
2746
|
+
}
|
|
2747
|
+
],
|
|
2748
|
+
"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).",
|
|
2749
|
+
"complexTypes": [],
|
|
2750
|
+
"type": "number | undefined"
|
|
2751
|
+
},
|
|
2752
|
+
{
|
|
2753
|
+
"name": "localS3",
|
|
2754
|
+
"tags": [
|
|
2755
|
+
{
|
|
2756
|
+
"text": "undefined",
|
|
2757
|
+
"name": "default"
|
|
2758
|
+
},
|
|
2759
|
+
{
|
|
2760
|
+
"text": "4.17.48",
|
|
2761
|
+
"name": "since"
|
|
2762
|
+
}
|
|
2763
|
+
],
|
|
2764
|
+
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
2765
|
+
"complexTypes": [],
|
|
2766
|
+
"type": "boolean | undefined"
|
|
2767
|
+
},
|
|
2768
|
+
{
|
|
2769
|
+
"name": "localHost",
|
|
2770
|
+
"tags": [
|
|
2771
|
+
{
|
|
2772
|
+
"text": "undefined",
|
|
2773
|
+
"name": "default"
|
|
2774
|
+
},
|
|
2775
|
+
{
|
|
2776
|
+
"text": "4.17.48",
|
|
2777
|
+
"name": "since"
|
|
2778
|
+
}
|
|
2779
|
+
],
|
|
2780
|
+
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
2781
|
+
"complexTypes": [],
|
|
2782
|
+
"type": "string | undefined"
|
|
2783
|
+
},
|
|
2784
|
+
{
|
|
2785
|
+
"name": "localWebHost",
|
|
2786
|
+
"tags": [
|
|
2787
|
+
{
|
|
2788
|
+
"text": "undefined",
|
|
2789
|
+
"name": "default"
|
|
2790
|
+
},
|
|
2791
|
+
{
|
|
2792
|
+
"text": "4.17.48",
|
|
2793
|
+
"name": "since"
|
|
2794
|
+
}
|
|
2795
|
+
],
|
|
2796
|
+
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
2797
|
+
"complexTypes": [],
|
|
2798
|
+
"type": "string | undefined"
|
|
2799
|
+
},
|
|
2800
|
+
{
|
|
2801
|
+
"name": "localSupa",
|
|
2802
|
+
"tags": [
|
|
2803
|
+
{
|
|
2804
|
+
"text": "undefined",
|
|
2805
|
+
"name": "default"
|
|
2806
|
+
},
|
|
2807
|
+
{
|
|
2808
|
+
"text": "4.17.48",
|
|
2809
|
+
"name": "since"
|
|
2810
|
+
}
|
|
2811
|
+
],
|
|
2812
|
+
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
2813
|
+
"complexTypes": [],
|
|
2814
|
+
"type": "string | undefined"
|
|
2815
|
+
},
|
|
2816
|
+
{
|
|
2817
|
+
"name": "localSupaAnon",
|
|
1125
2818
|
"tags": [
|
|
1126
2819
|
{
|
|
1127
|
-
"text": "
|
|
2820
|
+
"text": "undefined",
|
|
2821
|
+
"name": "default"
|
|
2822
|
+
},
|
|
2823
|
+
{
|
|
2824
|
+
"text": "4.17.48",
|
|
1128
2825
|
"name": "since"
|
|
1129
2826
|
}
|
|
1130
2827
|
],
|
|
1131
|
-
"docs": "
|
|
2828
|
+
"docs": "Configure the CLI to use a local server for testing.",
|
|
1132
2829
|
"complexTypes": [],
|
|
1133
|
-
"type": "string"
|
|
1134
|
-
}
|
|
1135
|
-
]
|
|
1136
|
-
},
|
|
1137
|
-
{
|
|
1138
|
-
"name": "UpdateFailedEvent",
|
|
1139
|
-
"slug": "updatefailedevent",
|
|
1140
|
-
"docs": "",
|
|
1141
|
-
"tags": [],
|
|
1142
|
-
"methods": [],
|
|
1143
|
-
"properties": [
|
|
2830
|
+
"type": "string | undefined"
|
|
2831
|
+
},
|
|
1144
2832
|
{
|
|
1145
|
-
"name": "
|
|
2833
|
+
"name": "localApi",
|
|
1146
2834
|
"tags": [
|
|
1147
2835
|
{
|
|
1148
|
-
"text": "
|
|
2836
|
+
"text": "undefined",
|
|
2837
|
+
"name": "default"
|
|
2838
|
+
},
|
|
2839
|
+
{
|
|
2840
|
+
"text": "6.3.3",
|
|
1149
2841
|
"name": "since"
|
|
1150
2842
|
}
|
|
1151
2843
|
],
|
|
1152
|
-
"docs": "
|
|
1153
|
-
"complexTypes": [
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
"type": "BundleInfo"
|
|
1157
|
-
}
|
|
1158
|
-
]
|
|
1159
|
-
},
|
|
1160
|
-
{
|
|
1161
|
-
"name": "DownloadFailedEvent",
|
|
1162
|
-
"slug": "downloadfailedevent",
|
|
1163
|
-
"docs": "",
|
|
1164
|
-
"tags": [],
|
|
1165
|
-
"methods": [],
|
|
1166
|
-
"properties": [
|
|
2844
|
+
"docs": "Configure the CLI to use a local api for testing.",
|
|
2845
|
+
"complexTypes": [],
|
|
2846
|
+
"type": "string | undefined"
|
|
2847
|
+
},
|
|
1167
2848
|
{
|
|
1168
|
-
"name": "
|
|
2849
|
+
"name": "localApiFiles",
|
|
1169
2850
|
"tags": [
|
|
1170
2851
|
{
|
|
1171
|
-
"text": "
|
|
2852
|
+
"text": "undefined",
|
|
2853
|
+
"name": "default"
|
|
2854
|
+
},
|
|
2855
|
+
{
|
|
2856
|
+
"text": "6.3.3",
|
|
1172
2857
|
"name": "since"
|
|
1173
2858
|
}
|
|
1174
2859
|
],
|
|
1175
|
-
"docs": "
|
|
2860
|
+
"docs": "Configure the CLI to use a local file api for testing.",
|
|
1176
2861
|
"complexTypes": [],
|
|
1177
|
-
"type": "string"
|
|
1178
|
-
}
|
|
1179
|
-
]
|
|
1180
|
-
}
|
|
1181
|
-
],
|
|
1182
|
-
"enums": [],
|
|
1183
|
-
"typeAliases": [
|
|
1184
|
-
{
|
|
1185
|
-
"name": "BundleStatus",
|
|
1186
|
-
"slug": "bundlestatus",
|
|
1187
|
-
"docs": "",
|
|
1188
|
-
"types": [
|
|
1189
|
-
{
|
|
1190
|
-
"text": "\"success\"",
|
|
1191
|
-
"complexTypes": []
|
|
1192
|
-
},
|
|
1193
|
-
{
|
|
1194
|
-
"text": "\"error\"",
|
|
1195
|
-
"complexTypes": []
|
|
1196
|
-
},
|
|
1197
|
-
{
|
|
1198
|
-
"text": "\"pending\"",
|
|
1199
|
-
"complexTypes": []
|
|
1200
|
-
},
|
|
1201
|
-
{
|
|
1202
|
-
"text": "\"downloading\"",
|
|
1203
|
-
"complexTypes": []
|
|
1204
|
-
}
|
|
1205
|
-
]
|
|
1206
|
-
},
|
|
1207
|
-
{
|
|
1208
|
-
"name": "DelayUntilNext",
|
|
1209
|
-
"slug": "delayuntilnext",
|
|
1210
|
-
"docs": "",
|
|
1211
|
-
"types": [
|
|
1212
|
-
{
|
|
1213
|
-
"text": "\"background\"",
|
|
1214
|
-
"complexTypes": []
|
|
1215
|
-
},
|
|
1216
|
-
{
|
|
1217
|
-
"text": "\"kill\"",
|
|
1218
|
-
"complexTypes": []
|
|
2862
|
+
"type": "string | undefined"
|
|
1219
2863
|
},
|
|
1220
2864
|
{
|
|
1221
|
-
"
|
|
1222
|
-
"
|
|
2865
|
+
"name": "allowModifyUrl",
|
|
2866
|
+
"tags": [
|
|
2867
|
+
{
|
|
2868
|
+
"text": "false",
|
|
2869
|
+
"name": "default"
|
|
2870
|
+
},
|
|
2871
|
+
{
|
|
2872
|
+
"text": "5.4.0",
|
|
2873
|
+
"name": "since"
|
|
2874
|
+
}
|
|
2875
|
+
],
|
|
2876
|
+
"docs": "Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.",
|
|
2877
|
+
"complexTypes": [],
|
|
2878
|
+
"type": "boolean | undefined"
|
|
1223
2879
|
},
|
|
1224
2880
|
{
|
|
1225
|
-
"
|
|
1226
|
-
"complexTypes": []
|
|
1227
|
-
}
|
|
1228
|
-
]
|
|
1229
|
-
},
|
|
1230
|
-
{
|
|
1231
|
-
"name": "DownloadChangeListener",
|
|
1232
|
-
"slug": "downloadchangelistener",
|
|
1233
|
-
"docs": "",
|
|
1234
|
-
"types": [
|
|
1235
|
-
{
|
|
1236
|
-
"text": "(state: DownloadEvent): void",
|
|
1237
|
-
"complexTypes": [
|
|
1238
|
-
"DownloadEvent"
|
|
1239
|
-
]
|
|
1240
|
-
}
|
|
1241
|
-
]
|
|
1242
|
-
},
|
|
1243
|
-
{
|
|
1244
|
-
"name": "NoNeedListener",
|
|
1245
|
-
"slug": "noneedlistener",
|
|
1246
|
-
"docs": "",
|
|
1247
|
-
"types": [
|
|
1248
|
-
{
|
|
1249
|
-
"text": "(state: noNeedEvent): void",
|
|
1250
|
-
"complexTypes": [
|
|
1251
|
-
"noNeedEvent"
|
|
1252
|
-
]
|
|
1253
|
-
}
|
|
1254
|
-
]
|
|
1255
|
-
},
|
|
1256
|
-
{
|
|
1257
|
-
"name": "UpdateAvailabledListener",
|
|
1258
|
-
"slug": "updateavailabledlistener",
|
|
1259
|
-
"docs": "",
|
|
1260
|
-
"types": [
|
|
1261
|
-
{
|
|
1262
|
-
"text": "(state: updateAvailableEvent): void",
|
|
1263
|
-
"complexTypes": [
|
|
1264
|
-
"updateAvailableEvent"
|
|
1265
|
-
]
|
|
1266
|
-
}
|
|
1267
|
-
]
|
|
1268
|
-
},
|
|
1269
|
-
{
|
|
1270
|
-
"name": "DownloadCompleteListener",
|
|
1271
|
-
"slug": "downloadcompletelistener",
|
|
1272
|
-
"docs": "",
|
|
1273
|
-
"types": [
|
|
1274
|
-
{
|
|
1275
|
-
"text": "(state: DownloadCompleteEvent): void",
|
|
1276
|
-
"complexTypes": [
|
|
1277
|
-
"DownloadCompleteEvent"
|
|
1278
|
-
]
|
|
1279
|
-
}
|
|
1280
|
-
]
|
|
1281
|
-
},
|
|
1282
|
-
{
|
|
1283
|
-
"name": "MajorAvailableListener",
|
|
1284
|
-
"slug": "majoravailablelistener",
|
|
1285
|
-
"docs": "",
|
|
1286
|
-
"types": [
|
|
1287
|
-
{
|
|
1288
|
-
"text": "(state: MajorAvailableEvent): void",
|
|
1289
|
-
"complexTypes": [
|
|
1290
|
-
"MajorAvailableEvent"
|
|
1291
|
-
]
|
|
1292
|
-
}
|
|
1293
|
-
]
|
|
1294
|
-
},
|
|
1295
|
-
{
|
|
1296
|
-
"name": "UpdateFailedListener",
|
|
1297
|
-
"slug": "updatefailedlistener",
|
|
1298
|
-
"docs": "",
|
|
1299
|
-
"types": [
|
|
1300
|
-
{
|
|
1301
|
-
"text": "(state: UpdateFailedEvent): void",
|
|
1302
|
-
"complexTypes": [
|
|
1303
|
-
"UpdateFailedEvent"
|
|
1304
|
-
]
|
|
1305
|
-
}
|
|
1306
|
-
]
|
|
1307
|
-
},
|
|
1308
|
-
{
|
|
1309
|
-
"name": "DownloadFailedListener",
|
|
1310
|
-
"slug": "downloadfailedlistener",
|
|
1311
|
-
"docs": "",
|
|
1312
|
-
"types": [
|
|
1313
|
-
{
|
|
1314
|
-
"text": "(state: DownloadFailedEvent): void",
|
|
1315
|
-
"complexTypes": [
|
|
1316
|
-
"DownloadFailedEvent"
|
|
1317
|
-
]
|
|
1318
|
-
}
|
|
1319
|
-
]
|
|
1320
|
-
},
|
|
1321
|
-
{
|
|
1322
|
-
"name": "AppReloadedListener",
|
|
1323
|
-
"slug": "appreloadedlistener",
|
|
1324
|
-
"docs": "",
|
|
1325
|
-
"types": [
|
|
1326
|
-
{
|
|
1327
|
-
"text": "(state: void): void",
|
|
1328
|
-
"complexTypes": []
|
|
1329
|
-
}
|
|
1330
|
-
]
|
|
1331
|
-
}
|
|
1332
|
-
],
|
|
1333
|
-
"pluginConfigs": [
|
|
1334
|
-
{
|
|
1335
|
-
"name": "CapacitorUpdater",
|
|
1336
|
-
"slug": "capacitorupdater",
|
|
1337
|
-
"properties": [
|
|
1338
|
-
{
|
|
1339
|
-
"name": "appReadyTimeout",
|
|
2881
|
+
"name": "allowModifyAppId",
|
|
1340
2882
|
"tags": [
|
|
1341
2883
|
{
|
|
1342
|
-
"text": "
|
|
2884
|
+
"text": "false",
|
|
1343
2885
|
"name": "default"
|
|
1344
2886
|
},
|
|
1345
2887
|
{
|
|
1346
|
-
"text": "
|
|
1347
|
-
"name": "
|
|
2888
|
+
"text": "7.14.0",
|
|
2889
|
+
"name": "since"
|
|
1348
2890
|
}
|
|
1349
2891
|
],
|
|
1350
|
-
"docs": "
|
|
2892
|
+
"docs": "Allow the plugin to modify the appId dynamically from the JavaScript side.",
|
|
1351
2893
|
"complexTypes": [],
|
|
1352
|
-
"type": "
|
|
2894
|
+
"type": "boolean | undefined"
|
|
1353
2895
|
},
|
|
1354
2896
|
{
|
|
1355
|
-
"name": "
|
|
2897
|
+
"name": "allowManualBundleError",
|
|
1356
2898
|
"tags": [
|
|
1357
2899
|
{
|
|
1358
|
-
"text": "
|
|
2900
|
+
"text": "false",
|
|
1359
2901
|
"name": "default"
|
|
1360
2902
|
},
|
|
1361
2903
|
{
|
|
1362
|
-
"text": "
|
|
1363
|
-
"name": "
|
|
2904
|
+
"text": "7.20.0",
|
|
2905
|
+
"name": "since"
|
|
1364
2906
|
}
|
|
1365
2907
|
],
|
|
1366
|
-
"docs": "
|
|
2908
|
+
"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`.",
|
|
1367
2909
|
"complexTypes": [],
|
|
1368
2910
|
"type": "boolean | undefined"
|
|
1369
2911
|
},
|
|
1370
2912
|
{
|
|
1371
|
-
"name": "
|
|
2913
|
+
"name": "persistCustomId",
|
|
1372
2914
|
"tags": [
|
|
1373
2915
|
{
|
|
1374
|
-
"text": "true",
|
|
2916
|
+
"text": "false (will be true by default in a future major release v8.x.x)",
|
|
1375
2917
|
"name": "default"
|
|
1376
2918
|
},
|
|
1377
2919
|
{
|
|
1378
|
-
"text": "
|
|
1379
|
-
"name": "
|
|
2920
|
+
"text": "7.17.3",
|
|
2921
|
+
"name": "since"
|
|
1380
2922
|
}
|
|
1381
2923
|
],
|
|
1382
|
-
"docs": "
|
|
2924
|
+
"docs": "Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts.\n\nOnly available for Android and iOS.",
|
|
1383
2925
|
"complexTypes": [],
|
|
1384
2926
|
"type": "boolean | undefined"
|
|
1385
2927
|
},
|
|
1386
2928
|
{
|
|
1387
|
-
"name": "
|
|
2929
|
+
"name": "persistModifyUrl",
|
|
1388
2930
|
"tags": [
|
|
1389
2931
|
{
|
|
1390
|
-
"text": "
|
|
2932
|
+
"text": "false",
|
|
1391
2933
|
"name": "default"
|
|
1392
2934
|
},
|
|
1393
2935
|
{
|
|
1394
|
-
"text": "
|
|
1395
|
-
"name": "
|
|
2936
|
+
"text": "7.20.0",
|
|
2937
|
+
"name": "since"
|
|
1396
2938
|
}
|
|
1397
2939
|
],
|
|
1398
|
-
"docs": "
|
|
2940
|
+
"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.",
|
|
1399
2941
|
"complexTypes": [],
|
|
1400
2942
|
"type": "boolean | undefined"
|
|
1401
2943
|
},
|
|
1402
2944
|
{
|
|
1403
|
-
"name": "
|
|
2945
|
+
"name": "allowSetDefaultChannel",
|
|
1404
2946
|
"tags": [
|
|
1405
2947
|
{
|
|
1406
2948
|
"text": "true",
|
|
1407
2949
|
"name": "default"
|
|
1408
2950
|
},
|
|
1409
2951
|
{
|
|
1410
|
-
"text": "
|
|
1411
|
-
"name": "
|
|
2952
|
+
"text": "7.34.0",
|
|
2953
|
+
"name": "since"
|
|
1412
2954
|
}
|
|
1413
2955
|
],
|
|
1414
|
-
"docs": "
|
|
2956
|
+
"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`.",
|
|
1415
2957
|
"complexTypes": [],
|
|
1416
2958
|
"type": "boolean | undefined"
|
|
1417
2959
|
},
|
|
1418
2960
|
{
|
|
1419
|
-
"name": "
|
|
2961
|
+
"name": "defaultChannel",
|
|
1420
2962
|
"tags": [
|
|
1421
2963
|
{
|
|
1422
|
-
"text": "
|
|
2964
|
+
"text": "undefined",
|
|
1423
2965
|
"name": "default"
|
|
1424
2966
|
},
|
|
1425
2967
|
{
|
|
1426
|
-
"text": "
|
|
1427
|
-
"name": "
|
|
2968
|
+
"text": "5.5.0",
|
|
2969
|
+
"name": "since"
|
|
1428
2970
|
}
|
|
1429
2971
|
],
|
|
1430
|
-
"docs": "
|
|
2972
|
+
"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",
|
|
1431
2973
|
"complexTypes": [],
|
|
1432
2974
|
"type": "string | undefined"
|
|
1433
2975
|
},
|
|
1434
2976
|
{
|
|
1435
|
-
"name": "
|
|
2977
|
+
"name": "appId",
|
|
1436
2978
|
"tags": [
|
|
1437
2979
|
{
|
|
1438
|
-
"text": "
|
|
2980
|
+
"text": "undefined",
|
|
1439
2981
|
"name": "default"
|
|
1440
2982
|
},
|
|
1441
2983
|
{
|
|
1442
|
-
"text": "
|
|
1443
|
-
"name": "
|
|
2984
|
+
"text": "6.0.0",
|
|
2985
|
+
"name": "since"
|
|
1444
2986
|
}
|
|
1445
2987
|
],
|
|
1446
|
-
"docs": "Configure the
|
|
2988
|
+
"docs": "Configure the app id for the app in the config.",
|
|
1447
2989
|
"complexTypes": [],
|
|
1448
2990
|
"type": "string | undefined"
|
|
1449
2991
|
},
|
|
1450
2992
|
{
|
|
1451
|
-
"name": "
|
|
2993
|
+
"name": "keepUrlPathAfterReload",
|
|
1452
2994
|
"tags": [
|
|
1453
2995
|
{
|
|
1454
|
-
"text": "
|
|
2996
|
+
"text": "false",
|
|
1455
2997
|
"name": "default"
|
|
2998
|
+
},
|
|
2999
|
+
{
|
|
3000
|
+
"text": "6.8.0",
|
|
3001
|
+
"name": "since"
|
|
1456
3002
|
}
|
|
1457
3003
|
],
|
|
1458
|
-
"docs": "Configure the
|
|
3004
|
+
"docs": "Configure the plugin to keep the URL path after a reload.\nWARNING: When a reload is triggered, 'window.history' will be cleared.",
|
|
1459
3005
|
"complexTypes": [],
|
|
1460
|
-
"type": "
|
|
3006
|
+
"type": "boolean | undefined"
|
|
1461
3007
|
},
|
|
1462
3008
|
{
|
|
1463
|
-
"name": "
|
|
3009
|
+
"name": "disableJSLogging",
|
|
1464
3010
|
"tags": [
|
|
1465
3011
|
{
|
|
1466
|
-
"text": "
|
|
3012
|
+
"text": "false",
|
|
1467
3013
|
"name": "default"
|
|
1468
3014
|
},
|
|
1469
3015
|
{
|
|
1470
|
-
"text": "
|
|
3016
|
+
"text": "7.3.0",
|
|
1471
3017
|
"name": "since"
|
|
1472
3018
|
}
|
|
1473
3019
|
],
|
|
1474
|
-
"docs": "
|
|
3020
|
+
"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",
|
|
1475
3021
|
"complexTypes": [],
|
|
1476
|
-
"type": "
|
|
3022
|
+
"type": "boolean | undefined"
|
|
3023
|
+
},
|
|
3024
|
+
{
|
|
3025
|
+
"name": "shakeMenu",
|
|
3026
|
+
"tags": [
|
|
3027
|
+
{
|
|
3028
|
+
"text": "false",
|
|
3029
|
+
"name": "default"
|
|
3030
|
+
},
|
|
3031
|
+
{
|
|
3032
|
+
"text": "7.5.0",
|
|
3033
|
+
"name": "since"
|
|
3034
|
+
}
|
|
3035
|
+
],
|
|
3036
|
+
"docs": "Enable shake gesture to show update menu for debugging/testing purposes",
|
|
3037
|
+
"complexTypes": [],
|
|
3038
|
+
"type": "boolean | undefined"
|
|
1477
3039
|
}
|
|
1478
3040
|
],
|
|
1479
|
-
"docs": "
|
|
3041
|
+
"docs": "CapacitorUpdater can be configured with these options:"
|
|
1480
3042
|
}
|
|
1481
3043
|
]
|
|
1482
3044
|
}
|