@capgo/capacitor-updater 6.14.33 → 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 +126 -125
- package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +43 -4
- package/dist/docs.json +3 -3
- package/dist/esm/definitions.d.ts +4 -3
- package/dist/esm/definitions.js.map +1 -1
- package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift +27 -2
- 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,7 +786,7 @@ 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>
|
|
@@ -807,7 +808,7 @@ The device ID now persists between app reinstalls to maintain consistent device
|
|
|
807
808
|
--------------------
|
|
808
809
|
|
|
809
810
|
|
|
810
|
-
|
|
811
|
+
#### getPluginVersion()
|
|
811
812
|
|
|
812
813
|
```typescript
|
|
813
814
|
getPluginVersion() => Promise<PluginVersion>
|
|
@@ -820,7 +821,7 @@ Get the native Capacitor Updater plugin version (sent to auto update server)
|
|
|
820
821
|
--------------------
|
|
821
822
|
|
|
822
823
|
|
|
823
|
-
|
|
824
|
+
#### isAutoUpdateEnabled()
|
|
824
825
|
|
|
825
826
|
```typescript
|
|
826
827
|
isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>
|
|
@@ -833,7 +834,7 @@ Get the state of auto update config.
|
|
|
833
834
|
--------------------
|
|
834
835
|
|
|
835
836
|
|
|
836
|
-
|
|
837
|
+
#### removeAllListeners()
|
|
837
838
|
|
|
838
839
|
```typescript
|
|
839
840
|
removeAllListeners() => Promise<void>
|
|
@@ -846,7 +847,7 @@ Remove all listeners for this plugin.
|
|
|
846
847
|
--------------------
|
|
847
848
|
|
|
848
849
|
|
|
849
|
-
|
|
850
|
+
#### addListener('download', ...)
|
|
850
851
|
|
|
851
852
|
```typescript
|
|
852
853
|
addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -867,7 +868,7 @@ This will return you all download percent during the download
|
|
|
867
868
|
--------------------
|
|
868
869
|
|
|
869
870
|
|
|
870
|
-
|
|
871
|
+
#### addListener('noNeedUpdate', ...)
|
|
871
872
|
|
|
872
873
|
```typescript
|
|
873
874
|
addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -887,7 +888,7 @@ Listen for no need to update event, useful when you want force check every time
|
|
|
887
888
|
--------------------
|
|
888
889
|
|
|
889
890
|
|
|
890
|
-
|
|
891
|
+
#### addListener('updateAvailable', ...)
|
|
891
892
|
|
|
892
893
|
```typescript
|
|
893
894
|
addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -907,7 +908,7 @@ Listen for available update event, useful when you want to force check every tim
|
|
|
907
908
|
--------------------
|
|
908
909
|
|
|
909
910
|
|
|
910
|
-
|
|
911
|
+
#### addListener('downloadComplete', ...)
|
|
911
912
|
|
|
912
913
|
```typescript
|
|
913
914
|
addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -927,7 +928,7 @@ Listen for downloadComplete events.
|
|
|
927
928
|
--------------------
|
|
928
929
|
|
|
929
930
|
|
|
930
|
-
|
|
931
|
+
#### addListener('breakingAvailable', ...)
|
|
931
932
|
|
|
932
933
|
```typescript
|
|
933
934
|
addListener(eventName: 'breakingAvailable', listenerFunc: (state: BreakingAvailableEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -948,7 +949,7 @@ Emits the same payload as the legacy `majorAvailable` listener.
|
|
|
948
949
|
--------------------
|
|
949
950
|
|
|
950
951
|
|
|
951
|
-
|
|
952
|
+
#### addListener('majorAvailable', ...)
|
|
952
953
|
|
|
953
954
|
```typescript
|
|
954
955
|
addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -968,7 +969,7 @@ Listen for Major update event in the App, let you know when major update is bloc
|
|
|
968
969
|
--------------------
|
|
969
970
|
|
|
970
971
|
|
|
971
|
-
|
|
972
|
+
#### addListener('updateFailed', ...)
|
|
972
973
|
|
|
973
974
|
```typescript
|
|
974
975
|
addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -988,7 +989,7 @@ Listen for update fail event in the App, let you know when update has fail to in
|
|
|
988
989
|
--------------------
|
|
989
990
|
|
|
990
991
|
|
|
991
|
-
|
|
992
|
+
#### addListener('downloadFailed', ...)
|
|
992
993
|
|
|
993
994
|
```typescript
|
|
994
995
|
addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -1008,7 +1009,7 @@ Listen for download fail event in the App, let you know when a bundle download h
|
|
|
1008
1009
|
--------------------
|
|
1009
1010
|
|
|
1010
1011
|
|
|
1011
|
-
|
|
1012
|
+
#### addListener('appReloaded', ...)
|
|
1012
1013
|
|
|
1013
1014
|
```typescript
|
|
1014
1015
|
addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
@@ -1028,7 +1029,7 @@ Listen for reload event in the App, let you know when reload has happened
|
|
|
1028
1029
|
--------------------
|
|
1029
1030
|
|
|
1030
1031
|
|
|
1031
|
-
|
|
1032
|
+
#### addListener('appReady', ...)
|
|
1032
1033
|
|
|
1033
1034
|
```typescript
|
|
1034
1035
|
addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>
|
|
@@ -1048,7 +1049,7 @@ Listen for app ready event in the App, let you know when app is ready to use, th
|
|
|
1048
1049
|
--------------------
|
|
1049
1050
|
|
|
1050
1051
|
|
|
1051
|
-
|
|
1052
|
+
#### isAutoUpdateAvailable()
|
|
1052
1053
|
|
|
1053
1054
|
```typescript
|
|
1054
1055
|
isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>
|
|
@@ -1061,7 +1062,7 @@ Get if auto update is available (not disabled by serverUrl).
|
|
|
1061
1062
|
--------------------
|
|
1062
1063
|
|
|
1063
1064
|
|
|
1064
|
-
|
|
1065
|
+
#### getNextBundle()
|
|
1065
1066
|
|
|
1066
1067
|
```typescript
|
|
1067
1068
|
getNextBundle() => Promise<BundleInfo | null>
|
|
@@ -1077,7 +1078,7 @@ Returns null if no next bundle is set.
|
|
|
1077
1078
|
--------------------
|
|
1078
1079
|
|
|
1079
1080
|
|
|
1080
|
-
|
|
1081
|
+
#### getFailedUpdate()
|
|
1081
1082
|
|
|
1082
1083
|
```typescript
|
|
1083
1084
|
getFailedUpdate() => Promise<UpdateFailedEvent | null>
|
|
@@ -1092,7 +1093,7 @@ Get the most recent update that failed to install, if any. The stored value is c
|
|
|
1092
1093
|
--------------------
|
|
1093
1094
|
|
|
1094
1095
|
|
|
1095
|
-
|
|
1096
|
+
#### setShakeMenu(...)
|
|
1096
1097
|
|
|
1097
1098
|
```typescript
|
|
1098
1099
|
setShakeMenu(options: SetShakeMenuOptions) => Promise<void>
|
|
@@ -1109,7 +1110,7 @@ Enable or disable the shake menu for debugging/testing purposes
|
|
|
1109
1110
|
--------------------
|
|
1110
1111
|
|
|
1111
1112
|
|
|
1112
|
-
|
|
1113
|
+
#### isShakeMenuEnabled()
|
|
1113
1114
|
|
|
1114
1115
|
```typescript
|
|
1115
1116
|
isShakeMenuEnabled() => Promise<ShakeMenuEnabled>
|
|
@@ -1124,7 +1125,7 @@ Get the current state of the shake menu
|
|
|
1124
1125
|
--------------------
|
|
1125
1126
|
|
|
1126
1127
|
|
|
1127
|
-
|
|
1128
|
+
#### getAppId()
|
|
1128
1129
|
|
|
1129
1130
|
```typescript
|
|
1130
1131
|
getAppId() => Promise<GetAppIdRes>
|
|
@@ -1139,7 +1140,7 @@ Get the configured App ID
|
|
|
1139
1140
|
--------------------
|
|
1140
1141
|
|
|
1141
1142
|
|
|
1142
|
-
|
|
1143
|
+
#### setAppId(...)
|
|
1143
1144
|
|
|
1144
1145
|
```typescript
|
|
1145
1146
|
setAppId(options: SetAppIdOptions) => Promise<void>
|
|
@@ -1156,17 +1157,17 @@ Set the App ID for the app (requires allowModifyAppId to be true in config)
|
|
|
1156
1157
|
--------------------
|
|
1157
1158
|
|
|
1158
1159
|
|
|
1159
|
-
|
|
1160
|
+
#### Interfaces
|
|
1160
1161
|
|
|
1161
1162
|
|
|
1162
|
-
|
|
1163
|
+
##### AppReadyResult
|
|
1163
1164
|
|
|
1164
1165
|
| Prop | Type |
|
|
1165
1166
|
| ------------ | ------------------------------------------------- |
|
|
1166
1167
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> |
|
|
1167
1168
|
|
|
1168
1169
|
|
|
1169
|
-
|
|
1170
|
+
##### BundleInfo
|
|
1170
1171
|
|
|
1171
1172
|
| Prop | Type |
|
|
1172
1173
|
| ---------------- | ----------------------------------------------------- |
|
|
@@ -1177,28 +1178,28 @@ Set the App ID for the app (requires allowModifyAppId to be true in config)
|
|
|
1177
1178
|
| **`status`** | <code><a href="#bundlestatus">BundleStatus</a></code> |
|
|
1178
1179
|
|
|
1179
1180
|
|
|
1180
|
-
|
|
1181
|
+
##### UpdateUrl
|
|
1181
1182
|
|
|
1182
1183
|
| Prop | Type |
|
|
1183
1184
|
| --------- | ------------------- |
|
|
1184
1185
|
| **`url`** | <code>string</code> |
|
|
1185
1186
|
|
|
1186
1187
|
|
|
1187
|
-
|
|
1188
|
+
##### StatsUrl
|
|
1188
1189
|
|
|
1189
1190
|
| Prop | Type |
|
|
1190
1191
|
| --------- | ------------------- |
|
|
1191
1192
|
| **`url`** | <code>string</code> |
|
|
1192
1193
|
|
|
1193
1194
|
|
|
1194
|
-
|
|
1195
|
+
##### ChannelUrl
|
|
1195
1196
|
|
|
1196
1197
|
| Prop | Type |
|
|
1197
1198
|
| --------- | ------------------- |
|
|
1198
1199
|
| **`url`** | <code>string</code> |
|
|
1199
1200
|
|
|
1200
1201
|
|
|
1201
|
-
|
|
1202
|
+
##### DownloadOptions
|
|
1202
1203
|
|
|
1203
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.
|
|
1204
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.
|
|
@@ -1212,7 +1213,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1212
1213
|
| **`manifest`** | <code>ManifestEntry[]</code> | The manifest for multi-file downloads | <code>undefined</code> | 6.1.0 |
|
|
1213
1214
|
|
|
1214
1215
|
|
|
1215
|
-
|
|
1216
|
+
##### ManifestEntry
|
|
1216
1217
|
|
|
1217
1218
|
| Prop | Type |
|
|
1218
1219
|
| ------------------ | --------------------------- |
|
|
@@ -1221,35 +1222,35 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1221
1222
|
| **`download_url`** | <code>string \| null</code> |
|
|
1222
1223
|
|
|
1223
1224
|
|
|
1224
|
-
|
|
1225
|
+
##### BundleId
|
|
1225
1226
|
|
|
1226
1227
|
| Prop | Type |
|
|
1227
1228
|
| -------- | ------------------- |
|
|
1228
1229
|
| **`id`** | <code>string</code> |
|
|
1229
1230
|
|
|
1230
1231
|
|
|
1231
|
-
|
|
1232
|
+
##### BundleListResult
|
|
1232
1233
|
|
|
1233
1234
|
| Prop | Type |
|
|
1234
1235
|
| ------------- | ------------------------- |
|
|
1235
1236
|
| **`bundles`** | <code>BundleInfo[]</code> |
|
|
1236
1237
|
|
|
1237
1238
|
|
|
1238
|
-
|
|
1239
|
+
##### ListOptions
|
|
1239
1240
|
|
|
1240
1241
|
| Prop | Type | Description | Default | Since |
|
|
1241
1242
|
| --------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------ |
|
|
1242
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 |
|
|
1243
1244
|
|
|
1244
1245
|
|
|
1245
|
-
|
|
1246
|
+
##### ResetOptions
|
|
1246
1247
|
|
|
1247
1248
|
| Prop | Type |
|
|
1248
1249
|
| ---------------------- | -------------------- |
|
|
1249
1250
|
| **`toLastSuccessful`** | <code>boolean</code> |
|
|
1250
1251
|
|
|
1251
1252
|
|
|
1252
|
-
|
|
1253
|
+
##### CurrentBundleResult
|
|
1253
1254
|
|
|
1254
1255
|
| Prop | Type |
|
|
1255
1256
|
| ------------ | ------------------------------------------------- |
|
|
@@ -1257,14 +1258,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1257
1258
|
| **`native`** | <code>string</code> |
|
|
1258
1259
|
|
|
1259
1260
|
|
|
1260
|
-
|
|
1261
|
+
##### MultiDelayConditions
|
|
1261
1262
|
|
|
1262
1263
|
| Prop | Type |
|
|
1263
1264
|
| --------------------- | ----------------------------- |
|
|
1264
1265
|
| **`delayConditions`** | <code>DelayCondition[]</code> |
|
|
1265
1266
|
|
|
1266
1267
|
|
|
1267
|
-
|
|
1268
|
+
##### DelayCondition
|
|
1268
1269
|
|
|
1269
1270
|
| Prop | Type | Description |
|
|
1270
1271
|
| ----------- | --------------------------------------------------------- | ---------------------------------------- |
|
|
@@ -1272,7 +1273,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1272
1273
|
| **`value`** | <code>string</code> | |
|
|
1273
1274
|
|
|
1274
1275
|
|
|
1275
|
-
|
|
1276
|
+
##### LatestVersion
|
|
1276
1277
|
|
|
1277
1278
|
| Prop | Type | Description | Since |
|
|
1278
1279
|
| ---------------- | ---------------------------- | -------------------------------------------------------------------- | ------ |
|
|
@@ -1288,14 +1289,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1288
1289
|
| **`manifest`** | <code>ManifestEntry[]</code> | | 6.1 |
|
|
1289
1290
|
|
|
1290
1291
|
|
|
1291
|
-
|
|
1292
|
+
##### GetLatestOptions
|
|
1292
1293
|
|
|
1293
1294
|
| Prop | Type | Description | Default | Since |
|
|
1294
1295
|
| ------------- | ------------------- | ----------------------------------------------------------------------------------------------- | ---------------------- | ----- |
|
|
1295
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 |
|
|
1296
1297
|
|
|
1297
1298
|
|
|
1298
|
-
|
|
1299
|
+
##### ChannelRes
|
|
1299
1300
|
|
|
1300
1301
|
| Prop | Type | Description | Since |
|
|
1301
1302
|
| ------------- | ------------------- | ----------------------------- | ----- |
|
|
@@ -1304,7 +1305,7 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1304
1305
|
| **`message`** | <code>string</code> | | |
|
|
1305
1306
|
|
|
1306
1307
|
|
|
1307
|
-
|
|
1308
|
+
##### SetChannelOptions
|
|
1308
1309
|
|
|
1309
1310
|
| Prop | Type |
|
|
1310
1311
|
| ----------------------- | -------------------- |
|
|
@@ -1312,14 +1313,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1312
1313
|
| **`triggerAutoUpdate`** | <code>boolean</code> |
|
|
1313
1314
|
|
|
1314
1315
|
|
|
1315
|
-
|
|
1316
|
+
##### UnsetChannelOptions
|
|
1316
1317
|
|
|
1317
1318
|
| Prop | Type |
|
|
1318
1319
|
| ----------------------- | -------------------- |
|
|
1319
1320
|
| **`triggerAutoUpdate`** | <code>boolean</code> |
|
|
1320
1321
|
|
|
1321
1322
|
|
|
1322
|
-
|
|
1323
|
+
##### GetChannelRes
|
|
1323
1324
|
|
|
1324
1325
|
| Prop | Type | Description | Since |
|
|
1325
1326
|
| -------------- | -------------------- | ----------------------------- | ----- |
|
|
@@ -1330,14 +1331,14 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1330
1331
|
| **`allowSet`** | <code>boolean</code> | | |
|
|
1331
1332
|
|
|
1332
1333
|
|
|
1333
|
-
|
|
1334
|
+
##### ListChannelsResult
|
|
1334
1335
|
|
|
1335
1336
|
| Prop | Type | Description | Since |
|
|
1336
1337
|
| -------------- | -------------------------- | -------------------------- | ----- |
|
|
1337
1338
|
| **`channels`** | <code>ChannelInfo[]</code> | List of available channels | 7.5.0 |
|
|
1338
1339
|
|
|
1339
1340
|
|
|
1340
|
-
|
|
1341
|
+
##### ChannelInfo
|
|
1341
1342
|
|
|
1342
1343
|
| Prop | Type | Description | Since |
|
|
1343
1344
|
| -------------------- | -------------------- | ----------------------------------------------- | ----- |
|
|
@@ -1347,49 +1348,49 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1347
1348
|
| **`allow_self_set`** | <code>boolean</code> | Whether devices can self-assign to this channel | 7.5.0 |
|
|
1348
1349
|
|
|
1349
1350
|
|
|
1350
|
-
|
|
1351
|
+
##### SetCustomIdOptions
|
|
1351
1352
|
|
|
1352
1353
|
| Prop | Type | Description |
|
|
1353
1354
|
| -------------- | ------------------- | --------------------------------------------------------------------------------------------- |
|
|
1354
1355
|
| **`customId`** | <code>string</code> | Custom identifier to associate with the device. Use an empty string to clear any saved value. |
|
|
1355
1356
|
|
|
1356
1357
|
|
|
1357
|
-
|
|
1358
|
+
##### BuiltinVersion
|
|
1358
1359
|
|
|
1359
1360
|
| Prop | Type |
|
|
1360
1361
|
| ------------- | ------------------- |
|
|
1361
1362
|
| **`version`** | <code>string</code> |
|
|
1362
1363
|
|
|
1363
1364
|
|
|
1364
|
-
|
|
1365
|
+
##### DeviceId
|
|
1365
1366
|
|
|
1366
1367
|
| Prop | Type |
|
|
1367
1368
|
| -------------- | ------------------- |
|
|
1368
1369
|
| **`deviceId`** | <code>string</code> |
|
|
1369
1370
|
|
|
1370
1371
|
|
|
1371
|
-
|
|
1372
|
+
##### PluginVersion
|
|
1372
1373
|
|
|
1373
1374
|
| Prop | Type |
|
|
1374
1375
|
| ------------- | ------------------- |
|
|
1375
1376
|
| **`version`** | <code>string</code> |
|
|
1376
1377
|
|
|
1377
1378
|
|
|
1378
|
-
|
|
1379
|
+
##### AutoUpdateEnabled
|
|
1379
1380
|
|
|
1380
1381
|
| Prop | Type |
|
|
1381
1382
|
| ------------- | -------------------- |
|
|
1382
1383
|
| **`enabled`** | <code>boolean</code> |
|
|
1383
1384
|
|
|
1384
1385
|
|
|
1385
|
-
|
|
1386
|
+
##### PluginListenerHandle
|
|
1386
1387
|
|
|
1387
1388
|
| Prop | Type |
|
|
1388
1389
|
| ------------ | ----------------------------------------- |
|
|
1389
1390
|
| **`remove`** | <code>() => Promise<void></code> |
|
|
1390
1391
|
|
|
1391
1392
|
|
|
1392
|
-
|
|
1393
|
+
##### DownloadEvent
|
|
1393
1394
|
|
|
1394
1395
|
| Prop | Type | Description | Since |
|
|
1395
1396
|
| ------------- | ------------------------------------------------- | ---------------------------------------------- | ----- |
|
|
@@ -1397,49 +1398,49 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1397
1398
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | | |
|
|
1398
1399
|
|
|
1399
1400
|
|
|
1400
|
-
|
|
1401
|
+
##### NoNeedEvent
|
|
1401
1402
|
|
|
1402
1403
|
| Prop | Type | Description | Since |
|
|
1403
1404
|
| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
|
|
1404
1405
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
|
|
1405
1406
|
|
|
1406
1407
|
|
|
1407
|
-
|
|
1408
|
+
##### UpdateAvailableEvent
|
|
1408
1409
|
|
|
1409
1410
|
| Prop | Type | Description | Since |
|
|
1410
1411
|
| ------------ | ------------------------------------------------- | ---------------------------------------------- | ----- |
|
|
1411
1412
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Current status of download, between 0 and 100. | 4.0.0 |
|
|
1412
1413
|
|
|
1413
1414
|
|
|
1414
|
-
|
|
1415
|
+
##### DownloadCompleteEvent
|
|
1415
1416
|
|
|
1416
1417
|
| Prop | Type | Description | Since |
|
|
1417
1418
|
| ------------ | ------------------------------------------------- | ------------------------------------ | ----- |
|
|
1418
1419
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a new update is available. | 4.0.0 |
|
|
1419
1420
|
|
|
1420
1421
|
|
|
1421
|
-
|
|
1422
|
+
##### MajorAvailableEvent
|
|
1422
1423
|
|
|
1423
1424
|
| Prop | Type | Description | Since |
|
|
1424
1425
|
| ------------- | ------------------- | ----------------------------------------- | ----- |
|
|
1425
1426
|
| **`version`** | <code>string</code> | Emit when a breaking update is available. | 4.0.0 |
|
|
1426
1427
|
|
|
1427
1428
|
|
|
1428
|
-
|
|
1429
|
+
##### UpdateFailedEvent
|
|
1429
1430
|
|
|
1430
1431
|
| Prop | Type | Description | Since |
|
|
1431
1432
|
| ------------ | ------------------------------------------------- | ------------------------------------- | ----- |
|
|
1432
1433
|
| **`bundle`** | <code><a href="#bundleinfo">BundleInfo</a></code> | Emit when a update failed to install. | 4.0.0 |
|
|
1433
1434
|
|
|
1434
1435
|
|
|
1435
|
-
|
|
1436
|
+
##### DownloadFailedEvent
|
|
1436
1437
|
|
|
1437
1438
|
| Prop | Type | Description | Since |
|
|
1438
1439
|
| ------------- | ------------------- | -------------------------- | ----- |
|
|
1439
1440
|
| **`version`** | <code>string</code> | Emit when a download fail. | 4.0.0 |
|
|
1440
1441
|
|
|
1441
1442
|
|
|
1442
|
-
|
|
1443
|
+
##### AppReadyEvent
|
|
1443
1444
|
|
|
1444
1445
|
| Prop | Type | Description | Since |
|
|
1445
1446
|
| ------------ | ------------------------------------------------- | ------------------------------------- | ----- |
|
|
@@ -1447,45 +1448,45 @@ If you don't use backend, you need to provide the URL and version of the bundle.
|
|
|
1447
1448
|
| **`status`** | <code>string</code> | | |
|
|
1448
1449
|
|
|
1449
1450
|
|
|
1450
|
-
|
|
1451
|
+
##### AutoUpdateAvailable
|
|
1451
1452
|
|
|
1452
1453
|
| Prop | Type |
|
|
1453
1454
|
| --------------- | -------------------- |
|
|
1454
1455
|
| **`available`** | <code>boolean</code> |
|
|
1455
1456
|
|
|
1456
1457
|
|
|
1457
|
-
|
|
1458
|
+
##### SetShakeMenuOptions
|
|
1458
1459
|
|
|
1459
1460
|
| Prop | Type |
|
|
1460
1461
|
| ------------- | -------------------- |
|
|
1461
1462
|
| **`enabled`** | <code>boolean</code> |
|
|
1462
1463
|
|
|
1463
1464
|
|
|
1464
|
-
|
|
1465
|
+
##### ShakeMenuEnabled
|
|
1465
1466
|
|
|
1466
1467
|
| Prop | Type |
|
|
1467
1468
|
| ------------- | -------------------- |
|
|
1468
1469
|
| **`enabled`** | <code>boolean</code> |
|
|
1469
1470
|
|
|
1470
1471
|
|
|
1471
|
-
|
|
1472
|
+
##### GetAppIdRes
|
|
1472
1473
|
|
|
1473
1474
|
| Prop | Type |
|
|
1474
1475
|
| ----------- | ------------------- |
|
|
1475
1476
|
| **`appId`** | <code>string</code> |
|
|
1476
1477
|
|
|
1477
1478
|
|
|
1478
|
-
|
|
1479
|
+
##### SetAppIdOptions
|
|
1479
1480
|
|
|
1480
1481
|
| Prop | Type |
|
|
1481
1482
|
| ----------- | ------------------- |
|
|
1482
1483
|
| **`appId`** | <code>string</code> |
|
|
1483
1484
|
|
|
1484
1485
|
|
|
1485
|
-
|
|
1486
|
+
#### Type Aliases
|
|
1486
1487
|
|
|
1487
1488
|
|
|
1488
|
-
|
|
1489
|
+
##### BundleStatus
|
|
1489
1490
|
|
|
1490
1491
|
pending: The bundle is pending to be **SET** as the next bundle.
|
|
1491
1492
|
downloading: The bundle is being downloaded.
|
|
@@ -1495,12 +1496,12 @@ error: The bundle has failed to download.
|
|
|
1495
1496
|
<code>'success' | 'error' | 'pending' | 'downloading'</code>
|
|
1496
1497
|
|
|
1497
1498
|
|
|
1498
|
-
|
|
1499
|
+
##### DelayUntilNext
|
|
1499
1500
|
|
|
1500
1501
|
<code>'background' | 'kill' | 'nativeVersion' | 'date'</code>
|
|
1501
1502
|
|
|
1502
1503
|
|
|
1503
|
-
|
|
1504
|
+
##### BreakingAvailableEvent
|
|
1504
1505
|
|
|
1505
1506
|
Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.
|
|
1506
1507
|
|