@capawesome/capacitor-live-update 6.8.0-dev.2e2696e1.1773643381 → 6.9.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/CapawesomeCapacitorLiveUpdate.podspec +2 -2
- package/README.md +435 -27
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdate.java +851 -262
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdateConfig.java +35 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdateHttpClient.java +56 -11
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePlugin.java +273 -38
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePreferences.java +52 -3
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/api/GetChannelsResponseItem.java +28 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/api/GetLatestBundleResponse.java +7 -7
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/events/DownloadBundleProgressEvent.java +32 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/events/NextBundleSetEvent.java +26 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/FetchChannelsOptions.java +38 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/SetConfigOptions.java +19 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/SyncOptions.java +4 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/ChannelResult.java +28 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/FetchChannelsResult.java +28 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/FetchLatestBundleResult.java +7 -7
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/GetBlockedBundlesResult.java +27 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/GetConfigResult.java +40 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/GetDownloadedBundlesResult.java +27 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/IsSyncingResult.java +26 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/ReadyResult.java +32 -0
- package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/interfaces/DownloadProgressCallback.java +5 -0
- package/dist/docs.json +845 -54
- package/dist/esm/definitions.d.ts +413 -18
- package/dist/esm/definitions.js.map +1 -1
- package/dist/esm/web.d.ts +10 -2
- package/dist/esm/web.js +24 -0
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +24 -0
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +24 -0
- package/dist/plugin.js.map +1 -1
- package/ios/Plugin/Classes/Events/DownloadBundleProgressEvent.swift +25 -0
- package/ios/Plugin/Classes/Events/NextBundleSetEvent.swift +16 -0
- package/ios/Plugin/Classes/Options/FetchChannelsOptions.swift +26 -0
- package/ios/Plugin/Classes/Options/SetConfigOptions.swift +14 -0
- package/ios/Plugin/Classes/Options/SyncOptions.swift +4 -0
- package/ios/Plugin/Classes/Results/ChannelResult.swift +19 -0
- package/ios/Plugin/Classes/Results/FetchChannelsResult.swift +16 -0
- package/ios/Plugin/Classes/Results/{FetchLatestBundle.swift → FetchLatestBundleResult.swift} +6 -6
- package/ios/Plugin/Classes/Results/GetBlockedBundlesResult.swift +16 -0
- package/ios/Plugin/Classes/Results/GetConfigResult.swift +19 -0
- package/ios/Plugin/Classes/Results/GetDownloadedBundlesResult.swift +16 -0
- package/ios/Plugin/Classes/Results/IsSyncingResult.swift +16 -0
- package/ios/Plugin/Classes/Results/ReadyResult.swift +22 -0
- package/ios/Plugin/LiveUpdate.swift +423 -145
- package/ios/Plugin/LiveUpdateConfig.swift +3 -0
- package/ios/Plugin/LiveUpdateHttpClient.swift +21 -4
- package/ios/Plugin/LiveUpdatePlugin.swift +174 -14
- package/ios/Plugin/LiveUpdatePreferences.swift +54 -12
- package/ios/Plugin/Protocols/Api/GetChannelsResponseItem.swift +4 -0
- package/ios/Plugin/Protocols/Api/GetLatestBundleResponse.swift +1 -1
- package/package.json +5 -5
- package/ios/Plugin/LiveUpdatePlugin.h +0 -10
- package/ios/Plugin/LiveUpdatePlugin.m +0 -27
package/dist/docs.json
CHANGED
|
@@ -5,6 +5,21 @@
|
|
|
5
5
|
"docs": "",
|
|
6
6
|
"tags": [],
|
|
7
7
|
"methods": [
|
|
8
|
+
{
|
|
9
|
+
"name": "clearBlockedBundles",
|
|
10
|
+
"signature": "() => Promise<void>",
|
|
11
|
+
"parameters": [],
|
|
12
|
+
"returns": "Promise<void>",
|
|
13
|
+
"tags": [
|
|
14
|
+
{
|
|
15
|
+
"name": "since",
|
|
16
|
+
"text": "6.9.0"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"docs": "Clear all blocked bundles from the blocked list.\n\nThis removes all bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android and iOS.",
|
|
20
|
+
"complexTypes": [],
|
|
21
|
+
"slug": "clearblockedbundles"
|
|
22
|
+
},
|
|
8
23
|
{
|
|
9
24
|
"name": "deleteBundle",
|
|
10
25
|
"signature": "(options: DeleteBundleOptions) => Promise<void>",
|
|
@@ -51,6 +66,30 @@
|
|
|
51
66
|
],
|
|
52
67
|
"slug": "downloadbundle"
|
|
53
68
|
},
|
|
69
|
+
{
|
|
70
|
+
"name": "fetchChannels",
|
|
71
|
+
"signature": "(options?: FetchChannelsOptions | undefined) => Promise<FetchChannelsResult>",
|
|
72
|
+
"parameters": [
|
|
73
|
+
{
|
|
74
|
+
"name": "options",
|
|
75
|
+
"docs": "",
|
|
76
|
+
"type": "FetchChannelsOptions | undefined"
|
|
77
|
+
}
|
|
78
|
+
],
|
|
79
|
+
"returns": "Promise<FetchChannelsResult>",
|
|
80
|
+
"tags": [
|
|
81
|
+
{
|
|
82
|
+
"name": "since",
|
|
83
|
+
"text": "6.9.0"
|
|
84
|
+
}
|
|
85
|
+
],
|
|
86
|
+
"docs": "Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).\n\nThis is primarily intended for development and QA purposes.\nIt allows you to retrieve a list of available channels so you can\ndynamically switch between them using `setChannel(...)`.\n\n**Attention**: Only works for apps with public channels enabled.\nIf channels are private, they can still be set using `setChannel(...)`\nbut won't be returned by this method.\n\nOnly available on Android and iOS.",
|
|
87
|
+
"complexTypes": [
|
|
88
|
+
"FetchChannelsResult",
|
|
89
|
+
"FetchChannelsOptions"
|
|
90
|
+
],
|
|
91
|
+
"slug": "fetchchannels"
|
|
92
|
+
},
|
|
54
93
|
{
|
|
55
94
|
"name": "fetchLatestBundle",
|
|
56
95
|
"signature": "(options?: FetchLatestBundleOptions | undefined) => Promise<FetchLatestBundleResult>",
|
|
@@ -75,6 +114,23 @@
|
|
|
75
114
|
],
|
|
76
115
|
"slug": "fetchlatestbundle"
|
|
77
116
|
},
|
|
117
|
+
{
|
|
118
|
+
"name": "getBlockedBundles",
|
|
119
|
+
"signature": "() => Promise<GetBlockedBundlesResult>",
|
|
120
|
+
"parameters": [],
|
|
121
|
+
"returns": "Promise<GetBlockedBundlesResult>",
|
|
122
|
+
"tags": [
|
|
123
|
+
{
|
|
124
|
+
"name": "since",
|
|
125
|
+
"text": "6.9.0"
|
|
126
|
+
}
|
|
127
|
+
],
|
|
128
|
+
"docs": "Get all blocked bundle identifiers.\n\nReturns the list of bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android and iOS.",
|
|
129
|
+
"complexTypes": [
|
|
130
|
+
"GetBlockedBundlesResult"
|
|
131
|
+
],
|
|
132
|
+
"slug": "getblockedbundles"
|
|
133
|
+
},
|
|
78
134
|
{
|
|
79
135
|
"name": "getBundle",
|
|
80
136
|
"signature": "() => Promise<GetBundleResult>",
|
|
@@ -105,6 +161,10 @@
|
|
|
105
161
|
{
|
|
106
162
|
"name": "since",
|
|
107
163
|
"text": "5.0.0"
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"name": "deprecated",
|
|
167
|
+
"text": "Use `getDownloadedBundles()` instead."
|
|
108
168
|
}
|
|
109
169
|
],
|
|
110
170
|
"docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android and iOS.",
|
|
@@ -124,12 +184,29 @@
|
|
|
124
184
|
"text": "5.0.0"
|
|
125
185
|
}
|
|
126
186
|
],
|
|
127
|
-
"docs": "Get the channel that is used for the update.\n\nOnly available on Android and iOS.",
|
|
187
|
+
"docs": "Get the channel that is used for the update.\n\nThe channel is resolved in the following order (highest priority first):\n1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)\n2. Capacitor config `defaultChannel`\n3. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or\n `capawesome_live_update_default_channel` in `strings.xml` on Android)\n\n**Note**: The `channel` parameter of `sync()` takes the highest priority\nbut is not persisted and therefore not returned by this method.\n\nOnly available on Android and iOS.",
|
|
128
188
|
"complexTypes": [
|
|
129
189
|
"GetChannelResult"
|
|
130
190
|
],
|
|
131
191
|
"slug": "getchannel"
|
|
132
192
|
},
|
|
193
|
+
{
|
|
194
|
+
"name": "getConfig",
|
|
195
|
+
"signature": "() => Promise<GetConfigResult>",
|
|
196
|
+
"parameters": [],
|
|
197
|
+
"returns": "Promise<GetConfigResult>",
|
|
198
|
+
"tags": [
|
|
199
|
+
{
|
|
200
|
+
"name": "since",
|
|
201
|
+
"text": "6.9.0"
|
|
202
|
+
}
|
|
203
|
+
],
|
|
204
|
+
"docs": "Get the runtime configuration.\n\nReturns the current plugin configuration including any runtime\noverrides set via `setConfig()`.\n\nOnly available on Android and iOS.",
|
|
205
|
+
"complexTypes": [
|
|
206
|
+
"GetConfigResult"
|
|
207
|
+
],
|
|
208
|
+
"slug": "getconfig"
|
|
209
|
+
},
|
|
133
210
|
{
|
|
134
211
|
"name": "getCurrentBundle",
|
|
135
212
|
"signature": "() => Promise<GetCurrentBundleResult>",
|
|
@@ -181,6 +258,23 @@
|
|
|
181
258
|
],
|
|
182
259
|
"slug": "getdeviceid"
|
|
183
260
|
},
|
|
261
|
+
{
|
|
262
|
+
"name": "getDownloadedBundles",
|
|
263
|
+
"signature": "() => Promise<GetDownloadedBundlesResult>",
|
|
264
|
+
"parameters": [],
|
|
265
|
+
"returns": "Promise<GetDownloadedBundlesResult>",
|
|
266
|
+
"tags": [
|
|
267
|
+
{
|
|
268
|
+
"name": "since",
|
|
269
|
+
"text": "6.9.0"
|
|
270
|
+
}
|
|
271
|
+
],
|
|
272
|
+
"docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android and iOS.",
|
|
273
|
+
"complexTypes": [
|
|
274
|
+
"GetDownloadedBundlesResult"
|
|
275
|
+
],
|
|
276
|
+
"slug": "getdownloadedbundles"
|
|
277
|
+
},
|
|
184
278
|
{
|
|
185
279
|
"name": "getNextBundle",
|
|
186
280
|
"signature": "() => Promise<GetNextBundleResult>",
|
|
@@ -232,11 +326,28 @@
|
|
|
232
326
|
],
|
|
233
327
|
"slug": "getversionname"
|
|
234
328
|
},
|
|
329
|
+
{
|
|
330
|
+
"name": "isSyncing",
|
|
331
|
+
"signature": "() => Promise<IsSyncingResult>",
|
|
332
|
+
"parameters": [],
|
|
333
|
+
"returns": "Promise<IsSyncingResult>",
|
|
334
|
+
"tags": [
|
|
335
|
+
{
|
|
336
|
+
"name": "since",
|
|
337
|
+
"text": "6.9.0"
|
|
338
|
+
}
|
|
339
|
+
],
|
|
340
|
+
"docs": "Check whether a sync operation is currently in progress.\n\nOnly available on Android and iOS.",
|
|
341
|
+
"complexTypes": [
|
|
342
|
+
"IsSyncingResult"
|
|
343
|
+
],
|
|
344
|
+
"slug": "issyncing"
|
|
345
|
+
},
|
|
235
346
|
{
|
|
236
347
|
"name": "ready",
|
|
237
|
-
"signature": "() => Promise<
|
|
348
|
+
"signature": "() => Promise<ReadyResult>",
|
|
238
349
|
"parameters": [],
|
|
239
|
-
"returns": "Promise<
|
|
350
|
+
"returns": "Promise<ReadyResult>",
|
|
240
351
|
"tags": [
|
|
241
352
|
{
|
|
242
353
|
"name": "since",
|
|
@@ -244,7 +355,9 @@
|
|
|
244
355
|
}
|
|
245
356
|
],
|
|
246
357
|
"docs": "Notify the plugin that the app is ready to use and no rollback is needed.\n\n**Attention**: This method should be called as soon as the app is ready to use\nto prevent the app from being reset to the default bundle.\n\nOnly available on Android and iOS.",
|
|
247
|
-
"complexTypes": [
|
|
358
|
+
"complexTypes": [
|
|
359
|
+
"ReadyResult"
|
|
360
|
+
],
|
|
248
361
|
"slug": "ready"
|
|
249
362
|
},
|
|
250
363
|
{
|
|
@@ -277,6 +390,21 @@
|
|
|
277
390
|
"complexTypes": [],
|
|
278
391
|
"slug": "reset"
|
|
279
392
|
},
|
|
393
|
+
{
|
|
394
|
+
"name": "resetConfig",
|
|
395
|
+
"signature": "() => Promise<void>",
|
|
396
|
+
"parameters": [],
|
|
397
|
+
"returns": "Promise<void>",
|
|
398
|
+
"tags": [
|
|
399
|
+
{
|
|
400
|
+
"name": "since",
|
|
401
|
+
"text": "6.9.0"
|
|
402
|
+
}
|
|
403
|
+
],
|
|
404
|
+
"docs": "Reset the runtime configuration to the values from the Capacitor config file.\n\nThis clears any runtime configuration set via `setConfig()`.\nThe changes take effect immediately.\n\nOnly available on Android and iOS.",
|
|
405
|
+
"complexTypes": [],
|
|
406
|
+
"slug": "resetconfig"
|
|
407
|
+
},
|
|
280
408
|
{
|
|
281
409
|
"name": "setBundle",
|
|
282
410
|
"signature": "(options: SetBundleOptions) => Promise<void>",
|
|
@@ -327,6 +455,29 @@
|
|
|
327
455
|
],
|
|
328
456
|
"slug": "setchannel"
|
|
329
457
|
},
|
|
458
|
+
{
|
|
459
|
+
"name": "setConfig",
|
|
460
|
+
"signature": "(options: SetConfigOptions) => Promise<void>",
|
|
461
|
+
"parameters": [
|
|
462
|
+
{
|
|
463
|
+
"name": "options",
|
|
464
|
+
"docs": "",
|
|
465
|
+
"type": "SetConfigOptions"
|
|
466
|
+
}
|
|
467
|
+
],
|
|
468
|
+
"returns": "Promise<void>",
|
|
469
|
+
"tags": [
|
|
470
|
+
{
|
|
471
|
+
"name": "since",
|
|
472
|
+
"text": "6.9.0"
|
|
473
|
+
}
|
|
474
|
+
],
|
|
475
|
+
"docs": "Set the runtime configuration.\n\nThis allows updating plugin configuration options at runtime.\nThe changes are persisted across app restarts and take effect immediately.\n\n**Important:** Runtime configuration is automatically reset to default values\nwhenever the native app is updated to a new version. This ensures that\nconfiguration from previous versions doesn't persist after an app update.\n\nOnly available on Android and iOS.",
|
|
476
|
+
"complexTypes": [
|
|
477
|
+
"SetConfigOptions"
|
|
478
|
+
],
|
|
479
|
+
"slug": "setconfig"
|
|
480
|
+
},
|
|
330
481
|
{
|
|
331
482
|
"name": "setCustomId",
|
|
332
483
|
"signature": "(options: SetCustomIdOptions) => Promise<void>",
|
|
@@ -396,6 +547,108 @@
|
|
|
396
547
|
"SyncOptions"
|
|
397
548
|
],
|
|
398
549
|
"slug": "sync"
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"name": "addListener",
|
|
553
|
+
"signature": "(eventName: 'downloadBundleProgress', listenerFunc: DownloadBundleProgressListener) => Promise<PluginListenerHandle>",
|
|
554
|
+
"parameters": [
|
|
555
|
+
{
|
|
556
|
+
"name": "eventName",
|
|
557
|
+
"docs": "",
|
|
558
|
+
"type": "'downloadBundleProgress'"
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"name": "listenerFunc",
|
|
562
|
+
"docs": "",
|
|
563
|
+
"type": "DownloadBundleProgressListener"
|
|
564
|
+
}
|
|
565
|
+
],
|
|
566
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
567
|
+
"tags": [
|
|
568
|
+
{
|
|
569
|
+
"name": "since",
|
|
570
|
+
"text": "6.9.0"
|
|
571
|
+
}
|
|
572
|
+
],
|
|
573
|
+
"docs": "Listen for the download progress of a bundle.\n\nOnly available on Android and iOS.",
|
|
574
|
+
"complexTypes": [
|
|
575
|
+
"PluginListenerHandle",
|
|
576
|
+
"DownloadBundleProgressListener"
|
|
577
|
+
],
|
|
578
|
+
"slug": "addlistenerdownloadbundleprogress-"
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"name": "addListener",
|
|
582
|
+
"signature": "(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener) => Promise<PluginListenerHandle>",
|
|
583
|
+
"parameters": [
|
|
584
|
+
{
|
|
585
|
+
"name": "eventName",
|
|
586
|
+
"docs": "",
|
|
587
|
+
"type": "'nextBundleSet'"
|
|
588
|
+
},
|
|
589
|
+
{
|
|
590
|
+
"name": "listenerFunc",
|
|
591
|
+
"docs": "",
|
|
592
|
+
"type": "NextBundleSetListener"
|
|
593
|
+
}
|
|
594
|
+
],
|
|
595
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
596
|
+
"tags": [
|
|
597
|
+
{
|
|
598
|
+
"name": "since",
|
|
599
|
+
"text": "6.9.0"
|
|
600
|
+
}
|
|
601
|
+
],
|
|
602
|
+
"docs": "Listen for when a bundle is set as the next bundle.\n\nThis event is triggered whenever a bundle is set to be used on the next app restart,\neither through automatic updates or manual calls to `setNextBundle()`.\n\nOnly available on Android and iOS.",
|
|
603
|
+
"complexTypes": [
|
|
604
|
+
"PluginListenerHandle",
|
|
605
|
+
"NextBundleSetListener"
|
|
606
|
+
],
|
|
607
|
+
"slug": "addlistenernextbundleset-"
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"name": "addListener",
|
|
611
|
+
"signature": "(eventName: 'reloaded', listenerFunc: ReloadedListener) => Promise<PluginListenerHandle>",
|
|
612
|
+
"parameters": [
|
|
613
|
+
{
|
|
614
|
+
"name": "eventName",
|
|
615
|
+
"docs": "",
|
|
616
|
+
"type": "'reloaded'"
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
"name": "listenerFunc",
|
|
620
|
+
"docs": "",
|
|
621
|
+
"type": "ReloadedListener"
|
|
622
|
+
}
|
|
623
|
+
],
|
|
624
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
625
|
+
"tags": [
|
|
626
|
+
{
|
|
627
|
+
"name": "since",
|
|
628
|
+
"text": "6.9.0"
|
|
629
|
+
}
|
|
630
|
+
],
|
|
631
|
+
"docs": "Listen for when the app is reloaded.\n\nThis event is triggered after the `reload()` method is called\nand the app has been reloaded.\n\n**Note:** To verify whether an update was successfully applied after a reload,\nuse the `ready()` method instead. The `ready()` method provides detailed information\nabout the current bundle, previous bundle, and whether a rollback occurred.\n\nOnly available on Android and iOS.",
|
|
632
|
+
"complexTypes": [
|
|
633
|
+
"PluginListenerHandle",
|
|
634
|
+
"ReloadedListener"
|
|
635
|
+
],
|
|
636
|
+
"slug": "addlistenerreloaded-"
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "removeAllListeners",
|
|
640
|
+
"signature": "() => Promise<void>",
|
|
641
|
+
"parameters": [],
|
|
642
|
+
"returns": "Promise<void>",
|
|
643
|
+
"tags": [
|
|
644
|
+
{
|
|
645
|
+
"name": "since",
|
|
646
|
+
"text": "6.9.0"
|
|
647
|
+
}
|
|
648
|
+
],
|
|
649
|
+
"docs": "Remove all listeners for this plugin.",
|
|
650
|
+
"complexTypes": [],
|
|
651
|
+
"slug": "removealllisteners"
|
|
399
652
|
}
|
|
400
653
|
],
|
|
401
654
|
"properties": []
|
|
@@ -517,128 +770,282 @@
|
|
|
517
770
|
]
|
|
518
771
|
},
|
|
519
772
|
{
|
|
520
|
-
"name": "
|
|
521
|
-
"slug": "
|
|
773
|
+
"name": "FetchChannelsResult",
|
|
774
|
+
"slug": "fetchchannelsresult",
|
|
522
775
|
"docs": "",
|
|
523
776
|
"tags": [
|
|
524
777
|
{
|
|
525
|
-
"text": "6.
|
|
778
|
+
"text": "6.9.0",
|
|
526
779
|
"name": "since"
|
|
527
780
|
}
|
|
528
781
|
],
|
|
529
782
|
"methods": [],
|
|
530
783
|
"properties": [
|
|
531
784
|
{
|
|
532
|
-
"name": "
|
|
785
|
+
"name": "channels",
|
|
533
786
|
"tags": [
|
|
534
787
|
{
|
|
535
|
-
"text": "6.
|
|
788
|
+
"text": "6.9.0",
|
|
536
789
|
"name": "since"
|
|
537
790
|
}
|
|
538
791
|
],
|
|
539
|
-
"docs": "The
|
|
540
|
-
"complexTypes": [
|
|
541
|
-
|
|
542
|
-
|
|
792
|
+
"docs": "The list of channels.",
|
|
793
|
+
"complexTypes": [
|
|
794
|
+
"Channel"
|
|
795
|
+
],
|
|
796
|
+
"type": "Channel[]"
|
|
797
|
+
}
|
|
798
|
+
]
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"name": "Channel",
|
|
802
|
+
"slug": "channel",
|
|
803
|
+
"docs": "",
|
|
804
|
+
"tags": [
|
|
543
805
|
{
|
|
544
|
-
"
|
|
806
|
+
"text": "6.9.0",
|
|
807
|
+
"name": "since"
|
|
808
|
+
}
|
|
809
|
+
],
|
|
810
|
+
"methods": [],
|
|
811
|
+
"properties": [
|
|
812
|
+
{
|
|
813
|
+
"name": "id",
|
|
545
814
|
"tags": [
|
|
546
815
|
{
|
|
547
|
-
"text": "6.
|
|
816
|
+
"text": "6.9.0",
|
|
548
817
|
"name": "since"
|
|
549
818
|
}
|
|
550
819
|
],
|
|
551
|
-
"docs": "The unique identifier of the
|
|
820
|
+
"docs": "The unique identifier of the channel.",
|
|
552
821
|
"complexTypes": [],
|
|
553
|
-
"type": "string
|
|
822
|
+
"type": "string"
|
|
554
823
|
},
|
|
555
824
|
{
|
|
556
|
-
"name": "
|
|
825
|
+
"name": "name",
|
|
557
826
|
"tags": [
|
|
558
827
|
{
|
|
559
828
|
"text": "6.9.0",
|
|
560
829
|
"name": "since"
|
|
561
830
|
}
|
|
562
831
|
],
|
|
563
|
-
"docs": "The name of the channel
|
|
832
|
+
"docs": "The name of the channel.",
|
|
564
833
|
"complexTypes": [],
|
|
565
|
-
"type": "string
|
|
566
|
-
}
|
|
834
|
+
"type": "string"
|
|
835
|
+
}
|
|
836
|
+
]
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "FetchChannelsOptions",
|
|
840
|
+
"slug": "fetchchannelsoptions",
|
|
841
|
+
"docs": "",
|
|
842
|
+
"tags": [
|
|
567
843
|
{
|
|
568
|
-
"
|
|
844
|
+
"text": "6.9.0",
|
|
845
|
+
"name": "since"
|
|
846
|
+
}
|
|
847
|
+
],
|
|
848
|
+
"methods": [],
|
|
849
|
+
"properties": [
|
|
850
|
+
{
|
|
851
|
+
"name": "limit",
|
|
569
852
|
"tags": [
|
|
570
853
|
{
|
|
571
|
-
"text": "6.
|
|
854
|
+
"text": "6.9.0",
|
|
572
855
|
"name": "since"
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
"text": "50",
|
|
859
|
+
"name": "default"
|
|
573
860
|
}
|
|
574
861
|
],
|
|
575
|
-
"docs": "The
|
|
862
|
+
"docs": "The maximum number of channels to return.",
|
|
576
863
|
"complexTypes": [],
|
|
577
|
-
"type": "
|
|
864
|
+
"type": "number | undefined"
|
|
578
865
|
},
|
|
579
866
|
{
|
|
580
|
-
"name": "
|
|
867
|
+
"name": "offset",
|
|
581
868
|
"tags": [
|
|
582
869
|
{
|
|
583
|
-
"text": "6.
|
|
870
|
+
"text": "6.9.0",
|
|
584
871
|
"name": "since"
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"text": "0",
|
|
875
|
+
"name": "default"
|
|
585
876
|
}
|
|
586
877
|
],
|
|
587
|
-
"docs": "The
|
|
878
|
+
"docs": "The number of channels to skip.",
|
|
588
879
|
"complexTypes": [],
|
|
589
|
-
"type": "
|
|
880
|
+
"type": "number | undefined"
|
|
590
881
|
},
|
|
591
882
|
{
|
|
592
|
-
"name": "
|
|
883
|
+
"name": "query",
|
|
593
884
|
"tags": [
|
|
594
885
|
{
|
|
595
|
-
"text": "6.
|
|
886
|
+
"text": "6.9.0",
|
|
596
887
|
"name": "since"
|
|
597
888
|
}
|
|
598
889
|
],
|
|
599
|
-
"docs": "The
|
|
890
|
+
"docs": "The query to filter channels by name.",
|
|
600
891
|
"complexTypes": [],
|
|
601
892
|
"type": "string | undefined"
|
|
602
893
|
}
|
|
603
894
|
]
|
|
604
895
|
},
|
|
605
896
|
{
|
|
606
|
-
"name": "
|
|
607
|
-
"slug": "
|
|
897
|
+
"name": "FetchLatestBundleResult",
|
|
898
|
+
"slug": "fetchlatestbundleresult",
|
|
608
899
|
"docs": "",
|
|
609
900
|
"tags": [
|
|
610
901
|
{
|
|
611
|
-
"text": "6.
|
|
902
|
+
"text": "6.6.0",
|
|
612
903
|
"name": "since"
|
|
613
904
|
}
|
|
614
905
|
],
|
|
615
906
|
"methods": [],
|
|
616
907
|
"properties": [
|
|
617
908
|
{
|
|
618
|
-
"name": "
|
|
909
|
+
"name": "artifactType",
|
|
619
910
|
"tags": [
|
|
620
911
|
{
|
|
621
912
|
"text": "6.7.0",
|
|
622
913
|
"name": "since"
|
|
623
914
|
}
|
|
624
915
|
],
|
|
625
|
-
"docs": "The
|
|
916
|
+
"docs": "The artifact type of the bundle.",
|
|
626
917
|
"complexTypes": [],
|
|
627
|
-
"type": "
|
|
628
|
-
}
|
|
629
|
-
]
|
|
630
|
-
},
|
|
631
|
-
{
|
|
632
|
-
"name": "GetBundleResult",
|
|
633
|
-
"slug": "getbundleresult",
|
|
634
|
-
"docs": "",
|
|
635
|
-
"tags": [
|
|
918
|
+
"type": "'manifest' | 'zip' | undefined"
|
|
919
|
+
},
|
|
636
920
|
{
|
|
637
|
-
"
|
|
638
|
-
"
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
921
|
+
"name": "bundleId",
|
|
922
|
+
"tags": [
|
|
923
|
+
{
|
|
924
|
+
"text": "6.6.0",
|
|
925
|
+
"name": "since"
|
|
926
|
+
}
|
|
927
|
+
],
|
|
928
|
+
"docs": "The unique identifier of the latest bundle.\n\nIf `null`, no bundle is available.",
|
|
929
|
+
"complexTypes": [],
|
|
930
|
+
"type": "string | null"
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"name": "checksum",
|
|
934
|
+
"tags": [
|
|
935
|
+
{
|
|
936
|
+
"text": "6.8.0",
|
|
937
|
+
"name": "since"
|
|
938
|
+
}
|
|
939
|
+
],
|
|
940
|
+
"docs": "The checksum of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the checksum will be\nreturned as response header when downloading the bundle.",
|
|
941
|
+
"complexTypes": [],
|
|
942
|
+
"type": "string | undefined"
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
"name": "customProperties",
|
|
946
|
+
"tags": [
|
|
947
|
+
{
|
|
948
|
+
"text": "6.9.0",
|
|
949
|
+
"name": "since"
|
|
950
|
+
},
|
|
951
|
+
{
|
|
952
|
+
"text": "{ \"key\": \"value\" }",
|
|
953
|
+
"name": "example"
|
|
954
|
+
}
|
|
955
|
+
],
|
|
956
|
+
"docs": "Custom properties that are associated with the latest bundle.",
|
|
957
|
+
"complexTypes": [],
|
|
958
|
+
"type": "{ [key: string]: string; } | undefined"
|
|
959
|
+
},
|
|
960
|
+
{
|
|
961
|
+
"name": "downloadUrl",
|
|
962
|
+
"tags": [
|
|
963
|
+
{
|
|
964
|
+
"text": "6.7.0",
|
|
965
|
+
"name": "since"
|
|
966
|
+
}
|
|
967
|
+
],
|
|
968
|
+
"docs": "The URL of the latest bundle to download.\nPass this URL to the `downloadBundle(...)` method to download the bundle.",
|
|
969
|
+
"complexTypes": [],
|
|
970
|
+
"type": "string | undefined"
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"name": "signature",
|
|
974
|
+
"tags": [
|
|
975
|
+
{
|
|
976
|
+
"text": "6.8.0",
|
|
977
|
+
"name": "since"
|
|
978
|
+
}
|
|
979
|
+
],
|
|
980
|
+
"docs": "The signature of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the signature will be\nreturned as response header when downloading the bundle.",
|
|
981
|
+
"complexTypes": [],
|
|
982
|
+
"type": "string | undefined"
|
|
983
|
+
}
|
|
984
|
+
]
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"name": "FetchLatestBundleOptions",
|
|
988
|
+
"slug": "fetchlatestbundleoptions",
|
|
989
|
+
"docs": "",
|
|
990
|
+
"tags": [
|
|
991
|
+
{
|
|
992
|
+
"text": "6.7.0",
|
|
993
|
+
"name": "since"
|
|
994
|
+
}
|
|
995
|
+
],
|
|
996
|
+
"methods": [],
|
|
997
|
+
"properties": [
|
|
998
|
+
{
|
|
999
|
+
"name": "channel",
|
|
1000
|
+
"tags": [
|
|
1001
|
+
{
|
|
1002
|
+
"text": "6.7.0",
|
|
1003
|
+
"name": "since"
|
|
1004
|
+
}
|
|
1005
|
+
],
|
|
1006
|
+
"docs": "The name of the channel where the latest bundle is fetched from.",
|
|
1007
|
+
"complexTypes": [],
|
|
1008
|
+
"type": "string | undefined"
|
|
1009
|
+
}
|
|
1010
|
+
]
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"name": "GetBlockedBundlesResult",
|
|
1014
|
+
"slug": "getblockedbundlesresult",
|
|
1015
|
+
"docs": "",
|
|
1016
|
+
"tags": [
|
|
1017
|
+
{
|
|
1018
|
+
"text": "6.9.0",
|
|
1019
|
+
"name": "since"
|
|
1020
|
+
}
|
|
1021
|
+
],
|
|
1022
|
+
"methods": [],
|
|
1023
|
+
"properties": [
|
|
1024
|
+
{
|
|
1025
|
+
"name": "bundleIds",
|
|
1026
|
+
"tags": [
|
|
1027
|
+
{
|
|
1028
|
+
"text": "6.9.0",
|
|
1029
|
+
"name": "since"
|
|
1030
|
+
}
|
|
1031
|
+
],
|
|
1032
|
+
"docs": "An array of unique identifiers of all blocked bundles.",
|
|
1033
|
+
"complexTypes": [],
|
|
1034
|
+
"type": "string[]"
|
|
1035
|
+
}
|
|
1036
|
+
]
|
|
1037
|
+
},
|
|
1038
|
+
{
|
|
1039
|
+
"name": "GetBundleResult",
|
|
1040
|
+
"slug": "getbundleresult",
|
|
1041
|
+
"docs": "",
|
|
1042
|
+
"tags": [
|
|
1043
|
+
{
|
|
1044
|
+
"text": "5.0.0",
|
|
1045
|
+
"name": "since"
|
|
1046
|
+
}
|
|
1047
|
+
],
|
|
1048
|
+
"methods": [],
|
|
642
1049
|
"properties": [
|
|
643
1050
|
{
|
|
644
1051
|
"name": "bundleId",
|
|
@@ -714,6 +1121,52 @@
|
|
|
714
1121
|
}
|
|
715
1122
|
]
|
|
716
1123
|
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "GetConfigResult",
|
|
1126
|
+
"slug": "getconfigresult",
|
|
1127
|
+
"docs": "",
|
|
1128
|
+
"tags": [
|
|
1129
|
+
{
|
|
1130
|
+
"text": "6.9.0",
|
|
1131
|
+
"name": "since"
|
|
1132
|
+
}
|
|
1133
|
+
],
|
|
1134
|
+
"methods": [],
|
|
1135
|
+
"properties": [
|
|
1136
|
+
{
|
|
1137
|
+
"name": "appId",
|
|
1138
|
+
"tags": [
|
|
1139
|
+
{
|
|
1140
|
+
"text": "6.9.0",
|
|
1141
|
+
"name": "since"
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"text": "'6e351b4f-69a7-415e-a057-4567df7ffe94'",
|
|
1145
|
+
"name": "example"
|
|
1146
|
+
}
|
|
1147
|
+
],
|
|
1148
|
+
"docs": "The app ID used to identify the app.\n\nIf `null`, no app ID is configured.",
|
|
1149
|
+
"complexTypes": [],
|
|
1150
|
+
"type": "string | null"
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"name": "autoUpdateStrategy",
|
|
1154
|
+
"tags": [
|
|
1155
|
+
{
|
|
1156
|
+
"text": "6.9.0",
|
|
1157
|
+
"name": "since"
|
|
1158
|
+
},
|
|
1159
|
+
{
|
|
1160
|
+
"text": "'background'",
|
|
1161
|
+
"name": "example"
|
|
1162
|
+
}
|
|
1163
|
+
],
|
|
1164
|
+
"docs": "The auto-update strategy for live updates.",
|
|
1165
|
+
"complexTypes": [],
|
|
1166
|
+
"type": "'none' | 'background'"
|
|
1167
|
+
}
|
|
1168
|
+
]
|
|
1169
|
+
},
|
|
717
1170
|
{
|
|
718
1171
|
"name": "GetCurrentBundleResult",
|
|
719
1172
|
"slug": "getcurrentbundleresult",
|
|
@@ -800,6 +1253,32 @@
|
|
|
800
1253
|
}
|
|
801
1254
|
]
|
|
802
1255
|
},
|
|
1256
|
+
{
|
|
1257
|
+
"name": "GetDownloadedBundlesResult",
|
|
1258
|
+
"slug": "getdownloadedbundlesresult",
|
|
1259
|
+
"docs": "",
|
|
1260
|
+
"tags": [
|
|
1261
|
+
{
|
|
1262
|
+
"text": "6.9.0",
|
|
1263
|
+
"name": "since"
|
|
1264
|
+
}
|
|
1265
|
+
],
|
|
1266
|
+
"methods": [],
|
|
1267
|
+
"properties": [
|
|
1268
|
+
{
|
|
1269
|
+
"name": "bundleIds",
|
|
1270
|
+
"tags": [
|
|
1271
|
+
{
|
|
1272
|
+
"text": "6.9.0",
|
|
1273
|
+
"name": "since"
|
|
1274
|
+
}
|
|
1275
|
+
],
|
|
1276
|
+
"docs": "An array of unique identifiers of all downloaded bundles.",
|
|
1277
|
+
"complexTypes": [],
|
|
1278
|
+
"type": "string[]"
|
|
1279
|
+
}
|
|
1280
|
+
]
|
|
1281
|
+
},
|
|
803
1282
|
{
|
|
804
1283
|
"name": "GetNextBundleResult",
|
|
805
1284
|
"slug": "getnextbundleresult",
|
|
@@ -886,6 +1365,82 @@
|
|
|
886
1365
|
}
|
|
887
1366
|
]
|
|
888
1367
|
},
|
|
1368
|
+
{
|
|
1369
|
+
"name": "IsSyncingResult",
|
|
1370
|
+
"slug": "issyncingresult",
|
|
1371
|
+
"docs": "",
|
|
1372
|
+
"tags": [
|
|
1373
|
+
{
|
|
1374
|
+
"text": "6.9.0",
|
|
1375
|
+
"name": "since"
|
|
1376
|
+
}
|
|
1377
|
+
],
|
|
1378
|
+
"methods": [],
|
|
1379
|
+
"properties": [
|
|
1380
|
+
{
|
|
1381
|
+
"name": "syncing",
|
|
1382
|
+
"tags": [
|
|
1383
|
+
{
|
|
1384
|
+
"text": "6.9.0",
|
|
1385
|
+
"name": "since"
|
|
1386
|
+
}
|
|
1387
|
+
],
|
|
1388
|
+
"docs": "Whether a sync operation is currently in progress.",
|
|
1389
|
+
"complexTypes": [],
|
|
1390
|
+
"type": "boolean"
|
|
1391
|
+
}
|
|
1392
|
+
]
|
|
1393
|
+
},
|
|
1394
|
+
{
|
|
1395
|
+
"name": "ReadyResult",
|
|
1396
|
+
"slug": "readyresult",
|
|
1397
|
+
"docs": "",
|
|
1398
|
+
"tags": [
|
|
1399
|
+
{
|
|
1400
|
+
"text": "6.9.0",
|
|
1401
|
+
"name": "since"
|
|
1402
|
+
}
|
|
1403
|
+
],
|
|
1404
|
+
"methods": [],
|
|
1405
|
+
"properties": [
|
|
1406
|
+
{
|
|
1407
|
+
"name": "previousBundleId",
|
|
1408
|
+
"tags": [
|
|
1409
|
+
{
|
|
1410
|
+
"text": "6.9.0",
|
|
1411
|
+
"name": "since"
|
|
1412
|
+
}
|
|
1413
|
+
],
|
|
1414
|
+
"docs": "The identifier of the previous bundle used.\n\nIf `null`, the default bundle was used.",
|
|
1415
|
+
"complexTypes": [],
|
|
1416
|
+
"type": "string | null"
|
|
1417
|
+
},
|
|
1418
|
+
{
|
|
1419
|
+
"name": "currentBundleId",
|
|
1420
|
+
"tags": [
|
|
1421
|
+
{
|
|
1422
|
+
"text": "6.9.0",
|
|
1423
|
+
"name": "since"
|
|
1424
|
+
}
|
|
1425
|
+
],
|
|
1426
|
+
"docs": "The identifier of the current bundle used.\n\nIf `null`, the default bundle is being used.",
|
|
1427
|
+
"complexTypes": [],
|
|
1428
|
+
"type": "string | null"
|
|
1429
|
+
},
|
|
1430
|
+
{
|
|
1431
|
+
"name": "rollback",
|
|
1432
|
+
"tags": [
|
|
1433
|
+
{
|
|
1434
|
+
"text": "6.9.0",
|
|
1435
|
+
"name": "since"
|
|
1436
|
+
}
|
|
1437
|
+
],
|
|
1438
|
+
"docs": "Whether or not the app was reset to the default bundle.",
|
|
1439
|
+
"complexTypes": [],
|
|
1440
|
+
"type": "boolean"
|
|
1441
|
+
}
|
|
1442
|
+
]
|
|
1443
|
+
},
|
|
889
1444
|
{
|
|
890
1445
|
"name": "SetBundleOptions",
|
|
891
1446
|
"slug": "setbundleoptions",
|
|
@@ -942,6 +1497,36 @@
|
|
|
942
1497
|
}
|
|
943
1498
|
]
|
|
944
1499
|
},
|
|
1500
|
+
{
|
|
1501
|
+
"name": "SetConfigOptions",
|
|
1502
|
+
"slug": "setconfigoptions",
|
|
1503
|
+
"docs": "",
|
|
1504
|
+
"tags": [
|
|
1505
|
+
{
|
|
1506
|
+
"text": "6.9.0",
|
|
1507
|
+
"name": "since"
|
|
1508
|
+
}
|
|
1509
|
+
],
|
|
1510
|
+
"methods": [],
|
|
1511
|
+
"properties": [
|
|
1512
|
+
{
|
|
1513
|
+
"name": "appId",
|
|
1514
|
+
"tags": [
|
|
1515
|
+
{
|
|
1516
|
+
"text": "6.9.0",
|
|
1517
|
+
"name": "since"
|
|
1518
|
+
},
|
|
1519
|
+
{
|
|
1520
|
+
"text": "'6e351b4f-69a7-415e-a057-4567df7ffe94'",
|
|
1521
|
+
"name": "example"
|
|
1522
|
+
}
|
|
1523
|
+
],
|
|
1524
|
+
"docs": "The app ID used to identify the app.\n\nSet `null` to reset to the value from the Capacitor config file.",
|
|
1525
|
+
"complexTypes": [],
|
|
1526
|
+
"type": "string | null | undefined"
|
|
1527
|
+
}
|
|
1528
|
+
]
|
|
1529
|
+
},
|
|
945
1530
|
{
|
|
946
1531
|
"name": "SetCustomIdOptions",
|
|
947
1532
|
"slug": "setcustomidoptions",
|
|
@@ -1044,15 +1629,165 @@
|
|
|
1044
1629
|
"name": "since"
|
|
1045
1630
|
}
|
|
1046
1631
|
],
|
|
1047
|
-
"docs": "The
|
|
1632
|
+
"docs": "The name of the channel where the latest bundle is fetched from.",
|
|
1048
1633
|
"complexTypes": [],
|
|
1049
1634
|
"type": "string | undefined"
|
|
1050
1635
|
}
|
|
1051
1636
|
]
|
|
1637
|
+
},
|
|
1638
|
+
{
|
|
1639
|
+
"name": "PluginListenerHandle",
|
|
1640
|
+
"slug": "pluginlistenerhandle",
|
|
1641
|
+
"docs": "",
|
|
1642
|
+
"tags": [],
|
|
1643
|
+
"methods": [],
|
|
1644
|
+
"properties": [
|
|
1645
|
+
{
|
|
1646
|
+
"name": "remove",
|
|
1647
|
+
"tags": [],
|
|
1648
|
+
"docs": "",
|
|
1649
|
+
"complexTypes": [],
|
|
1650
|
+
"type": "() => Promise<void>"
|
|
1651
|
+
}
|
|
1652
|
+
]
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"name": "DownloadBundleProgressEvent",
|
|
1656
|
+
"slug": "downloadbundleprogressevent",
|
|
1657
|
+
"docs": "Event that is triggered when the download progress of a bundle changes.",
|
|
1658
|
+
"tags": [
|
|
1659
|
+
{
|
|
1660
|
+
"text": "6.9.0",
|
|
1661
|
+
"name": "since"
|
|
1662
|
+
}
|
|
1663
|
+
],
|
|
1664
|
+
"methods": [],
|
|
1665
|
+
"properties": [
|
|
1666
|
+
{
|
|
1667
|
+
"name": "bundleId",
|
|
1668
|
+
"tags": [
|
|
1669
|
+
{
|
|
1670
|
+
"text": "6.9.0",
|
|
1671
|
+
"name": "since"
|
|
1672
|
+
}
|
|
1673
|
+
],
|
|
1674
|
+
"docs": "The unique identifier of the bundle that is being downloaded.",
|
|
1675
|
+
"complexTypes": [],
|
|
1676
|
+
"type": "string"
|
|
1677
|
+
},
|
|
1678
|
+
{
|
|
1679
|
+
"name": "downloadedBytes",
|
|
1680
|
+
"tags": [
|
|
1681
|
+
{
|
|
1682
|
+
"text": "6.9.0",
|
|
1683
|
+
"name": "since"
|
|
1684
|
+
}
|
|
1685
|
+
],
|
|
1686
|
+
"docs": "The number of bytes that have been downloaded.",
|
|
1687
|
+
"complexTypes": [],
|
|
1688
|
+
"type": "number"
|
|
1689
|
+
},
|
|
1690
|
+
{
|
|
1691
|
+
"name": "progress",
|
|
1692
|
+
"tags": [
|
|
1693
|
+
{
|
|
1694
|
+
"text": "6.9.0",
|
|
1695
|
+
"name": "since"
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"text": "0.5",
|
|
1699
|
+
"name": "example"
|
|
1700
|
+
}
|
|
1701
|
+
],
|
|
1702
|
+
"docs": "The progress of the download in percent as a value between `0` and `1`.",
|
|
1703
|
+
"complexTypes": [],
|
|
1704
|
+
"type": "number"
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"name": "totalBytes",
|
|
1708
|
+
"tags": [
|
|
1709
|
+
{
|
|
1710
|
+
"text": "6.9.0",
|
|
1711
|
+
"name": "since"
|
|
1712
|
+
}
|
|
1713
|
+
],
|
|
1714
|
+
"docs": "The total number of bytes to download.",
|
|
1715
|
+
"complexTypes": [],
|
|
1716
|
+
"type": "number"
|
|
1717
|
+
}
|
|
1718
|
+
]
|
|
1719
|
+
},
|
|
1720
|
+
{
|
|
1721
|
+
"name": "NextBundleSetEvent",
|
|
1722
|
+
"slug": "nextbundlesetevent",
|
|
1723
|
+
"docs": "Event that is triggered when a bundle is set as the next bundle.",
|
|
1724
|
+
"tags": [
|
|
1725
|
+
{
|
|
1726
|
+
"text": "6.9.0",
|
|
1727
|
+
"name": "since"
|
|
1728
|
+
}
|
|
1729
|
+
],
|
|
1730
|
+
"methods": [],
|
|
1731
|
+
"properties": [
|
|
1732
|
+
{
|
|
1733
|
+
"name": "bundleId",
|
|
1734
|
+
"tags": [
|
|
1735
|
+
{
|
|
1736
|
+
"text": "6.9.0",
|
|
1737
|
+
"name": "since"
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"text": "'1.0.0'",
|
|
1741
|
+
"name": "example"
|
|
1742
|
+
}
|
|
1743
|
+
],
|
|
1744
|
+
"docs": "The unique identifier of the bundle that is set as the next bundle.\n\nIf `null`, the default bundle will be used.",
|
|
1745
|
+
"complexTypes": [],
|
|
1746
|
+
"type": "string | null"
|
|
1747
|
+
}
|
|
1748
|
+
]
|
|
1052
1749
|
}
|
|
1053
1750
|
],
|
|
1054
1751
|
"enums": [],
|
|
1055
|
-
"typeAliases": [
|
|
1752
|
+
"typeAliases": [
|
|
1753
|
+
{
|
|
1754
|
+
"name": "DownloadBundleProgressListener",
|
|
1755
|
+
"slug": "downloadbundleprogresslistener",
|
|
1756
|
+
"docs": "Listener for the download progress of a bundle.",
|
|
1757
|
+
"types": [
|
|
1758
|
+
{
|
|
1759
|
+
"text": "(event: DownloadBundleProgressEvent): void",
|
|
1760
|
+
"complexTypes": [
|
|
1761
|
+
"DownloadBundleProgressEvent"
|
|
1762
|
+
]
|
|
1763
|
+
}
|
|
1764
|
+
]
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"name": "NextBundleSetListener",
|
|
1768
|
+
"slug": "nextbundlesetlistener",
|
|
1769
|
+
"docs": "Listener for when a bundle is set as the next bundle.",
|
|
1770
|
+
"types": [
|
|
1771
|
+
{
|
|
1772
|
+
"text": "(event: NextBundleSetEvent): void",
|
|
1773
|
+
"complexTypes": [
|
|
1774
|
+
"NextBundleSetEvent"
|
|
1775
|
+
]
|
|
1776
|
+
}
|
|
1777
|
+
]
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
"name": "ReloadedListener",
|
|
1781
|
+
"slug": "reloadedlistener",
|
|
1782
|
+
"docs": "Listener for when the app is reloaded.",
|
|
1783
|
+
"types": [
|
|
1784
|
+
{
|
|
1785
|
+
"text": "(): void",
|
|
1786
|
+
"complexTypes": []
|
|
1787
|
+
}
|
|
1788
|
+
]
|
|
1789
|
+
}
|
|
1790
|
+
],
|
|
1056
1791
|
"pluginConfigs": [
|
|
1057
1792
|
{
|
|
1058
1793
|
"name": "LiveUpdate",
|
|
@@ -1074,6 +1809,22 @@
|
|
|
1074
1809
|
"complexTypes": [],
|
|
1075
1810
|
"type": "string | undefined"
|
|
1076
1811
|
},
|
|
1812
|
+
{
|
|
1813
|
+
"name": "autoBlockRolledBackBundles",
|
|
1814
|
+
"tags": [
|
|
1815
|
+
{
|
|
1816
|
+
"text": "6.9.0",
|
|
1817
|
+
"name": "since"
|
|
1818
|
+
},
|
|
1819
|
+
{
|
|
1820
|
+
"text": "false",
|
|
1821
|
+
"name": "default"
|
|
1822
|
+
}
|
|
1823
|
+
],
|
|
1824
|
+
"docs": "Whether or not to automatically block bundles that have been rolled back.\n\nWhen enabled, the plugin will automatically block bundles that caused a rollback\n(up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked.\nBlocked bundles will be skipped in future sync operations.\n\n**Attention**: This option has no effect if `readyTimeout` is set to `0`.\n\nOnly available on Android and iOS.",
|
|
1825
|
+
"complexTypes": [],
|
|
1826
|
+
"type": "boolean | undefined"
|
|
1827
|
+
},
|
|
1077
1828
|
{
|
|
1078
1829
|
"name": "autoDeleteBundles",
|
|
1079
1830
|
"tags": [
|
|
@@ -1090,6 +1841,26 @@
|
|
|
1090
1841
|
"complexTypes": [],
|
|
1091
1842
|
"type": "boolean | undefined"
|
|
1092
1843
|
},
|
|
1844
|
+
{
|
|
1845
|
+
"name": "autoUpdateStrategy",
|
|
1846
|
+
"tags": [
|
|
1847
|
+
{
|
|
1848
|
+
"text": "6.9.0",
|
|
1849
|
+
"name": "since"
|
|
1850
|
+
},
|
|
1851
|
+
{
|
|
1852
|
+
"text": "'none'",
|
|
1853
|
+
"name": "default"
|
|
1854
|
+
},
|
|
1855
|
+
{
|
|
1856
|
+
"text": "'background'",
|
|
1857
|
+
"name": "example"
|
|
1858
|
+
}
|
|
1859
|
+
],
|
|
1860
|
+
"docs": "The auto-update strategy for live updates.\n\n- `none`: Live updates will not be applied automatically.\n- `background`: Live updates will be automatically downloaded\nand applied in the background at app startup and when the app resumes\n(if the last check was more than 15 minutes ago).\n\nOnly available on Android and iOS.",
|
|
1861
|
+
"complexTypes": [],
|
|
1862
|
+
"type": "'none' | 'background' | undefined"
|
|
1863
|
+
},
|
|
1093
1864
|
{
|
|
1094
1865
|
"name": "defaultChannel",
|
|
1095
1866
|
"tags": [
|
|
@@ -1102,7 +1873,7 @@
|
|
|
1102
1873
|
"name": "example"
|
|
1103
1874
|
}
|
|
1104
1875
|
],
|
|
1105
|
-
"docs": "The default channel of the app.",
|
|
1876
|
+
"docs": "The default channel of the app.\n\nThis can be overridden by `setChannel()`, the `channel` parameter of `sync()`,\nor the native channel configuration\n(`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel`\nin `strings.xml` on Android).",
|
|
1106
1877
|
"complexTypes": [],
|
|
1107
1878
|
"type": "string | undefined"
|
|
1108
1879
|
},
|
|
@@ -1209,6 +1980,26 @@
|
|
|
1209
1980
|
"docs": "Whether or not the app should be reset to the default bundle during an update.",
|
|
1210
1981
|
"complexTypes": [],
|
|
1211
1982
|
"type": "boolean | undefined"
|
|
1983
|
+
},
|
|
1984
|
+
{
|
|
1985
|
+
"name": "serverDomain",
|
|
1986
|
+
"tags": [
|
|
1987
|
+
{
|
|
1988
|
+
"text": "6.9.0",
|
|
1989
|
+
"name": "since"
|
|
1990
|
+
},
|
|
1991
|
+
{
|
|
1992
|
+
"text": "'api.cloud.capawesome.io'",
|
|
1993
|
+
"name": "default"
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"text": "'api.cloud.capawesome.eu'",
|
|
1997
|
+
"name": "example"
|
|
1998
|
+
}
|
|
1999
|
+
],
|
|
2000
|
+
"docs": "The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server **without** scheme or path.\n\nThis option takes precedence over the `location` configuration option.",
|
|
2001
|
+
"complexTypes": [],
|
|
2002
|
+
"type": "string | undefined"
|
|
1212
2003
|
}
|
|
1213
2004
|
],
|
|
1214
2005
|
"docs": ""
|