@capgo/capacitor-updater 6.14.29 → 6.14.36
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/README.md +136 -126
- package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +51 -8
- package/android/src/main/java/ee/forgr/capacitor_updater/CapgoUpdater.java +44 -0
- package/android/src/main/java/ee/forgr/capacitor_updater/DeviceIdHelper.java +221 -0
- package/dist/docs.json +4 -4
- package/dist/esm/definitions.d.ts +14 -4
- package/dist/esm/definitions.js.map +1 -1
- package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift +34 -6
- package/ios/Sources/CapacitorUpdaterPlugin/CapgoUpdater.swift +43 -0
- package/ios/Sources/CapacitorUpdaterPlugin/DeviceIdHelper.swift +120 -0
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -228,42 +228,42 @@ Capacitor Updater works by unzipping a compiled app bundle to the native device
|
|
|
228
228
|
|
|
229
229
|
CapacitorUpdater can be configured with these options:
|
|
230
230
|
|
|
231
|
-
| Prop | Type
|
|
232
|
-
| ----------------------------- |
|
|
233
|
-
| **`appReadyTimeout`** | <code>number</code>
|
|
234
|
-
| **`responseTimeout`** | <code>number</code>
|
|
235
|
-
| **`autoDeleteFailed`** | <code>boolean</code>
|
|
236
|
-
| **`autoDeletePrevious`** | <code>boolean</code>
|
|
237
|
-
| **`autoUpdate`** | <code>boolean</code>
|
|
238
|
-
| **`resetWhenUpdate`** | <code>boolean</code>
|
|
239
|
-
| **`updateUrl`** | <code>string</code>
|
|
240
|
-
| **`channelUrl`** | <code>string</code>
|
|
241
|
-
| **`statsUrl`** | <code>string</code>
|
|
242
|
-
| **`privateKey`** | <code>string</code>
|
|
243
|
-
| **`publicKey`** | <code>string</code>
|
|
244
|
-
| **`version`** | <code>string</code>
|
|
245
|
-
| **`directUpdate`** | <code>boolean \| 'always' \| 'atInstall'</code> | Configure when the plugin should direct install updates. Only for autoUpdate mode. Works well for apps less than 10MB and with uploads done using --partial flag. Zip or apps more than 10MB will be relatively slow for users to update. - false: Never do direct updates (default behavior) - atInstall: Direct update only when app is installed/updated from store, otherwise use normal background update - always: Always do direct updates immediately when available - true: (deprecated) Same as "always" for backward compatibility Only available for Android and iOS. | <code>false</code> | 5.1.0 |
|
|
246
|
-
| **`autoSplashscreen`** | <code>boolean</code>
|
|
247
|
-
| **`autoSplashscreenLoader`** | <code>boolean</code>
|
|
248
|
-
| **`autoSplashscreenTimeout`** | <code>number</code>
|
|
249
|
-
| **`periodCheckDelay`** | <code>number</code>
|
|
250
|
-
| **`localS3`** | <code>boolean</code>
|
|
251
|
-
| **`localHost`** | <code>string</code>
|
|
252
|
-
| **`localWebHost`** | <code>string</code>
|
|
253
|
-
| **`localSupa`** | <code>string</code>
|
|
254
|
-
| **`localSupaAnon`** | <code>string</code>
|
|
255
|
-
| **`localApi`** | <code>string</code>
|
|
256
|
-
| **`localApiFiles`** | <code>string</code>
|
|
257
|
-
| **`allowModifyUrl`** | <code>boolean</code>
|
|
258
|
-
| **`allowModifyAppId`** | <code>boolean</code>
|
|
259
|
-
| **`allowManualBundleError`** | <code>boolean</code>
|
|
260
|
-
| **`persistCustomId`** | <code>boolean</code>
|
|
261
|
-
| **`persistModifyUrl`** | <code>boolean</code>
|
|
262
|
-
| **`defaultChannel`** | <code>string</code>
|
|
263
|
-
| **`appId`** | <code>string</code>
|
|
264
|
-
| **`keepUrlPathAfterReload`** | <code>boolean</code>
|
|
265
|
-
| **`disableJSLogging`** | <code>boolean</code>
|
|
266
|
-
| **`shakeMenu`** | <code>boolean</code>
|
|
231
|
+
| Prop | Type | Description | Default | Since |
|
|
232
|
+
| ----------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------- |
|
|
233
|
+
| **`appReadyTimeout`** | <code>number</code> | Configure the number of milliseconds the native plugin should wait before considering an update 'failed'. Only available for Android and iOS. | <code>10000 // (10 seconds)</code> | |
|
|
234
|
+
| **`responseTimeout`** | <code>number</code> | Configure the number of seconds the native plugin should wait before considering API timeout. Only available for Android and iOS. | <code>20 // (20 second)</code> | |
|
|
235
|
+
| **`autoDeleteFailed`** | <code>boolean</code> | Configure whether the plugin should use automatically delete failed bundles. Only available for Android and iOS. | <code>true</code> | |
|
|
236
|
+
| **`autoDeletePrevious`** | <code>boolean</code> | Configure whether the plugin should use automatically delete previous bundles after a successful update. Only available for Android and iOS. | <code>true</code> | |
|
|
237
|
+
| **`autoUpdate`** | <code>boolean</code> | Configure whether the plugin should use Auto Update via an update server. Only available for Android and iOS. | <code>true</code> | |
|
|
238
|
+
| **`resetWhenUpdate`** | <code>boolean</code> | Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device. Only available for Android and iOS. | <code>true</code> | |
|
|
239
|
+
| **`updateUrl`** | <code>string</code> | Configure the URL / endpoint to which update checks are sent. Only available for Android and iOS. | <code>https://plugin.capgo.app/updates</code> | |
|
|
240
|
+
| **`channelUrl`** | <code>string</code> | Configure the URL / endpoint for channel operations. Only available for Android and iOS. | <code>https://plugin.capgo.app/channel_self</code> | |
|
|
241
|
+
| **`statsUrl`** | <code>string</code> | Configure the URL / endpoint to which update statistics are sent. Only available for Android and iOS. Set to "" to disable stats reporting. | <code>https://plugin.capgo.app/stats</code> | |
|
|
242
|
+
| **`privateKey`** | <code>string</code> | Configure the private key for end to end live update encryption. Only available for Android and iOS. Deprecated in version 6.2.0 in favor of publicKey. Still supported for backwards compatibility. | <code>undefined</code> | |
|
|
243
|
+
| **`publicKey`** | <code>string</code> | Configure the public key for end to end live update encryption Version 2 Only available for Android and iOS. | <code>undefined</code> | 6.2.0 |
|
|
244
|
+
| **`version`** | <code>string</code> | Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code. Only available for Android and iOS. | <code>undefined</code> | 4.17.48 |
|
|
245
|
+
| **`directUpdate`** | <code>boolean \| 'always' \| 'atInstall' \| 'onLaunch'</code> | Configure when the plugin should direct install updates. Only for autoUpdate mode. Works well for apps less than 10MB and with uploads done using --partial flag. Zip or apps more than 10MB will be relatively slow for users to update. - false: Never do direct updates (default behavior) - atInstall: Direct update only when app is installed/updated from store, otherwise use normal background update - always: Always do direct updates immediately when available (including when returning from background) - onLaunch: Direct update only on app launch (first foreground after app starts), not when returning from background - true: (deprecated) Same as "always" for backward compatibility Only available for Android and iOS. | <code>false</code> | 5.1.0 |
|
|
246
|
+
| **`autoSplashscreen`** | <code>boolean</code> | 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. This removes the need to manually listen for appReady events and call SplashScreen.hide(). Only works when directUpdate is set to "atInstall", "always", "onLaunch", or true. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires autoUpdate and directUpdate to be enabled. Only available for Android and iOS. | <code>false</code> | 7.6.0 |
|
|
247
|
+
| **`autoSplashscreenLoader`** | <code>boolean</code> | Display a native loading indicator on top of the splashscreen while automatic direct updates are running. Only takes effect when {@link autoSplashscreen} is enabled. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Only available for Android and iOS. | <code>false</code> | 7.19.0 |
|
|
248
|
+
| **`autoSplashscreenTimeout`** | <code>number</code> | Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates. If the timeout elapses, the update continues to download in the background while the splashscreen is dismissed. Set to `0` (zero) to disable the timeout. When the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch. Requires {@link autoSplashscreen} to be enabled. Only available for Android and iOS. | <code>10000 // (10 seconds)</code> | 7.19.0 |
|
|
249
|
+
| **`periodCheckDelay`** | <code>number</code> | Configure the delay period for period update check. the unit is in seconds. Only available for Android and iOS. Cannot be less than 600 seconds (10 minutes). | <code>0 (disabled)</code> | |
|
|
250
|
+
| **`localS3`** | <code>boolean</code> | Configure the CLI to use a local server for testing or self-hosted update server. | <code>undefined</code> | 4.17.48 |
|
|
251
|
+
| **`localHost`** | <code>string</code> | Configure the CLI to use a local server for testing or self-hosted update server. | <code>undefined</code> | 4.17.48 |
|
|
252
|
+
| **`localWebHost`** | <code>string</code> | Configure the CLI to use a local server for testing or self-hosted update server. | <code>undefined</code> | 4.17.48 |
|
|
253
|
+
| **`localSupa`** | <code>string</code> | Configure the CLI to use a local server for testing or self-hosted update server. | <code>undefined</code> | 4.17.48 |
|
|
254
|
+
| **`localSupaAnon`** | <code>string</code> | Configure the CLI to use a local server for testing. | <code>undefined</code> | 4.17.48 |
|
|
255
|
+
| **`localApi`** | <code>string</code> | Configure the CLI to use a local api for testing. | <code>undefined</code> | 6.3.3 |
|
|
256
|
+
| **`localApiFiles`** | <code>string</code> | Configure the CLI to use a local file api for testing. | <code>undefined</code> | 6.3.3 |
|
|
257
|
+
| **`allowModifyUrl`** | <code>boolean</code> | Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side. | <code>false</code> | 5.4.0 |
|
|
258
|
+
| **`allowModifyAppId`** | <code>boolean</code> | Allow the plugin to modify the appId dynamically from the JavaScript side. | <code>false</code> | 7.14.0 |
|
|
259
|
+
| **`allowManualBundleError`** | <code>boolean</code> | Allow marking bundles as errored from JavaScript while using manual update flows. When enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`. | <code>false</code> | 7.20.0 |
|
|
260
|
+
| **`persistCustomId`** | <code>boolean</code> | Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts. Only available for Android and iOS. | <code>false (will be true by default in a future major release v8.x.x)</code> | 7.17.3 |
|
|
261
|
+
| **`persistModifyUrl`** | <code>boolean</code> | Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl}, {@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts. Only available for Android and iOS. | <code>false</code> | 7.20.0 |
|
|
262
|
+
| **`defaultChannel`** | <code>string</code> | Set the default channel for the app in the config. Case sensitive. This will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud. This requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options | <code>undefined</code> | 5.5.0 |
|
|
263
|
+
| **`appId`** | <code>string</code> | Configure the app id for the app in the config. | <code>undefined</code> | 6.0.0 |
|
|
264
|
+
| **`keepUrlPathAfterReload`** | <code>boolean</code> | Configure the plugin to keep the URL path after a reload. WARNING: When a reload is triggered, 'window.history' will be cleared. | <code>false</code> | 6.8.0 |
|
|
265
|
+
| **`disableJSLogging`** | <code>boolean</code> | 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 | <code>false</code> | 7.3.0 |
|
|
266
|
+
| **`shakeMenu`** | <code>boolean</code> | Enable shake gesture to show update menu for debugging/testing purposes | <code>false</code> | 7.5.0 |
|
|
267
267
|
|
|
268
268
|
### Examples
|
|
269
269
|
|
|
@@ -368,6 +368,7 @@ export default config;
|
|
|
368
368
|
## API
|
|
369
369
|
|
|
370
370
|
<docgen-index>
|
|
371
|
+
<!--Auto-generated, compact index-->
|
|
371
372
|
|
|
372
373
|
* [`notifyAppReady()`](#notifyappready)
|
|
373
374
|
* [`setUpdateUrl(...)`](#setupdateurl)
|
|
@@ -420,7 +421,7 @@ export default config;
|
|
|
420
421
|
<docgen-api>
|
|
421
422
|
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
|
|
422
423
|
|
|
423
|
-
|
|
424
|
+
#### notifyAppReady()
|
|
424
425
|
|
|
425
426
|
```typescript
|
|
426
427
|
notifyAppReady() => Promise<AppReadyResult>
|
|
@@ -435,7 +436,7 @@ Change this behaviour with {@link appReadyTimeout}
|
|
|
435
436
|
--------------------
|
|
436
437
|
|
|
437
438
|
|
|
438
|
-
|
|
439
|
+
#### setUpdateUrl(...)
|
|
439
440
|
|
|
440
441
|
```typescript
|
|
441
442
|
setUpdateUrl(options: UpdateUrl) => Promise<void>
|
|
@@ -452,7 +453,7 @@ Set the updateUrl for the app, this will be used to check for updates.
|
|
|
452
453
|
--------------------
|
|
453
454
|
|
|
454
455
|
|
|
455
|
-
|
|
456
|
+
#### setStatsUrl(...)
|
|
456
457
|
|
|
457
458
|
```typescript
|
|
458
459
|
setStatsUrl(options: StatsUrl) => Promise<void>
|
|
@@ -469,7 +470,7 @@ Set the statsUrl for the app, this will be used to send statistics. Passing an e
|
|
|
469
470
|
--------------------
|
|
470
471
|
|
|
471
472
|
|
|
472
|
-
|
|
473
|
+
#### setChannelUrl(...)
|
|
473
474
|
|
|
474
475
|
```typescript
|
|
475
476
|
setChannelUrl(options: ChannelUrl) => Promise<void>
|
|
@@ -486,7 +487,7 @@ Set the channelUrl for the app, this will be used to set the channel.
|
|
|
486
487
|
--------------------
|
|
487
488
|
|
|
488
489
|
|
|
489
|
-
|
|
490
|
+
#### download(...)
|
|
490
491
|
|
|
491
492
|
```typescript
|
|
492
493
|
download(options: DownloadOptions) => Promise<BundleInfo>
|
|
@@ -503,7 +504,7 @@ Download a new bundle from the provided URL, it should be a zip file, with files
|
|
|
503
504
|
--------------------
|
|
504
505
|
|
|
505
506
|
|
|
506
|
-
|
|
507
|
+
#### next(...)
|
|
507
508
|
|
|
508
509
|
```typescript
|
|
509
510
|
next(options: BundleId) => Promise<BundleInfo>
|
|
@@ -520,7 +521,7 @@ Set the next bundle to be used when the app is reloaded.
|
|
|
520
521
|
--------------------
|
|
521
522
|
|
|
522
523
|
|
|
523
|
-
|
|
524
|
+
#### set(...)
|
|
524
525
|
|
|
525
526
|
```typescript
|
|
526
527
|
set(options: BundleId) => Promise<void>
|
|
@@ -535,7 +536,7 @@ Set the current bundle and immediately reloads the app.
|
|
|
535
536
|
--------------------
|
|
536
537
|
|
|
537
538
|
|
|
538
|
-
|
|
539
|
+
#### delete(...)
|
|
539
540
|
|
|
540
541
|
```typescript
|
|
541
542
|
delete(options: BundleId) => Promise<void>
|
|
@@ -550,7 +551,7 @@ Deletes the specified bundle from the native app storage. Use with {@link list}
|
|
|
550
551
|
--------------------
|
|
551
552
|
|
|
552
553
|
|
|
553
|
-
|
|
554
|
+
#### setBundleError(...)
|
|
554
555
|
|
|
555
556
|
```typescript
|
|
556
557
|
setBundleError(options: BundleId) => Promise<BundleInfo>
|
|
@@ -569,7 +570,7 @@ Mark an installed bundle as errored. Only available when {@link PluginsConfig.Ca
|
|
|
569
570
|
--------------------
|
|
570
571
|
|
|
571
572
|
|
|
572
|
-
|
|
573
|
+
#### list(...)
|
|
573
574
|
|
|
574
575
|
```typescript
|
|
575
576
|
list(options?: ListOptions | undefined) => Promise<BundleListResult>
|
|
@@ -586,7 +587,7 @@ Get all locally downloaded bundles in your app
|
|
|
586
587
|
--------------------
|
|
587
588
|
|
|
588
589
|
|
|
589
|
-
|
|
590
|
+
#### reset(...)
|
|
590
591
|
|
|
591
592
|
```typescript
|
|
592
593
|
reset(options?: ResetOptions | undefined) => Promise<void>
|
|
@@ -601,7 +602,7 @@ Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google
|
|
|
601
602
|
--------------------
|
|
602
603
|
|
|
603
604
|
|
|
604
|
-
|
|
605
|
+
#### current()
|
|
605
606
|
|
|
606
607
|
```typescript
|
|
607
608
|
current() => Promise<CurrentBundleResult>
|
|
@@ -614,7 +615,7 @@ Get the current bundle, if none are set it returns `builtin`. currentNative is t
|
|
|
614
615
|
--------------------
|
|
615
616
|
|
|
616
617
|
|
|
617
|
-
|
|
618
|
+
#### reload()
|
|
618
619
|
|
|
619
620
|
```typescript
|
|
620
621
|
reload() => Promise<void>
|
|
@@ -625,7 +626,7 @@ Reload the view
|
|
|
625
626
|
--------------------
|
|
626
627
|
|
|
627
628
|
|
|
628
|
-
|
|
629
|
+
#### setMultiDelay(...)
|
|
629
630
|
|
|
630
631
|
```typescript
|
|
631
632
|
setMultiDelay(options: MultiDelayConditions) => Promise<void>
|
|
@@ -648,7 +649,7 @@ The function has unconsistent behavior the option kill do trigger the update aft
|
|
|
648
649
|
--------------------
|
|
649
650
|
|
|
650
651
|
|
|
651
|
-
|
|
652
|
+
#### cancelDelay()
|
|
652
653
|
|
|
653
654
|
```typescript
|
|
654
655
|
cancelDelay() => Promise<void>
|
|
@@ -661,7 +662,7 @@ Cancels a {@link <a href="#delaycondition">DelayCondition</a>} to process an upd
|
|
|
661
662
|
--------------------
|
|
662
663
|
|
|
663
664
|
|
|
664
|
-
|
|
665
|
+
#### getLatest(...)
|
|
665
666
|
|
|
666
667
|
```typescript
|
|
667
668
|
getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>
|
|
@@ -680,7 +681,7 @@ Get Latest bundle available from update Url
|
|
|
680
681
|
--------------------
|
|
681
682
|
|
|
682
683
|
|
|
683
|
-
|
|
684
|
+
#### setChannel(...)
|
|
684
685
|
|
|
685
686
|
```typescript
|
|
686
687
|
setChannel(options: SetChannelOptions) => Promise<ChannelRes>
|
|
@@ -703,7 +704,7 @@ This methods send to Capgo backend a request to link the device ID to the channe
|
|
|
703
704
|
--------------------
|
|
704
705
|
|
|
705
706
|
|
|
706
|
-
|
|
707
|
+
#### unsetChannel(...)
|
|
707
708
|
|
|
708
709
|
```typescript
|
|
709
710
|
unsetChannel(options: UnsetChannelOptions) => Promise<void>
|
|
@@ -720,7 +721,7 @@ Unset the channel for this device. The device will then return to the default ch
|
|
|
720
721
|
--------------------
|
|
721
722
|
|
|
722
723
|
|
|
723
|
-
|
|
724
|
+
#### getChannel()
|
|
724
725
|
|
|
725
726
|
```typescript
|
|
726
727
|
getChannel() => Promise<GetChannelRes>
|
|
@@ -735,7 +736,7 @@ Get the channel for this device
|
|
|
735
736
|
--------------------
|
|
736
737
|
|
|
737
738
|
|
|
738
|
-
|
|
739
|
+
#### listChannels()
|
|
739
740
|
|
|
740
741
|
```typescript
|
|
741
742
|
listChannels() => Promise<ListChannelsResult>
|
|
@@ -750,7 +751,7 @@ List all channels available for this device that allow self-assignment
|
|
|
750
751
|
--------------------
|
|
751
752
|
|
|
752
753
|
|
|
753
|
-
|
|
754
|
+
#### setCustomId(...)
|
|
754
755
|
|
|
755
756
|
```typescript
|
|
756
757
|
setCustomId(options: SetCustomIdOptions) => Promise<void>
|
|
@@ -770,7 +771,7 @@ Pass an empty string to remove any previously stored customId.
|
|
|
770
771
|
--------------------
|
|
771
772
|
|
|
772
773
|
|
|
773
|
-
|
|
774
|
+
#### getBuiltinVersion()
|
|
774
775
|
|
|
775
776
|
```typescript
|
|
776
777
|
getBuiltinVersion() => Promise<BuiltinVersion>
|
|
@@ -785,20 +786,29 @@ Get the native app version or the builtin version if set in config
|
|
|
785
786
|
--------------------
|
|
786
787
|
|
|
787
788
|
|
|
788
|
-
|
|
789
|
+
#### getDeviceId()
|
|
789
790
|
|
|
790
791
|
```typescript
|
|
791
792
|
getDeviceId() => Promise<DeviceId>
|
|
792
793
|
```
|
|
793
794
|
|
|
794
|
-
Get unique ID used to identify device (sent to auto update server)
|
|
795
|
+
Get unique ID used to identify device (sent to auto update server).
|
|
796
|
+
|
|
797
|
+
This ID is privacy-friendly and follows Apple and Google best practices:
|
|
798
|
+
- Generated as a UUID and stored securely
|
|
799
|
+
- Android: Uses Android Keystore (persists across reinstalls on API 23+)
|
|
800
|
+
- iOS: Uses Keychain with kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly (persists across reinstalls)
|
|
801
|
+
- Data stays on device (not synced to cloud on iOS)
|
|
802
|
+
- Can be cleared by user via system settings (Android) or keychain access (iOS)
|
|
803
|
+
|
|
804
|
+
The device ID now persists between app reinstalls to maintain consistent device identity.
|
|
795
805
|
|
|
796
806
|
**Returns:** <code>Promise<<a href="#deviceid">DeviceId</a>></code>
|
|
797
807
|
|
|
798
808
|
--------------------
|
|
799
809
|
|
|
800
810
|
|
|
801
|
-
|
|
811
|
+
#### getPluginVersion()
|
|
802
812
|
|
|
803
813
|
```typescript
|
|
804
814
|
getPluginVersion() => Promise<PluginVersion>
|
|
@@ -811,7 +821,7 @@ Get the native Capacitor Updater plugin version (sent to auto update server)
|
|
|
811
821
|
--------------------
|
|
812
822
|
|
|
813
823
|
|
|
814
|
-
|
|
824
|
+
#### isAutoUpdateEnabled()
|
|
815
825
|
|
|
816
826
|
```typescript
|
|
817
827
|
isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>
|
|
@@ -824,7 +834,7 @@ Get the state of auto update config.
|
|
|
824
834
|
--------------------
|
|
825
835
|
|
|
826
836
|
|
|
827
|
-
|
|
837
|
+
#### removeAllListeners()
|
|
828
838
|
|
|
829
839
|
```typescript
|
|
830
840
|
removeAllListeners() => Promise<void>
|
|
@@ -837,7 +847,7 @@ Remove all listeners for this plugin.
|
|
|
837
847
|
--------------------
|
|
838
848
|
|
|
839
849
|
|
|
840
|
-
|
|
850
|
+
#### addListener('download', ...)
|
|
841
851
|
|
|
842
852
|
```typescript
|
|
843
853
|
addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -858,7 +868,7 @@ This will return you all download percent during the download
|
|
|
858
868
|
--------------------
|
|
859
869
|
|
|
860
870
|
|
|
861
|
-
|
|
871
|
+
#### addListener('noNeedUpdate', ...)
|
|
862
872
|
|
|
863
873
|
```typescript
|
|
864
874
|
addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -878,7 +888,7 @@ Listen for no need to update event, useful when you want force check every time
|
|
|
878
888
|
--------------------
|
|
879
889
|
|
|
880
890
|
|
|
881
|
-
|
|
891
|
+
#### addListener('updateAvailable', ...)
|
|
882
892
|
|
|
883
893
|
```typescript
|
|
884
894
|
addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -898,7 +908,7 @@ Listen for available update event, useful when you want to force check every tim
|
|
|
898
908
|
--------------------
|
|
899
909
|
|
|
900
910
|
|
|
901
|
-
|
|
911
|
+
#### addListener('downloadComplete', ...)
|
|
902
912
|
|
|
903
913
|
```typescript
|
|
904
914
|
addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -918,7 +928,7 @@ Listen for downloadComplete events.
|
|
|
918
928
|
--------------------
|
|
919
929
|
|
|
920
930
|
|
|
921
|
-
|
|
931
|
+
#### addListener('breakingAvailable', ...)
|
|
922
932
|
|
|
923
933
|
```typescript
|
|
924
934
|
addListener(eventName: 'breakingAvailable', listenerFunc: (state: BreakingAvailableEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -939,7 +949,7 @@ Emits the same payload as the legacy `majorAvailable` listener.
|
|
|
939
949
|
--------------------
|
|
940
950
|
|
|
941
951
|
|
|
942
|
-
|
|
952
|
+
#### addListener('majorAvailable', ...)
|
|
943
953
|
|
|
944
954
|
```typescript
|
|
945
955
|
addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -959,7 +969,7 @@ Listen for Major update event in the App, let you know when major update is bloc
|
|
|
959
969
|
--------------------
|
|
960
970
|
|
|
961
971
|
|
|
962
|
-
|
|
972
|
+
#### addListener('updateFailed', ...)
|
|
963
973
|
|
|
964
974
|
```typescript
|
|
965
975
|
addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -979,7 +989,7 @@ Listen for update fail event in the App, let you know when update has fail to in
|
|
|
979
989
|
--------------------
|
|
980
990
|
|
|
981
991
|
|
|
982
|
-
|
|
992
|
+
#### addListener('downloadFailed', ...)
|
|
983
993
|
|
|
984
994
|
```typescript
|
|
985
995
|
addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -999,7 +1009,7 @@ Listen for download fail event in the App, let you know when a bundle download h
|
|
|
999
1009
|
--------------------
|
|
1000
1010
|
|
|
1001
1011
|
|
|
1002
|
-
|
|
1012
|
+
#### addListener('appReloaded', ...)
|
|
1003
1013
|
|
|
1004
1014
|
```typescript
|
|
1005
1015
|
addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
@@ -1019,7 +1029,7 @@ Listen for reload event in the App, let you know when reload has happened
|
|
|
1019
1029
|
--------------------
|
|
1020
1030
|
|
|
1021
1031
|
|
|
1022
|
-
|
|
1032
|
+
#### addListener('appReady', ...)
|
|
1023
1033
|
|
|
1024
1034
|
```typescript
|
|
1025
1035
|
addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -1039,7 +1049,7 @@ Listen for app ready event in the App, let you know when app is ready to use, th
|
|
|
1039
1049
|
--------------------
|
|
1040
1050
|
|
|
1041
1051
|
|
|
1042
|
-
|
|
1052
|
+
#### isAutoUpdateAvailable()
|
|
1043
1053
|
|
|
1044
1054
|
```typescript
|
|
1045
1055
|
isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>
|
|
@@ -1052,7 +1062,7 @@ Get if auto update is available (not disabled by serverUrl).
|
|
|
1052
1062
|
--------------------
|
|
1053
1063
|
|
|
1054
1064
|
|
|
1055
|
-
|
|
1065
|
+
#### getNextBundle()
|
|
1056
1066
|
|
|
1057
1067
|
```typescript
|
|
1058
1068
|
getNextBundle() => Promise<BundleInfo | null>
|
|
@@ -1068,7 +1078,7 @@ Returns null if no next bundle is set.
|
|
|
1068
1078
|
--------------------
|
|
1069
1079
|
|
|
1070
1080
|
|
|
1071
|
-
|
|
1081
|
+
#### getFailedUpdate()
|
|
1072
1082
|
|
|
1073
1083
|
```typescript
|
|
1074
1084
|
getFailedUpdate() => Promise<UpdateFailedEvent | null>
|
|
@@ -1083,7 +1093,7 @@ Get the most recent update that failed to install, if any. The stored value is c
|
|
|
1083
1093
|
--------------------
|
|
1084
1094
|
|
|
1085
1095
|
|
|
1086
|
-
|
|
1096
|
+
#### setShakeMenu(...)
|
|
1087
1097
|
|
|
1088
1098
|
```typescript
|
|
1089
1099
|
setShakeMenu(options: SetShakeMenuOptions) => Promise<void>
|
|
@@ -1100,7 +1110,7 @@ Enable or disable the shake menu for debugging/testing purposes
|
|
|
1100
1110
|
--------------------
|
|
1101
1111
|
|
|
1102
1112
|
|
|
1103
|
-
|
|
1113
|
+
#### isShakeMenuEnabled()
|
|
1104
1114
|
|
|
1105
1115
|
```typescript
|
|
1106
1116
|
isShakeMenuEnabled() => Promise<ShakeMenuEnabled>
|
|
@@ -1115,7 +1125,7 @@ Get the current state of the shake menu
|
|
|
1115
1125
|
--------------------
|
|
1116
1126
|
|
|
1117
1127
|
|
|
1118
|
-
|
|
1128
|
+
#### getAppId()
|
|
1119
1129
|
|
|
1120
1130
|
```typescript
|
|
1121
1131
|
getAppId() => Promise<GetAppIdRes>
|
|
@@ -1130,7 +1140,7 @@ Get the configured App ID
|
|
|
1130
1140
|
--------------------
|
|
1131
1141
|
|
|
1132
1142
|
|
|
1133
|
-
|
|
1143
|
+
#### setAppId(...)
|
|
1134
1144
|
|
|
1135
1145
|
```typescript
|
|
1136
1146
|
setAppId(options: SetAppIdOptions) => Promise<void>
|
|
@@ -1147,17 +1157,17 @@ Set the App ID for the app (requires allowModifyAppId to be true in config)
|
|
|
1147
1157
|
--------------------
|
|
1148
1158
|
|
|
1149
1159
|
|
|
1150
|
-
|
|
1160
|
+
#### Interfaces
|
|
1151
1161
|
|
|
1152
1162
|
|
|
1153
|
-
|
|
1163
|
+
##### AppReadyResult
|
|
1154
1164
|
|
|
1155
1165
|
| Prop | Type |
|
|
1156
1166
|
| ------------ | ------------------------------------------------- |
|
|
1157
1167
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> |
|
|
1158
1168
|
|
|
1159
1169
|
|
|
1160
|
-
|
|
1170
|
+
##### BundleInfo
|
|
1161
1171
|
|
|
1162
1172
|
| Prop | Type |
|
|
1163
1173
|
| ---------------- | ----------------------------------------------------- |
|
|
@@ -1168,28 +1178,28 @@ Set the App ID for the app (requires allowModifyAppId to be true in config)
|
|
|
1168
1178
|
| **`status`** | <code><a href="#bundlestatus">BundleStatus</a></code> |
|
|
1169
1179
|
|
|
1170
1180
|
|
|
1171
|
-
|
|
1181
|
+
##### UpdateUrl
|
|
1172
1182
|
|
|
1173
1183
|
| Prop | Type |
|
|
1174
1184
|
| --------- | ------------------- |
|
|
1175
1185
|
| **`url`** | <code>string</code> |
|
|
1176
1186
|
|
|
1177
1187
|
|
|
1178
|
-
|
|
1188
|
+
##### StatsUrl
|
|
1179
1189
|
|
|
1180
1190
|
| Prop | Type |
|
|
1181
1191
|
| --------- | ------------------- |
|
|
1182
1192
|
| **`url`** | <code>string</code> |
|
|
1183
1193
|
|
|
1184
1194
|
|
|
1185
|
-
|
|
1195
|
+
##### ChannelUrl
|
|
1186
1196
|
|
|
1187
1197
|
| Prop | Type |
|
|
1188
1198
|
| --------- | ------------------- |
|
|
1189
1199
|
| **`url`** | <code>string</code> |
|
|
1190
1200
|
|
|
1191
1201
|
|
|
1192
|
-
|
|
1202
|
+
##### DownloadOptions
|
|
1193
1203
|
|
|
1194
1204
|
This URL and versions are used to download the bundle from the server, If you use backend all information will be gived by the method getLatest.
|
|
1195
1205
|
If 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.
|
|
@@ -1203,7 +1213,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1203
1213
|
| **`manifest`** | <code>ManifestEntry[]</code> | The manifest for multi-file downloads | <code>undefined</code> | 6.1.0 |
|
|
1204
1214
|
|
|
1205
1215
|
|
|
1206
|
-
|
|
1216
|
+
##### ManifestEntry
|
|
1207
1217
|
|
|
1208
1218
|
| Prop | Type |
|
|
1209
1219
|
| ------------------ | --------------------------- |
|
|
@@ -1212,35 +1222,35 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1212
1222
|
| **`download_url`** | <code>string \| null</code> |
|
|
1213
1223
|
|
|
1214
1224
|
|
|
1215
|
-
|
|
1225
|
+
##### BundleId
|
|
1216
1226
|
|
|
1217
1227
|
| Prop | Type |
|
|
1218
1228
|
| -------- | ------------------- |
|
|
1219
1229
|
| **`id`** | <code>string</code> |
|
|
1220
1230
|
|
|
1221
1231
|
|
|
1222
|
-
|
|
1232
|
+
##### BundleListResult
|
|
1223
1233
|
|
|
1224
1234
|
| Prop | Type |
|
|
1225
1235
|
| ------------- | ------------------------- |
|
|
1226
1236
|
| **`bundles`** | <code>BundleInfo[]</code> |
|
|
1227
1237
|
|
|
1228
1238
|
|
|
1229
|
-
|
|
1239
|
+
##### ListOptions
|
|
1230
1240
|
|
|
1231
1241
|
| Prop | Type | Description | Default | Since |
|
|
1232
1242
|
| --------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------ |
|
|
1233
1243
|
| **`raw`** | <code>boolean</code> | 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. | <code>false</code> | 6.14.0 |
|
|
1234
1244
|
|
|
1235
1245
|
|
|
1236
|
-
|
|
1246
|
+
##### ResetOptions
|
|
1237
1247
|
|
|
1238
1248
|
| Prop | Type |
|
|
1239
1249
|
| ---------------------- | -------------------- |
|
|
1240
1250
|
| **`toLastSuccessful`** | <code>boolean</code> |
|
|
1241
1251
|
|
|
1242
1252
|
|
|
1243
|
-
|
|
1253
|
+
##### CurrentBundleResult
|
|
1244
1254
|
|
|
1245
1255
|
| Prop | Type |
|
|
1246
1256
|
| ------------ | ------------------------------------------------- |
|
|
@@ -1248,14 +1258,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1248
1258
|
| **`native`** | <code>string</code> |
|
|
1249
1259
|
|
|
1250
1260
|
|
|
1251
|
-
|
|
1261
|
+
##### MultiDelayConditions
|
|
1252
1262
|
|
|
1253
1263
|
| Prop | Type |
|
|
1254
1264
|
| --------------------- | ----------------------------- |
|
|
1255
1265
|
| **`delayConditions`** | <code>DelayCondition[]</code> |
|
|
1256
1266
|
|
|
1257
1267
|
|
|
1258
|
-
|
|
1268
|
+
##### DelayCondition
|
|
1259
1269
|
|
|
1260
1270
|
| Prop | Type | Description |
|
|
1261
1271
|
| ----------- | --------------------------------------------------------- | ---------------------------------------- |
|
|
@@ -1263,7 +1273,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1263
1273
|
| **`value`** | <code>string</code> | |
|
|
1264
1274
|
|
|
1265
1275
|
|
|
1266
|
-
|
|
1276
|
+
##### LatestVersion
|
|
1267
1277
|
|
|
1268
1278
|
| Prop | Type | Description | Since |
|
|
1269
1279
|
| ---------------- | ---------------------------- | -------------------------------------------------------------------- | ------ |
|
|
@@ -1279,14 +1289,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1279
1289
|
| **`manifest`** | <code>ManifestEntry[]</code> | | 6.1 |
|
|
1280
1290
|
|
|
1281
1291
|
|
|
1282
|
-
|
|
1292
|
+
##### GetLatestOptions
|
|
1283
1293
|
|
|
1284
1294
|
| Prop | Type | Description | Default | Since |
|
|
1285
1295
|
| ------------- | ------------------- | ----------------------------------------------------------------------------------------------- | ---------------------- | ----- |
|
|
1286
1296
|
| **`channel`** | <code>string</code> | The channel to get the latest version for The channel must allow 'self_assign' for this to work | <code>undefined</code> | 6.8.0 |
|
|
1287
1297
|
|
|
1288
1298
|
|
|
1289
|
-
|
|
1299
|
+
##### ChannelRes
|
|
1290
1300
|
|
|
1291
1301
|
| Prop | Type | Description | Since |
|
|
1292
1302
|
| ------------- | ------------------- | ----------------------------- | ----- |
|
|
@@ -1295,7 +1305,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1295
1305
|
| **`message`** | <code>string</code> | | |
|
|
1296
1306
|
|
|
1297
1307
|
|
|
1298
|
-
|
|
1308
|
+
##### SetChannelOptions
|
|
1299
1309
|
|
|
1300
1310
|
| Prop | Type |
|
|
1301
1311
|
| ----------------------- | -------------------- |
|
|
@@ -1303,14 +1313,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1303
1313
|
| **`triggerAutoUpdate`** | <code>boolean</code> |
|
|
1304
1314
|
|
|
1305
1315
|
|
|
1306
|
-
|
|
1316
|
+
##### UnsetChannelOptions
|
|
1307
1317
|
|
|
1308
1318
|
| Prop | Type |
|
|
1309
1319
|
| ----------------------- | -------------------- |
|
|
1310
1320
|
| **`triggerAutoUpdate`** | <code>boolean</code> |
|
|
1311
1321
|
|
|
1312
1322
|
|
|
1313
|
-
|
|
1323
|
+
##### GetChannelRes
|
|
1314
1324
|
|
|
1315
1325
|
| Prop | Type | Description | Since |
|
|
1316
1326
|
| -------------- | -------------------- | ----------------------------- | ----- |
|
|
@@ -1321,14 +1331,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1321
1331
|
| **`allowSet`** | <code>boolean</code> | | |
|
|
1322
1332
|
|
|
1323
1333
|
|
|
1324
|
-
|
|
1334
|
+
##### ListChannelsResult
|
|
1325
1335
|
|
|
1326
1336
|
| Prop | Type | Description | Since |
|
|
1327
1337
|
| -------------- | -------------------------- | -------------------------- | ----- |
|
|
1328
1338
|
| **`channels`** | <code>ChannelInfo[]</code> | List of available channels | 7.5.0 |
|
|
1329
1339
|
|
|
1330
1340
|
|
|
1331
|
-
|
|
1341
|
+
##### ChannelInfo
|
|
1332
1342
|
|
|
1333
1343
|
| Prop | Type | Description | Since |
|
|
1334
1344
|
| -------------------- | -------------------- | ----------------------------------------------- | ----- |
|
|
@@ -1338,49 +1348,49 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1338
1348
|
| **`allow_self_set`** | <code>boolean</code> | Whether devices can self-assign to this channel | 7.5.0 |
|
|
1339
1349
|
|
|
1340
1350
|
|
|
1341
|
-
|
|
1351
|
+
##### SetCustomIdOptions
|
|
1342
1352
|
|
|
1343
1353
|
| Prop | Type | Description |
|
|
1344
1354
|
| -------------- | ------------------- | --------------------------------------------------------------------------------------------- |
|
|
1345
1355
|
| **`customId`** | <code>string</code> | Custom identifier to associate with the device. Use an empty string to clear any saved value. |
|
|
1346
1356
|
|
|
1347
1357
|
|
|
1348
|
-
|
|
1358
|
+
##### BuiltinVersion
|
|
1349
1359
|
|
|
1350
1360
|
| Prop | Type |
|
|
1351
1361
|
| ------------- | ------------------- |
|
|
1352
1362
|
| **`version`** | <code>string</code> |
|
|
1353
1363
|
|
|
1354
1364
|
|
|
1355
|
-
|
|
1365
|
+
##### DeviceId
|
|
1356
1366
|
|
|
1357
1367
|
| Prop | Type |
|
|
1358
1368
|
| -------------- | ------------------- |
|
|
1359
1369
|
| **`deviceId`** | <code>string</code> |
|
|
1360
1370
|
|
|
1361
1371
|
|
|
1362
|
-
|
|
1372
|
+
##### PluginVersion
|
|
1363
1373
|
|
|
1364
1374
|
| Prop | Type |
|
|
1365
1375
|
| ------------- | ------------------- |
|
|
1366
1376
|
| **`version`** | <code>string</code> |
|
|
1367
1377
|
|
|
1368
1378
|
|
|
1369
|
-
|
|
1379
|
+
##### AutoUpdateEnabled
|
|
1370
1380
|
|
|
1371
1381
|
| Prop | Type |
|
|
1372
1382
|
| ------------- | -------------------- |
|
|
1373
1383
|
| **`enabled`** | <code>boolean</code> |
|
|
1374
1384
|
|
|
1375
1385
|
|
|
1376
|
-
|
|
1386
|
+
##### PluginListenerHandle
|
|
1377
1387
|
|
|
1378
1388
|
| Prop | Type |
|
|
1379
1389
|
| ------------ | ----------------------------------------- |
|
|
1380
1390
|
| **`remove`** | <code>() => Promise<void></code> |
|
|
1381
1391
|
|
|
1382
1392
|
|
|
1383
|
-
|
|
1393
|
+
##### DownloadEvent
|
|
1384
1394
|
|
|
1385
1395
|
| Prop | Type | Description | Since |
|
|
1386
1396
|
| ------------- | ------------------------------------------------- | ---------------------------------------------- | ----- |
|
|
@@ -1388,49 +1398,49 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1388
1398
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | | |
|
|
1389
1399
|
|
|
1390
1400
|
|
|
1391
|
-
|
|
1401
|
+
##### NoNeedEvent
|
|
1392
1402
|
|
|
1393
1403
|
| Prop | Type | Description | Since |
|
|
1394
1404
|
| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
|
|
1395
1405
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
|
|
1396
1406
|
|
|
1397
1407
|
|
|
1398
|
-
|
|
1408
|
+
##### UpdateAvailableEvent
|
|
1399
1409
|
|
|
1400
1410
|
| Prop | Type | Description | Since |
|
|
1401
1411
|
| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
|
|
1402
1412
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
|
|
1403
1413
|
|
|
1404
1414
|
|
|
1405
|
-
|
|
1415
|
+
##### DownloadCompleteEvent
|
|
1406
1416
|
|
|
1407
1417
|
| Prop | Type | Description | Since |
|
|
1408
1418
|
| ------------ | ------------------------------------------------- | ------------------------------------ | ----- |
|
|
1409
1419
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a new update is available. | 4.0.0 |
|
|
1410
1420
|
|
|
1411
1421
|
|
|
1412
|
-
|
|
1422
|
+
##### MajorAvailableEvent
|
|
1413
1423
|
|
|
1414
1424
|
| Prop | Type | Description | Since |
|
|
1415
1425
|
| ------------- | ------------------- | ----------------------------------------- | ----- |
|
|
1416
1426
|
| **`version`** | <code>string</code> | Emit when a breaking update is available. | 4.0.0 |
|
|
1417
1427
|
|
|
1418
1428
|
|
|
1419
|
-
|
|
1429
|
+
##### UpdateFailedEvent
|
|
1420
1430
|
|
|
1421
1431
|
| Prop | Type | Description | Since |
|
|
1422
1432
|
| ------------ | ------------------------------------------------- | ------------------------------------- | ----- |
|
|
1423
1433
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a update failed to install. | 4.0.0 |
|
|
1424
1434
|
|
|
1425
1435
|
|
|
1426
|
-
|
|
1436
|
+
##### DownloadFailedEvent
|
|
1427
1437
|
|
|
1428
1438
|
| Prop | Type | Description | Since |
|
|
1429
1439
|
| ------------- | ------------------- | -------------------------- | ----- |
|
|
1430
1440
|
| **`version`** | <code>string</code> | Emit when a download fail. | 4.0.0 |
|
|
1431
1441
|
|
|
1432
1442
|
|
|
1433
|
-
|
|
1443
|
+
##### AppReadyEvent
|
|
1434
1444
|
|
|
1435
1445
|
| Prop | Type | Description | Since |
|
|
1436
1446
|
| ------------ | ------------------------------------------------- | ------------------------------------- | ----- |
|
|
@@ -1438,45 +1448,45 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1438
1448
|
| **`status`** | <code>string</code> | | |
|
|
1439
1449
|
|
|
1440
1450
|
|
|
1441
|
-
|
|
1451
|
+
##### AutoUpdateAvailable
|
|
1442
1452
|
|
|
1443
1453
|
| Prop | Type |
|
|
1444
1454
|
| --------------- | -------------------- |
|
|
1445
1455
|
| **`available`** | <code>boolean</code> |
|
|
1446
1456
|
|
|
1447
1457
|
|
|
1448
|
-
|
|
1458
|
+
##### SetShakeMenuOptions
|
|
1449
1459
|
|
|
1450
1460
|
| Prop | Type |
|
|
1451
1461
|
| ------------- | -------------------- |
|
|
1452
1462
|
| **`enabled`** | <code>boolean</code> |
|
|
1453
1463
|
|
|
1454
1464
|
|
|
1455
|
-
|
|
1465
|
+
##### ShakeMenuEnabled
|
|
1456
1466
|
|
|
1457
1467
|
| Prop | Type |
|
|
1458
1468
|
| ------------- | -------------------- |
|
|
1459
1469
|
| **`enabled`** | <code>boolean</code> |
|
|
1460
1470
|
|
|
1461
1471
|
|
|
1462
|
-
|
|
1472
|
+
##### GetAppIdRes
|
|
1463
1473
|
|
|
1464
1474
|
| Prop | Type |
|
|
1465
1475
|
| ----------- | ------------------- |
|
|
1466
1476
|
| **`appId`** | <code>string</code> |
|
|
1467
1477
|
|
|
1468
1478
|
|
|
1469
|
-
|
|
1479
|
+
##### SetAppIdOptions
|
|
1470
1480
|
|
|
1471
1481
|
| Prop | Type |
|
|
1472
1482
|
| ----------- | ------------------- |
|
|
1473
1483
|
| **`appId`** | <code>string</code> |
|
|
1474
1484
|
|
|
1475
1485
|
|
|
1476
|
-
|
|
1486
|
+
#### Type Aliases
|
|
1477
1487
|
|
|
1478
1488
|
|
|
1479
|
-
|
|
1489
|
+
##### BundleStatus
|
|
1480
1490
|
|
|
1481
1491
|
pending: The bundle is pending to be **SET** as the next bundle.
|
|
1482
1492
|
downloading: The bundle is being downloaded.
|
|
@@ -1486,12 +1496,12 @@ error: The bundle has failed to download.
|
|
|
1486
1496
|
<code>'success' | 'error' | 'pending' | 'downloading'</code>
|
|
1487
1497
|
|
|
1488
1498
|
|
|
1489
|
-
|
|
1499
|
+
##### DelayUntilNext
|
|
1490
1500
|
|
|
1491
1501
|
<code>'background' | 'kill' | 'nativeVersion' | 'date'</code>
|
|
1492
1502
|
|
|
1493
1503
|
|
|
1494
|
-
|
|
1504
|
+
##### BreakingAvailableEvent
|
|
1495
1505
|
|
|
1496
1506
|
Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.
|
|
1497
1507
|
|