@capgo/capacitor-updater 5.0.0-alpha.0 → 7.0.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 +1 -1
- package/LICENCE +373 -661
- package/README.md +339 -75
- package/android/build.gradle +13 -12
- package/android/src/main/AndroidManifest.xml +4 -2
- package/android/src/main/java/ee/forgr/capacitor_updater/BundleInfo.java +205 -121
- package/android/src/main/java/ee/forgr/capacitor_updater/BundleStatus.java +32 -24
- package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java +1041 -441
- package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +1217 -536
- package/android/src/main/java/ee/forgr/capacitor_updater/CryptoCipher.java +153 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/DelayCondition.java +62 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/DelayUntilNext.java +14 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/DownloadService.java +126 -0
- package/dist/docs.json +727 -171
- package/dist/esm/definitions.d.ts +234 -45
- package/dist/esm/definitions.js +5 -0
- package/dist/esm/definitions.js.map +1 -1
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +9 -4
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/web.d.ts +12 -6
- package/dist/esm/web.js +64 -20
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +70 -23
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +70 -23
- package/dist/plugin.js.map +1 -1
- package/ios/Plugin/BundleInfo.swift +38 -19
- package/ios/Plugin/BundleStatus.swift +11 -4
- package/ios/Plugin/CapacitorUpdater.swift +520 -192
- package/ios/Plugin/CapacitorUpdaterPlugin.m +8 -1
- package/ios/Plugin/CapacitorUpdaterPlugin.swift +447 -190
- package/ios/Plugin/CryptoCipher.swift +240 -0
- package/ios/Plugin/DelayCondition.swift +74 -0
- package/ios/Plugin/DelayUntilNext.swift +30 -0
- package/ios/Plugin/UserDefaultsExtension.swift +48 -0
- package/package.json +26 -20
- package/ios/Plugin/ObjectPreferences.swift +0 -97
package/dist/docs.json
CHANGED
|
@@ -17,10 +17,10 @@
|
|
|
17
17
|
},
|
|
18
18
|
{
|
|
19
19
|
"name": "throws",
|
|
20
|
-
"text": "An error if
|
|
20
|
+
"text": "An error if something went wrong"
|
|
21
21
|
}
|
|
22
22
|
],
|
|
23
|
-
"docs": "Notify Capacitor Updater that the current bundle is working (a rollback will occur of this method is not called on every app launch)",
|
|
23
|
+
"docs": "Notify Capacitor Updater that the current bundle is working (a rollback will occur of this method is not called on every app launch)\nBy default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur.\nChange this behaviour with {@link appReadyTimeout}",
|
|
24
24
|
"complexTypes": [
|
|
25
25
|
"BundleInfo"
|
|
26
26
|
],
|
|
@@ -28,19 +28,19 @@
|
|
|
28
28
|
},
|
|
29
29
|
{
|
|
30
30
|
"name": "download",
|
|
31
|
-
"signature": "(options: { url: string; version?: string; }) => Promise<BundleInfo>",
|
|
31
|
+
"signature": "(options: { url: string; version: string; sessionKey?: string; checksum?: string; }) => Promise<BundleInfo>",
|
|
32
32
|
"parameters": [
|
|
33
33
|
{
|
|
34
34
|
"name": "options",
|
|
35
35
|
"docs": "",
|
|
36
|
-
"type": "{ url: string; version?: string | undefined; }"
|
|
36
|
+
"type": "{ url: string; version: string; sessionKey?: string | undefined; checksum?: string | undefined; }"
|
|
37
37
|
}
|
|
38
38
|
],
|
|
39
39
|
"returns": "Promise<BundleInfo>",
|
|
40
40
|
"tags": [
|
|
41
41
|
{
|
|
42
42
|
"name": "returns",
|
|
43
|
-
"text": "The {@link BundleInfo} for the specified
|
|
43
|
+
"text": "The {@link BundleInfo} for the specified bundle."
|
|
44
44
|
},
|
|
45
45
|
{
|
|
46
46
|
"name": "param",
|
|
@@ -48,14 +48,14 @@
|
|
|
48
48
|
},
|
|
49
49
|
{
|
|
50
50
|
"name": "param",
|
|
51
|
-
"text": "version
|
|
51
|
+
"text": "version set the version code/name of this bundle/version"
|
|
52
52
|
},
|
|
53
53
|
{
|
|
54
54
|
"name": "example",
|
|
55
55
|
"text": "https://example.com/versions/{version}/dist.zip"
|
|
56
56
|
}
|
|
57
57
|
],
|
|
58
|
-
"docs": "Download a new
|
|
58
|
+
"docs": "Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files",
|
|
59
59
|
"complexTypes": [
|
|
60
60
|
"BundleInfo"
|
|
61
61
|
],
|
|
@@ -83,7 +83,7 @@
|
|
|
83
83
|
},
|
|
84
84
|
{
|
|
85
85
|
"name": "throws",
|
|
86
|
-
"text": "An error if there are is no index.html file inside the
|
|
86
|
+
"text": "An error if there are is no index.html file inside the bundle folder."
|
|
87
87
|
}
|
|
88
88
|
],
|
|
89
89
|
"docs": "Set the next bundle to be used when the app is reloaded.",
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
},
|
|
115
115
|
{
|
|
116
116
|
"name": "throws",
|
|
117
|
-
"text": "An error if there are is no index.html file inside the
|
|
117
|
+
"text": "An error if there are is no index.html file inside the bundle folder."
|
|
118
118
|
}
|
|
119
119
|
],
|
|
120
120
|
"docs": "Set the current bundle and immediately reloads the app.",
|
|
@@ -158,14 +158,14 @@
|
|
|
158
158
|
"tags": [
|
|
159
159
|
{
|
|
160
160
|
"name": "returns",
|
|
161
|
-
"text": "an Promise witht the
|
|
161
|
+
"text": "an Promise witht the bundles list"
|
|
162
162
|
},
|
|
163
163
|
{
|
|
164
164
|
"name": "throws",
|
|
165
165
|
"text": "An error if the something went wrong"
|
|
166
166
|
}
|
|
167
167
|
],
|
|
168
|
-
"docs": "Get all available
|
|
168
|
+
"docs": "Get all available bundles",
|
|
169
169
|
"complexTypes": [
|
|
170
170
|
"BundleInfo"
|
|
171
171
|
],
|
|
@@ -196,7 +196,7 @@
|
|
|
196
196
|
"text": "An error if the something went wrong"
|
|
197
197
|
}
|
|
198
198
|
],
|
|
199
|
-
"docs": "Set the `builtin`
|
|
199
|
+
"docs": "Set the `builtin` bundle (the one sent to Apple store / Google play store ) as current bundle",
|
|
200
200
|
"complexTypes": [],
|
|
201
201
|
"slug": "reset"
|
|
202
202
|
},
|
|
@@ -241,15 +241,56 @@
|
|
|
241
241
|
"slug": "reload"
|
|
242
242
|
},
|
|
243
243
|
{
|
|
244
|
-
"name": "
|
|
245
|
-
"signature": "(options: {
|
|
244
|
+
"name": "setMultiDelay",
|
|
245
|
+
"signature": "(options: { delayConditions: DelayCondition[]; }) => Promise<void>",
|
|
246
246
|
"parameters": [
|
|
247
247
|
{
|
|
248
248
|
"name": "options",
|
|
249
|
-
"docs": "",
|
|
250
|
-
"type": "{
|
|
249
|
+
"docs": "are the {@link DelayCondition} list to set",
|
|
250
|
+
"type": "{ delayConditions: DelayCondition[]; }"
|
|
251
|
+
}
|
|
252
|
+
],
|
|
253
|
+
"returns": "Promise<void>",
|
|
254
|
+
"tags": [
|
|
255
|
+
{
|
|
256
|
+
"name": "returns",
|
|
257
|
+
"text": "an Promise resolved directly"
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"name": "param",
|
|
261
|
+
"text": "options are the {@link DelayCondition} list to set"
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
"name": "example",
|
|
265
|
+
"text": "setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })\n// installs the update after the user kills the app or after a background of 300000 ms (5 minutes)"
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"name": "example",
|
|
269
|
+
"text": "setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })\n// installs the update after the specific iso8601 date is expired"
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"name": "example",
|
|
273
|
+
"text": "setMultiDelay({ delayConditions: [{ kind: 'background' }] })\n// installs the update after the the first background (default behaviour without setting delay)"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "throws",
|
|
277
|
+
"text": "An error if the something went wrong"
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"name": "since",
|
|
281
|
+
"text": "4.3.0"
|
|
251
282
|
}
|
|
252
283
|
],
|
|
284
|
+
"docs": "Set DelayCondition, skip updates until one of the conditions is met",
|
|
285
|
+
"complexTypes": [
|
|
286
|
+
"DelayCondition"
|
|
287
|
+
],
|
|
288
|
+
"slug": "setmultidelay"
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
"name": "cancelDelay",
|
|
292
|
+
"signature": "() => Promise<void>",
|
|
293
|
+
"parameters": [],
|
|
253
294
|
"returns": "Promise<void>",
|
|
254
295
|
"tags": [
|
|
255
296
|
{
|
|
@@ -259,15 +300,140 @@
|
|
|
259
300
|
{
|
|
260
301
|
"name": "throws",
|
|
261
302
|
"text": "An error if the something went wrong"
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"name": "since",
|
|
306
|
+
"text": "4.0.0"
|
|
262
307
|
}
|
|
263
308
|
],
|
|
264
|
-
"docs": "
|
|
309
|
+
"docs": "Cancel delay to updates as usual",
|
|
265
310
|
"complexTypes": [],
|
|
266
|
-
"slug": "
|
|
311
|
+
"slug": "canceldelay"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "getLatest",
|
|
315
|
+
"signature": "() => Promise<latestVersion>",
|
|
316
|
+
"parameters": [],
|
|
317
|
+
"returns": "Promise<latestVersion>",
|
|
318
|
+
"tags": [
|
|
319
|
+
{
|
|
320
|
+
"name": "returns",
|
|
321
|
+
"text": "an Promise resolved when url is loaded"
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "throws",
|
|
325
|
+
"text": "An error if the something went wrong"
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"name": "since",
|
|
329
|
+
"text": "4.0.0"
|
|
330
|
+
}
|
|
331
|
+
],
|
|
332
|
+
"docs": "Get Latest bundle available from update Url",
|
|
333
|
+
"complexTypes": [
|
|
334
|
+
"latestVersion"
|
|
335
|
+
],
|
|
336
|
+
"slug": "getlatest"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"name": "setChannel",
|
|
340
|
+
"signature": "(options: SetChannelOptions) => Promise<channelRes>",
|
|
341
|
+
"parameters": [
|
|
342
|
+
{
|
|
343
|
+
"name": "options",
|
|
344
|
+
"docs": "is the {@link SetChannelOptions} channel to set",
|
|
345
|
+
"type": "SetChannelOptions"
|
|
346
|
+
}
|
|
347
|
+
],
|
|
348
|
+
"returns": "Promise<channelRes>",
|
|
349
|
+
"tags": [
|
|
350
|
+
{
|
|
351
|
+
"name": "returns",
|
|
352
|
+
"text": "an Promise resolved when channel is set"
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
"name": "param",
|
|
356
|
+
"text": "options is the {@link SetChannelOptions} channel to set"
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "throws",
|
|
360
|
+
"text": "An error if the something went wrong"
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"name": "since",
|
|
364
|
+
"text": "4.7.0"
|
|
365
|
+
}
|
|
366
|
+
],
|
|
367
|
+
"docs": "Set Channel for this device",
|
|
368
|
+
"complexTypes": [
|
|
369
|
+
"channelRes",
|
|
370
|
+
"SetChannelOptions"
|
|
371
|
+
],
|
|
372
|
+
"slug": "setchannel"
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "getChannel",
|
|
376
|
+
"signature": "() => Promise<getChannelRes>",
|
|
377
|
+
"parameters": [],
|
|
378
|
+
"returns": "Promise<getChannelRes>",
|
|
379
|
+
"tags": [
|
|
380
|
+
{
|
|
381
|
+
"name": "returns",
|
|
382
|
+
"text": "an Promise resolved with channel info"
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"name": "throws",
|
|
386
|
+
"text": "An error if the something went wrong"
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "since",
|
|
390
|
+
"text": "4.8.0"
|
|
391
|
+
}
|
|
392
|
+
],
|
|
393
|
+
"docs": "get Channel for this device",
|
|
394
|
+
"complexTypes": [
|
|
395
|
+
"getChannelRes"
|
|
396
|
+
],
|
|
397
|
+
"slug": "getchannel"
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
"name": "setCustomId",
|
|
401
|
+
"signature": "(options: SetCustomIdOptions) => Promise<void>",
|
|
402
|
+
"parameters": [
|
|
403
|
+
{
|
|
404
|
+
"name": "options",
|
|
405
|
+
"docs": "is the {@link SetCustomIdOptions} customId to set",
|
|
406
|
+
"type": "SetCustomIdOptions"
|
|
407
|
+
}
|
|
408
|
+
],
|
|
409
|
+
"returns": "Promise<void>",
|
|
410
|
+
"tags": [
|
|
411
|
+
{
|
|
412
|
+
"name": "returns",
|
|
413
|
+
"text": "an Promise resolved instantly"
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"name": "param",
|
|
417
|
+
"text": "options is the {@link SetCustomIdOptions} customId to set"
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"name": "throws",
|
|
421
|
+
"text": "An error if the something went wrong"
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "since",
|
|
425
|
+
"text": "4.9.0"
|
|
426
|
+
}
|
|
427
|
+
],
|
|
428
|
+
"docs": "Set Channel for this device",
|
|
429
|
+
"complexTypes": [
|
|
430
|
+
"SetCustomIdOptions"
|
|
431
|
+
],
|
|
432
|
+
"slug": "setcustomid"
|
|
267
433
|
},
|
|
268
434
|
{
|
|
269
435
|
"name": "addListener",
|
|
270
|
-
"signature": "(eventName:
|
|
436
|
+
"signature": "(eventName: \"download\", listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
271
437
|
"parameters": [
|
|
272
438
|
{
|
|
273
439
|
"name": "eventName",
|
|
@@ -296,7 +462,65 @@
|
|
|
296
462
|
},
|
|
297
463
|
{
|
|
298
464
|
"name": "addListener",
|
|
299
|
-
"signature": "(eventName:
|
|
465
|
+
"signature": "(eventName: \"noNeedUpdate\", listenerFunc: NoNeedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
466
|
+
"parameters": [
|
|
467
|
+
{
|
|
468
|
+
"name": "eventName",
|
|
469
|
+
"docs": "",
|
|
470
|
+
"type": "'noNeedUpdate'"
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "listenerFunc",
|
|
474
|
+
"docs": "",
|
|
475
|
+
"type": "NoNeedListener"
|
|
476
|
+
}
|
|
477
|
+
],
|
|
478
|
+
"returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
479
|
+
"tags": [
|
|
480
|
+
{
|
|
481
|
+
"name": "since",
|
|
482
|
+
"text": "4.0.0"
|
|
483
|
+
}
|
|
484
|
+
],
|
|
485
|
+
"docs": "Listen for no need to update event, usefull when you want force check every time the app is launched",
|
|
486
|
+
"complexTypes": [
|
|
487
|
+
"PluginListenerHandle",
|
|
488
|
+
"NoNeedListener"
|
|
489
|
+
],
|
|
490
|
+
"slug": "addlistenernoneedupdate"
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
"name": "addListener",
|
|
494
|
+
"signature": "(eventName: \"updateAvailable\", listenerFunc: UpdateAvailabledListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
495
|
+
"parameters": [
|
|
496
|
+
{
|
|
497
|
+
"name": "eventName",
|
|
498
|
+
"docs": "",
|
|
499
|
+
"type": "'updateAvailable'"
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"name": "listenerFunc",
|
|
503
|
+
"docs": "",
|
|
504
|
+
"type": "UpdateAvailabledListener"
|
|
505
|
+
}
|
|
506
|
+
],
|
|
507
|
+
"returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
508
|
+
"tags": [
|
|
509
|
+
{
|
|
510
|
+
"name": "since",
|
|
511
|
+
"text": "4.0.0"
|
|
512
|
+
}
|
|
513
|
+
],
|
|
514
|
+
"docs": "Listen for availbale update event, usefull when you want to force check every time the app is launched",
|
|
515
|
+
"complexTypes": [
|
|
516
|
+
"PluginListenerHandle",
|
|
517
|
+
"UpdateAvailabledListener"
|
|
518
|
+
],
|
|
519
|
+
"slug": "addlistenerupdateavailable"
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "addListener",
|
|
523
|
+
"signature": "(eventName: \"downloadComplete\", listenerFunc: DownloadCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
300
524
|
"parameters": [
|
|
301
525
|
{
|
|
302
526
|
"name": "eventName",
|
|
@@ -325,7 +549,7 @@
|
|
|
325
549
|
},
|
|
326
550
|
{
|
|
327
551
|
"name": "addListener",
|
|
328
|
-
"signature": "(eventName:
|
|
552
|
+
"signature": "(eventName: \"majorAvailable\", listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
329
553
|
"parameters": [
|
|
330
554
|
{
|
|
331
555
|
"name": "eventName",
|
|
@@ -354,7 +578,7 @@
|
|
|
354
578
|
},
|
|
355
579
|
{
|
|
356
580
|
"name": "addListener",
|
|
357
|
-
"signature": "(eventName:
|
|
581
|
+
"signature": "(eventName: \"updateFailed\", listenerFunc: UpdateFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
358
582
|
"parameters": [
|
|
359
583
|
{
|
|
360
584
|
"name": "eventName",
|
|
@@ -374,7 +598,7 @@
|
|
|
374
598
|
"text": "2.3.0"
|
|
375
599
|
}
|
|
376
600
|
],
|
|
377
|
-
"docs": "Listen for update event in the App, let you know when update
|
|
601
|
+
"docs": "Listen for update fail event in the App, let you know when update has fail to install at next app start",
|
|
378
602
|
"complexTypes": [
|
|
379
603
|
"PluginListenerHandle",
|
|
380
604
|
"UpdateFailedListener"
|
|
@@ -382,10 +606,68 @@
|
|
|
382
606
|
"slug": "addlistenerupdatefailed"
|
|
383
607
|
},
|
|
384
608
|
{
|
|
385
|
-
"name": "
|
|
386
|
-
"signature": "() => Promise<
|
|
609
|
+
"name": "addListener",
|
|
610
|
+
"signature": "(eventName: \"downloadFailed\", listenerFunc: DownloadFailedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
611
|
+
"parameters": [
|
|
612
|
+
{
|
|
613
|
+
"name": "eventName",
|
|
614
|
+
"docs": "",
|
|
615
|
+
"type": "'downloadFailed'"
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
"name": "listenerFunc",
|
|
619
|
+
"docs": "",
|
|
620
|
+
"type": "DownloadFailedListener"
|
|
621
|
+
}
|
|
622
|
+
],
|
|
623
|
+
"returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
624
|
+
"tags": [
|
|
625
|
+
{
|
|
626
|
+
"name": "since",
|
|
627
|
+
"text": "4.0.0"
|
|
628
|
+
}
|
|
629
|
+
],
|
|
630
|
+
"docs": "Listen for download fail event in the App, let you know when download has fail finished",
|
|
631
|
+
"complexTypes": [
|
|
632
|
+
"PluginListenerHandle",
|
|
633
|
+
"DownloadFailedListener"
|
|
634
|
+
],
|
|
635
|
+
"slug": "addlistenerdownloadfailed"
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "addListener",
|
|
639
|
+
"signature": "(eventName: \"appReloaded\", listenerFunc: AppReloadedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
640
|
+
"parameters": [
|
|
641
|
+
{
|
|
642
|
+
"name": "eventName",
|
|
643
|
+
"docs": "",
|
|
644
|
+
"type": "'appReloaded'"
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
"name": "listenerFunc",
|
|
648
|
+
"docs": "",
|
|
649
|
+
"type": "AppReloadedListener"
|
|
650
|
+
}
|
|
651
|
+
],
|
|
652
|
+
"returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
|
|
653
|
+
"tags": [
|
|
654
|
+
{
|
|
655
|
+
"name": "since",
|
|
656
|
+
"text": "4.3.0"
|
|
657
|
+
}
|
|
658
|
+
],
|
|
659
|
+
"docs": "Listen for download fail event in the App, let you know when download has fail finished",
|
|
660
|
+
"complexTypes": [
|
|
661
|
+
"PluginListenerHandle",
|
|
662
|
+
"AppReloadedListener"
|
|
663
|
+
],
|
|
664
|
+
"slug": "addlistenerappreloaded"
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"name": "getDeviceId",
|
|
668
|
+
"signature": "() => Promise<{ deviceId: string; }>",
|
|
387
669
|
"parameters": [],
|
|
388
|
-
"returns": "Promise<{
|
|
670
|
+
"returns": "Promise<{ deviceId: string; }>",
|
|
389
671
|
"tags": [
|
|
390
672
|
{
|
|
391
673
|
"name": "returns",
|
|
@@ -398,7 +680,7 @@
|
|
|
398
680
|
],
|
|
399
681
|
"docs": "Get unique ID used to identify device (sent to auto update server)",
|
|
400
682
|
"complexTypes": [],
|
|
401
|
-
"slug": "
|
|
683
|
+
"slug": "getdeviceid"
|
|
402
684
|
},
|
|
403
685
|
{
|
|
404
686
|
"name": "getPluginVersion",
|
|
@@ -438,55 +720,23 @@
|
|
|
438
720
|
"complexTypes": [],
|
|
439
721
|
"slug": "isautoupdateenabled"
|
|
440
722
|
},
|
|
441
|
-
{
|
|
442
|
-
"name": "addListener",
|
|
443
|
-
"signature": "(eventName: string, listenerFunc: (...args: any[]) => any) => Promise<PluginListenerHandle>",
|
|
444
|
-
"parameters": [
|
|
445
|
-
{
|
|
446
|
-
"name": "eventName",
|
|
447
|
-
"docs": "",
|
|
448
|
-
"type": "string"
|
|
449
|
-
},
|
|
450
|
-
{
|
|
451
|
-
"name": "listenerFunc",
|
|
452
|
-
"docs": "",
|
|
453
|
-
"type": "(...args: any[]) => any"
|
|
454
|
-
}
|
|
455
|
-
],
|
|
456
|
-
"returns": "Promise<PluginListenerHandle>",
|
|
457
|
-
"tags": [],
|
|
458
|
-
"docs": "",
|
|
459
|
-
"complexTypes": [
|
|
460
|
-
"PluginListenerHandle"
|
|
461
|
-
],
|
|
462
|
-
"slug": "addlistenerstring"
|
|
463
|
-
},
|
|
464
723
|
{
|
|
465
724
|
"name": "removeAllListeners",
|
|
466
725
|
"signature": "() => Promise<void>",
|
|
467
726
|
"parameters": [],
|
|
468
727
|
"returns": "Promise<void>",
|
|
469
|
-
"tags": [
|
|
470
|
-
|
|
728
|
+
"tags": [
|
|
729
|
+
{
|
|
730
|
+
"name": "since",
|
|
731
|
+
"text": "1.0.0"
|
|
732
|
+
}
|
|
733
|
+
],
|
|
734
|
+
"docs": "Remove all listeners for this plugin.",
|
|
471
735
|
"complexTypes": [],
|
|
472
736
|
"slug": "removealllisteners"
|
|
473
737
|
}
|
|
474
738
|
],
|
|
475
|
-
"properties": []
|
|
476
|
-
"importObject": [
|
|
477
|
-
"PluginListenerHandle",
|
|
478
|
-
"\"@capacitor/cli\"",
|
|
479
|
-
"DownloadEvent",
|
|
480
|
-
"MajorAvailableEvent",
|
|
481
|
-
"DownloadCompleteEvent",
|
|
482
|
-
"UpdateFailedEvent",
|
|
483
|
-
"BundleInfo",
|
|
484
|
-
"BundleStatus",
|
|
485
|
-
"DownloadChangeListener",
|
|
486
|
-
"DownloadCompleteListener",
|
|
487
|
-
"MajorAvailableListener",
|
|
488
|
-
"UpdateFailedListener"
|
|
489
|
-
]
|
|
739
|
+
"properties": []
|
|
490
740
|
},
|
|
491
741
|
"interfaces": [
|
|
492
742
|
{
|
|
@@ -517,6 +767,13 @@
|
|
|
517
767
|
"complexTypes": [],
|
|
518
768
|
"type": "string"
|
|
519
769
|
},
|
|
770
|
+
{
|
|
771
|
+
"name": "checksum",
|
|
772
|
+
"tags": [],
|
|
773
|
+
"docs": "",
|
|
774
|
+
"complexTypes": [],
|
|
775
|
+
"type": "string"
|
|
776
|
+
},
|
|
520
777
|
{
|
|
521
778
|
"name": "status",
|
|
522
779
|
"tags": [],
|
|
@@ -526,48 +783,235 @@
|
|
|
526
783
|
],
|
|
527
784
|
"type": "BundleStatus"
|
|
528
785
|
}
|
|
529
|
-
],
|
|
530
|
-
"importObject": [
|
|
531
|
-
"PluginListenerHandle",
|
|
532
|
-
"\"@capacitor/cli\"",
|
|
533
|
-
"DownloadEvent",
|
|
534
|
-
"MajorAvailableEvent",
|
|
535
|
-
"DownloadCompleteEvent",
|
|
536
|
-
"UpdateFailedEvent",
|
|
537
|
-
"BundleStatus",
|
|
538
|
-
"DownloadChangeListener",
|
|
539
|
-
"DownloadCompleteListener",
|
|
540
|
-
"MajorAvailableListener",
|
|
541
|
-
"UpdateFailedListener",
|
|
542
|
-
"CapacitorUpdaterPlugin"
|
|
543
786
|
]
|
|
544
787
|
},
|
|
545
788
|
{
|
|
546
|
-
"name": "
|
|
547
|
-
"slug": "
|
|
789
|
+
"name": "DelayCondition",
|
|
790
|
+
"slug": "delaycondition",
|
|
548
791
|
"docs": "",
|
|
549
792
|
"tags": [],
|
|
550
793
|
"methods": [],
|
|
551
794
|
"properties": [
|
|
552
795
|
{
|
|
553
|
-
"name": "
|
|
796
|
+
"name": "kind",
|
|
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",
|
|
554
815
|
"tags": [],
|
|
555
816
|
"docs": "",
|
|
556
817
|
"complexTypes": [],
|
|
557
|
-
"type": "
|
|
818
|
+
"type": "string | undefined"
|
|
819
|
+
}
|
|
820
|
+
]
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "latestVersion",
|
|
824
|
+
"slug": "latestversion",
|
|
825
|
+
"docs": "",
|
|
826
|
+
"tags": [],
|
|
827
|
+
"methods": [],
|
|
828
|
+
"properties": [
|
|
829
|
+
{
|
|
830
|
+
"name": "version",
|
|
831
|
+
"tags": [
|
|
832
|
+
{
|
|
833
|
+
"text": "4.0.0",
|
|
834
|
+
"name": "since"
|
|
835
|
+
}
|
|
836
|
+
],
|
|
837
|
+
"docs": "Res of getLatest method",
|
|
838
|
+
"complexTypes": [],
|
|
839
|
+
"type": "string"
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
"name": "major",
|
|
843
|
+
"tags": [],
|
|
844
|
+
"docs": "",
|
|
845
|
+
"complexTypes": [],
|
|
846
|
+
"type": "boolean | undefined"
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
"name": "message",
|
|
850
|
+
"tags": [],
|
|
851
|
+
"docs": "",
|
|
852
|
+
"complexTypes": [],
|
|
853
|
+
"type": "string | undefined"
|
|
854
|
+
},
|
|
855
|
+
{
|
|
856
|
+
"name": "sessionKey",
|
|
857
|
+
"tags": [],
|
|
858
|
+
"docs": "",
|
|
859
|
+
"complexTypes": [],
|
|
860
|
+
"type": "string | undefined"
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"name": "error",
|
|
864
|
+
"tags": [],
|
|
865
|
+
"docs": "",
|
|
866
|
+
"complexTypes": [],
|
|
867
|
+
"type": "string | undefined"
|
|
868
|
+
},
|
|
869
|
+
{
|
|
870
|
+
"name": "old",
|
|
871
|
+
"tags": [],
|
|
872
|
+
"docs": "",
|
|
873
|
+
"complexTypes": [],
|
|
874
|
+
"type": "string | undefined"
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"name": "url",
|
|
878
|
+
"tags": [],
|
|
879
|
+
"docs": "",
|
|
880
|
+
"complexTypes": [],
|
|
881
|
+
"type": "string | undefined"
|
|
882
|
+
}
|
|
883
|
+
]
|
|
884
|
+
},
|
|
885
|
+
{
|
|
886
|
+
"name": "channelRes",
|
|
887
|
+
"slug": "channelres",
|
|
888
|
+
"docs": "",
|
|
889
|
+
"tags": [],
|
|
890
|
+
"methods": [],
|
|
891
|
+
"properties": [
|
|
892
|
+
{
|
|
893
|
+
"name": "status",
|
|
894
|
+
"tags": [
|
|
895
|
+
{
|
|
896
|
+
"text": "4.7.0",
|
|
897
|
+
"name": "since"
|
|
898
|
+
}
|
|
899
|
+
],
|
|
900
|
+
"docs": "Current status of set channel",
|
|
901
|
+
"complexTypes": [],
|
|
902
|
+
"type": "string"
|
|
903
|
+
},
|
|
904
|
+
{
|
|
905
|
+
"name": "error",
|
|
906
|
+
"tags": [],
|
|
907
|
+
"docs": "",
|
|
908
|
+
"complexTypes": [],
|
|
909
|
+
"type": "any"
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"name": "message",
|
|
913
|
+
"tags": [],
|
|
914
|
+
"docs": "",
|
|
915
|
+
"complexTypes": [],
|
|
916
|
+
"type": "any"
|
|
917
|
+
}
|
|
918
|
+
]
|
|
919
|
+
},
|
|
920
|
+
{
|
|
921
|
+
"name": "SetChannelOptions",
|
|
922
|
+
"slug": "setchanneloptions",
|
|
923
|
+
"docs": "",
|
|
924
|
+
"tags": [],
|
|
925
|
+
"methods": [],
|
|
926
|
+
"properties": [
|
|
927
|
+
{
|
|
928
|
+
"name": "channel",
|
|
929
|
+
"tags": [],
|
|
930
|
+
"docs": "",
|
|
931
|
+
"complexTypes": [],
|
|
932
|
+
"type": "string"
|
|
933
|
+
}
|
|
934
|
+
]
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"name": "getChannelRes",
|
|
938
|
+
"slug": "getchannelres",
|
|
939
|
+
"docs": "",
|
|
940
|
+
"tags": [],
|
|
941
|
+
"methods": [],
|
|
942
|
+
"properties": [
|
|
943
|
+
{
|
|
944
|
+
"name": "channel",
|
|
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",
|
|
978
|
+
"tags": [],
|
|
979
|
+
"docs": "",
|
|
980
|
+
"complexTypes": [],
|
|
981
|
+
"type": "boolean | undefined"
|
|
982
|
+
}
|
|
983
|
+
]
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
"name": "SetCustomIdOptions",
|
|
987
|
+
"slug": "setcustomidoptions",
|
|
988
|
+
"docs": "",
|
|
989
|
+
"tags": [],
|
|
990
|
+
"methods": [],
|
|
991
|
+
"properties": [
|
|
992
|
+
{
|
|
993
|
+
"name": "customId",
|
|
994
|
+
"tags": [],
|
|
995
|
+
"docs": "",
|
|
996
|
+
"complexTypes": [],
|
|
997
|
+
"type": "string"
|
|
998
|
+
}
|
|
999
|
+
]
|
|
1000
|
+
},
|
|
1001
|
+
{
|
|
1002
|
+
"name": "PluginListenerHandle",
|
|
1003
|
+
"slug": "pluginlistenerhandle",
|
|
1004
|
+
"docs": "",
|
|
1005
|
+
"tags": [],
|
|
1006
|
+
"methods": [],
|
|
1007
|
+
"properties": [
|
|
1008
|
+
{
|
|
1009
|
+
"name": "remove",
|
|
1010
|
+
"tags": [],
|
|
1011
|
+
"docs": "",
|
|
1012
|
+
"complexTypes": [],
|
|
1013
|
+
"type": "() => Promise<void>"
|
|
558
1014
|
}
|
|
559
|
-
],
|
|
560
|
-
"importObject": [
|
|
561
|
-
"PluginRegistry",
|
|
562
|
-
"CapacitorException",
|
|
563
|
-
"CapacitorGlobal",
|
|
564
|
-
"RegisterPlugin",
|
|
565
|
-
"PluginImplementations",
|
|
566
|
-
"Plugin",
|
|
567
|
-
"PermissionState",
|
|
568
|
-
"PluginResultData",
|
|
569
|
-
"PluginResultError",
|
|
570
|
-
"PluginCallback"
|
|
571
1015
|
]
|
|
572
1016
|
},
|
|
573
1017
|
{
|
|
@@ -598,20 +1042,52 @@
|
|
|
598
1042
|
],
|
|
599
1043
|
"type": "BundleInfo"
|
|
600
1044
|
}
|
|
601
|
-
]
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
1045
|
+
]
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "noNeedEvent",
|
|
1049
|
+
"slug": "noneedevent",
|
|
1050
|
+
"docs": "",
|
|
1051
|
+
"tags": [],
|
|
1052
|
+
"methods": [],
|
|
1053
|
+
"properties": [
|
|
1054
|
+
{
|
|
1055
|
+
"name": "bundle",
|
|
1056
|
+
"tags": [
|
|
1057
|
+
{
|
|
1058
|
+
"text": "4.0.0",
|
|
1059
|
+
"name": "since"
|
|
1060
|
+
}
|
|
1061
|
+
],
|
|
1062
|
+
"docs": "Current status of download, between 0 and 100.",
|
|
1063
|
+
"complexTypes": [
|
|
1064
|
+
"BundleInfo"
|
|
1065
|
+
],
|
|
1066
|
+
"type": "BundleInfo"
|
|
1067
|
+
}
|
|
1068
|
+
]
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "updateAvailableEvent",
|
|
1072
|
+
"slug": "updateavailableevent",
|
|
1073
|
+
"docs": "",
|
|
1074
|
+
"tags": [],
|
|
1075
|
+
"methods": [],
|
|
1076
|
+
"properties": [
|
|
1077
|
+
{
|
|
1078
|
+
"name": "bundle",
|
|
1079
|
+
"tags": [
|
|
1080
|
+
{
|
|
1081
|
+
"text": "4.0.0",
|
|
1082
|
+
"name": "since"
|
|
1083
|
+
}
|
|
1084
|
+
],
|
|
1085
|
+
"docs": "Current status of download, between 0 and 100.",
|
|
1086
|
+
"complexTypes": [
|
|
1087
|
+
"BundleInfo"
|
|
1088
|
+
],
|
|
1089
|
+
"type": "BundleInfo"
|
|
1090
|
+
}
|
|
615
1091
|
]
|
|
616
1092
|
},
|
|
617
1093
|
{
|
|
@@ -635,20 +1111,6 @@
|
|
|
635
1111
|
],
|
|
636
1112
|
"type": "BundleInfo"
|
|
637
1113
|
}
|
|
638
|
-
],
|
|
639
|
-
"importObject": [
|
|
640
|
-
"PluginListenerHandle",
|
|
641
|
-
"\"@capacitor/cli\"",
|
|
642
|
-
"DownloadEvent",
|
|
643
|
-
"MajorAvailableEvent",
|
|
644
|
-
"UpdateFailedEvent",
|
|
645
|
-
"BundleInfo",
|
|
646
|
-
"BundleStatus",
|
|
647
|
-
"DownloadChangeListener",
|
|
648
|
-
"DownloadCompleteListener",
|
|
649
|
-
"MajorAvailableListener",
|
|
650
|
-
"UpdateFailedListener",
|
|
651
|
-
"CapacitorUpdaterPlugin"
|
|
652
1114
|
]
|
|
653
1115
|
},
|
|
654
1116
|
{
|
|
@@ -666,24 +1128,10 @@
|
|
|
666
1128
|
"name": "since"
|
|
667
1129
|
}
|
|
668
1130
|
],
|
|
669
|
-
"docs": "Emit when a new major
|
|
1131
|
+
"docs": "Emit when a new major bundle is available.",
|
|
670
1132
|
"complexTypes": [],
|
|
671
1133
|
"type": "string"
|
|
672
1134
|
}
|
|
673
|
-
],
|
|
674
|
-
"importObject": [
|
|
675
|
-
"PluginListenerHandle",
|
|
676
|
-
"\"@capacitor/cli\"",
|
|
677
|
-
"DownloadEvent",
|
|
678
|
-
"DownloadCompleteEvent",
|
|
679
|
-
"UpdateFailedEvent",
|
|
680
|
-
"BundleInfo",
|
|
681
|
-
"BundleStatus",
|
|
682
|
-
"DownloadChangeListener",
|
|
683
|
-
"DownloadCompleteListener",
|
|
684
|
-
"MajorAvailableListener",
|
|
685
|
-
"UpdateFailedListener",
|
|
686
|
-
"CapacitorUpdaterPlugin"
|
|
687
1135
|
]
|
|
688
1136
|
},
|
|
689
1137
|
{
|
|
@@ -707,20 +1155,27 @@
|
|
|
707
1155
|
],
|
|
708
1156
|
"type": "BundleInfo"
|
|
709
1157
|
}
|
|
710
|
-
]
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
1158
|
+
]
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"name": "DownloadFailedEvent",
|
|
1162
|
+
"slug": "downloadfailedevent",
|
|
1163
|
+
"docs": "",
|
|
1164
|
+
"tags": [],
|
|
1165
|
+
"methods": [],
|
|
1166
|
+
"properties": [
|
|
1167
|
+
{
|
|
1168
|
+
"name": "version",
|
|
1169
|
+
"tags": [
|
|
1170
|
+
{
|
|
1171
|
+
"text": "4.0.0",
|
|
1172
|
+
"name": "since"
|
|
1173
|
+
}
|
|
1174
|
+
],
|
|
1175
|
+
"docs": "Emit when a download fail.",
|
|
1176
|
+
"complexTypes": [],
|
|
1177
|
+
"type": "string"
|
|
1178
|
+
}
|
|
724
1179
|
]
|
|
725
1180
|
}
|
|
726
1181
|
],
|
|
@@ -732,19 +1187,42 @@
|
|
|
732
1187
|
"docs": "",
|
|
733
1188
|
"types": [
|
|
734
1189
|
{
|
|
735
|
-
"text": "
|
|
1190
|
+
"text": "\"success\"",
|
|
736
1191
|
"complexTypes": []
|
|
737
1192
|
},
|
|
738
1193
|
{
|
|
739
|
-
"text": "
|
|
1194
|
+
"text": "\"error\"",
|
|
740
1195
|
"complexTypes": []
|
|
741
1196
|
},
|
|
742
1197
|
{
|
|
743
|
-
"text": "
|
|
1198
|
+
"text": "\"pending\"",
|
|
744
1199
|
"complexTypes": []
|
|
745
1200
|
},
|
|
746
1201
|
{
|
|
747
|
-
"text": "
|
|
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": []
|
|
1219
|
+
},
|
|
1220
|
+
{
|
|
1221
|
+
"text": "\"nativeVersion\"",
|
|
1222
|
+
"complexTypes": []
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
"text": "\"date\"",
|
|
748
1226
|
"complexTypes": []
|
|
749
1227
|
}
|
|
750
1228
|
]
|
|
@@ -762,6 +1240,32 @@
|
|
|
762
1240
|
}
|
|
763
1241
|
]
|
|
764
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
|
+
},
|
|
765
1269
|
{
|
|
766
1270
|
"name": "DownloadCompleteListener",
|
|
767
1271
|
"slug": "downloadcompletelistener",
|
|
@@ -800,6 +1304,30 @@
|
|
|
800
1304
|
]
|
|
801
1305
|
}
|
|
802
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
|
+
]
|
|
803
1331
|
}
|
|
804
1332
|
],
|
|
805
1333
|
"pluginConfigs": [
|
|
@@ -859,7 +1387,7 @@
|
|
|
859
1387
|
"name": "autoUpdate",
|
|
860
1388
|
"tags": [
|
|
861
1389
|
{
|
|
862
|
-
"text": "
|
|
1390
|
+
"text": "true",
|
|
863
1391
|
"name": "default"
|
|
864
1392
|
},
|
|
865
1393
|
{
|
|
@@ -872,42 +1400,42 @@
|
|
|
872
1400
|
"type": "boolean | undefined"
|
|
873
1401
|
},
|
|
874
1402
|
{
|
|
875
|
-
"name": "
|
|
1403
|
+
"name": "resetWhenUpdate",
|
|
876
1404
|
"tags": [
|
|
877
1405
|
{
|
|
878
|
-
"text": "
|
|
1406
|
+
"text": "true",
|
|
879
1407
|
"name": "default"
|
|
880
1408
|
},
|
|
881
1409
|
{
|
|
882
|
-
"text": "
|
|
1410
|
+
"text": "false",
|
|
883
1411
|
"name": "example"
|
|
884
1412
|
}
|
|
885
1413
|
],
|
|
886
|
-
"docs": "
|
|
1414
|
+
"docs": "Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\n\nOnly available for Android and iOS.",
|
|
887
1415
|
"complexTypes": [],
|
|
888
|
-
"type": "
|
|
1416
|
+
"type": "boolean | undefined"
|
|
889
1417
|
},
|
|
890
1418
|
{
|
|
891
|
-
"name": "
|
|
1419
|
+
"name": "updateUrl",
|
|
892
1420
|
"tags": [
|
|
893
1421
|
{
|
|
894
|
-
"text": "
|
|
1422
|
+
"text": "https://api.capgo.app/auto_update",
|
|
895
1423
|
"name": "default"
|
|
896
1424
|
},
|
|
897
1425
|
{
|
|
898
|
-
"text": "
|
|
1426
|
+
"text": "https://example.com/api/auto_update",
|
|
899
1427
|
"name": "example"
|
|
900
1428
|
}
|
|
901
1429
|
],
|
|
902
|
-
"docs": "
|
|
1430
|
+
"docs": "Configure the URL / endpoint to which update checks are sent.\n\nOnly available for Android and iOS.",
|
|
903
1431
|
"complexTypes": [],
|
|
904
|
-
"type": "
|
|
1432
|
+
"type": "string | undefined"
|
|
905
1433
|
},
|
|
906
1434
|
{
|
|
907
1435
|
"name": "statsUrl",
|
|
908
1436
|
"tags": [
|
|
909
1437
|
{
|
|
910
|
-
"text": "https://capgo.app/
|
|
1438
|
+
"text": "https://api.capgo.app/stats",
|
|
911
1439
|
"name": "default"
|
|
912
1440
|
},
|
|
913
1441
|
{
|
|
@@ -915,7 +1443,35 @@
|
|
|
915
1443
|
"name": "example"
|
|
916
1444
|
}
|
|
917
1445
|
],
|
|
918
|
-
"docs": "Configure the URL / endpoint to which update statistics are sent
|
|
1446
|
+
"docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
|
|
1447
|
+
"complexTypes": [],
|
|
1448
|
+
"type": "string | undefined"
|
|
1449
|
+
},
|
|
1450
|
+
{
|
|
1451
|
+
"name": "privateKey",
|
|
1452
|
+
"tags": [
|
|
1453
|
+
{
|
|
1454
|
+
"text": "undefined",
|
|
1455
|
+
"name": "default"
|
|
1456
|
+
}
|
|
1457
|
+
],
|
|
1458
|
+
"docs": "Configure the private key for end to end live update encryption.\n\nOnly available for Android and iOS.",
|
|
1459
|
+
"complexTypes": [],
|
|
1460
|
+
"type": "string | undefined"
|
|
1461
|
+
},
|
|
1462
|
+
{
|
|
1463
|
+
"name": "version",
|
|
1464
|
+
"tags": [
|
|
1465
|
+
{
|
|
1466
|
+
"text": "undefined",
|
|
1467
|
+
"name": "default"
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
"text": "4.17.48",
|
|
1471
|
+
"name": "since"
|
|
1472
|
+
}
|
|
1473
|
+
],
|
|
1474
|
+
"docs": "Configure the current version of the app. This will be used for the first update request.\nIf not set, the plugin will get the version from the native code.\n\nOnly available for Android and iOS.",
|
|
919
1475
|
"complexTypes": [],
|
|
920
1476
|
"type": "string | undefined"
|
|
921
1477
|
}
|