@capgo/capacitor-updater 7.39.0 → 7.40.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/Package.swift +2 -2
- package/README.md +70 -199
- package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +54 -56
- package/android/src/main/java/ee/forgr/capacitor_updater/DeviceIdHelper.java +0 -6
- package/dist/docs.json +112 -668
- package/dist/esm/definitions.d.ts +23 -342
- package/dist/esm/definitions.js.map +1 -1
- package/dist/esm/history.js +2 -2
- package/dist/esm/history.js.map +1 -1
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +3 -2
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +4 -4
- package/dist/plugin.js.map +1 -1
- package/ios/Sources/CapacitorUpdaterPlugin/CapacitorUpdaterPlugin.swift +2 -2
- package/ios/Sources/CapacitorUpdaterPlugin/CapgoUpdater.swift +53 -57
- package/ios/Sources/CapacitorUpdaterPlugin/CryptoCipher.swift +1 -5
- package/package.json +6 -5
package/dist/docs.json
CHANGED
|
@@ -1091,6 +1091,35 @@
|
|
|
1091
1091
|
],
|
|
1092
1092
|
"slug": "addlistenerchannelprivate-"
|
|
1093
1093
|
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "addListener",
|
|
1096
|
+
"signature": "(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void) => Promise<PluginListenerHandle>",
|
|
1097
|
+
"parameters": [
|
|
1098
|
+
{
|
|
1099
|
+
"name": "eventName",
|
|
1100
|
+
"docs": "",
|
|
1101
|
+
"type": "'onFlexibleUpdateStateChange'"
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"name": "listenerFunc",
|
|
1105
|
+
"docs": "",
|
|
1106
|
+
"type": "(state: FlexibleUpdateState) => void"
|
|
1107
|
+
}
|
|
1108
|
+
],
|
|
1109
|
+
"returns": "Promise<PluginListenerHandle>",
|
|
1110
|
+
"tags": [
|
|
1111
|
+
{
|
|
1112
|
+
"name": "since",
|
|
1113
|
+
"text": "8.0.0"
|
|
1114
|
+
}
|
|
1115
|
+
],
|
|
1116
|
+
"docs": "Listen for flexible update state changes on Android.\n\nThis event fires during the flexible update download process, providing:\n- Download progress (bytes downloaded / total bytes)\n- Installation status changes\n\n**Install status values:**\n- `UNKNOWN` (0): Unknown status\n- `PENDING` (1): Download pending\n- `DOWNLOADING` (2): Download in progress\n- `INSTALLING` (3): Installing the update\n- `INSTALLED` (4): Update installed (app restart needed)\n- `FAILED` (5): Update failed\n- `CANCELED` (6): Update was canceled\n- `DOWNLOADED` (11): Download complete, ready to install\n\nWhen status is `DOWNLOADED`, you should prompt the user and call\n{@link completeFlexibleUpdate} to finish the installation.",
|
|
1117
|
+
"complexTypes": [
|
|
1118
|
+
"PluginListenerHandle",
|
|
1119
|
+
"FlexibleUpdateState"
|
|
1120
|
+
],
|
|
1121
|
+
"slug": "addlisteneronflexibleupdatestatechange-"
|
|
1122
|
+
},
|
|
1094
1123
|
{
|
|
1095
1124
|
"name": "isAutoUpdateAvailable",
|
|
1096
1125
|
"signature": "() => Promise<AutoUpdateAvailable>",
|
|
@@ -1433,35 +1462,6 @@
|
|
|
1433
1462
|
"docs": "Complete a flexible in-app update on Android.\n\nAfter a flexible update has been downloaded (status `DOWNLOADED` in\n`onFlexibleUpdateStateChange`), call this method to install the update\nand restart the app.\n\n**Important:** This will immediately restart the app. Make sure to:\n- Save any user data before calling\n- Prompt the user before restarting\n- Only call when the download status is `DOWNLOADED`",
|
|
1434
1463
|
"complexTypes": [],
|
|
1435
1464
|
"slug": "completeflexibleupdate"
|
|
1436
|
-
},
|
|
1437
|
-
{
|
|
1438
|
-
"name": "addListener",
|
|
1439
|
-
"signature": "(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void) => Promise<PluginListenerHandle>",
|
|
1440
|
-
"parameters": [
|
|
1441
|
-
{
|
|
1442
|
-
"name": "eventName",
|
|
1443
|
-
"docs": "",
|
|
1444
|
-
"type": "'onFlexibleUpdateStateChange'"
|
|
1445
|
-
},
|
|
1446
|
-
{
|
|
1447
|
-
"name": "listenerFunc",
|
|
1448
|
-
"docs": "",
|
|
1449
|
-
"type": "(state: FlexibleUpdateState) => void"
|
|
1450
|
-
}
|
|
1451
|
-
],
|
|
1452
|
-
"returns": "Promise<PluginListenerHandle>",
|
|
1453
|
-
"tags": [
|
|
1454
|
-
{
|
|
1455
|
-
"name": "since",
|
|
1456
|
-
"text": "8.0.0"
|
|
1457
|
-
}
|
|
1458
|
-
],
|
|
1459
|
-
"docs": "Listen for flexible update state changes on Android.\n\nThis event fires during the flexible update download process, providing:\n- Download progress (bytes downloaded / total bytes)\n- Installation status changes\n\n**Install status values:**\n- `UNKNOWN` (0): Unknown status\n- `PENDING` (1): Download pending\n- `DOWNLOADING` (2): Download in progress\n- `INSTALLING` (3): Installing the update\n- `INSTALLED` (4): Update installed (app restart needed)\n- `FAILED` (5): Update failed\n- `CANCELED` (6): Update was canceled\n- `DOWNLOADED` (11): Download complete, ready to install\n\nWhen status is `DOWNLOADED`, you should prompt the user and call\n{@link completeFlexibleUpdate} to finish the installation.",
|
|
1460
|
-
"complexTypes": [
|
|
1461
|
-
"PluginListenerHandle",
|
|
1462
|
-
"FlexibleUpdateState"
|
|
1463
|
-
],
|
|
1464
|
-
"slug": "addlisteneronflexibleupdatestatechange-"
|
|
1465
1465
|
}
|
|
1466
1466
|
],
|
|
1467
1467
|
"properties": []
|
|
@@ -2514,6 +2514,58 @@
|
|
|
2514
2514
|
}
|
|
2515
2515
|
]
|
|
2516
2516
|
},
|
|
2517
|
+
{
|
|
2518
|
+
"name": "FlexibleUpdateState",
|
|
2519
|
+
"slug": "flexibleupdatestate",
|
|
2520
|
+
"docs": "State information for flexible update progress (Android only).",
|
|
2521
|
+
"tags": [
|
|
2522
|
+
{
|
|
2523
|
+
"text": "8.0.0",
|
|
2524
|
+
"name": "since"
|
|
2525
|
+
}
|
|
2526
|
+
],
|
|
2527
|
+
"methods": [],
|
|
2528
|
+
"properties": [
|
|
2529
|
+
{
|
|
2530
|
+
"name": "installStatus",
|
|
2531
|
+
"tags": [
|
|
2532
|
+
{
|
|
2533
|
+
"text": "8.0.0",
|
|
2534
|
+
"name": "since"
|
|
2535
|
+
}
|
|
2536
|
+
],
|
|
2537
|
+
"docs": "The current installation status.",
|
|
2538
|
+
"complexTypes": [
|
|
2539
|
+
"FlexibleUpdateInstallStatus"
|
|
2540
|
+
],
|
|
2541
|
+
"type": "FlexibleUpdateInstallStatus"
|
|
2542
|
+
},
|
|
2543
|
+
{
|
|
2544
|
+
"name": "bytesDownloaded",
|
|
2545
|
+
"tags": [
|
|
2546
|
+
{
|
|
2547
|
+
"text": "8.0.0",
|
|
2548
|
+
"name": "since"
|
|
2549
|
+
}
|
|
2550
|
+
],
|
|
2551
|
+
"docs": "Number of bytes downloaded so far.\nOnly available during the `DOWNLOADING` status.",
|
|
2552
|
+
"complexTypes": [],
|
|
2553
|
+
"type": "number | undefined"
|
|
2554
|
+
},
|
|
2555
|
+
{
|
|
2556
|
+
"name": "totalBytesToDownload",
|
|
2557
|
+
"tags": [
|
|
2558
|
+
{
|
|
2559
|
+
"text": "8.0.0",
|
|
2560
|
+
"name": "since"
|
|
2561
|
+
}
|
|
2562
|
+
],
|
|
2563
|
+
"docs": "Total number of bytes to download.\nOnly available during the `DOWNLOADING` status.",
|
|
2564
|
+
"complexTypes": [],
|
|
2565
|
+
"type": "number | undefined"
|
|
2566
|
+
}
|
|
2567
|
+
]
|
|
2568
|
+
},
|
|
2517
2569
|
{
|
|
2518
2570
|
"name": "AutoUpdateAvailable",
|
|
2519
2571
|
"slug": "autoupdateavailable",
|
|
@@ -2847,91 +2899,9 @@
|
|
|
2847
2899
|
"type": "AppUpdateResultCode"
|
|
2848
2900
|
}
|
|
2849
2901
|
]
|
|
2850
|
-
},
|
|
2851
|
-
{
|
|
2852
|
-
"name": "FlexibleUpdateState",
|
|
2853
|
-
"slug": "flexibleupdatestate",
|
|
2854
|
-
"docs": "State information for flexible update progress (Android only).",
|
|
2855
|
-
"tags": [
|
|
2856
|
-
{
|
|
2857
|
-
"text": "8.0.0",
|
|
2858
|
-
"name": "since"
|
|
2859
|
-
}
|
|
2860
|
-
],
|
|
2861
|
-
"methods": [],
|
|
2862
|
-
"properties": [
|
|
2863
|
-
{
|
|
2864
|
-
"name": "installStatus",
|
|
2865
|
-
"tags": [
|
|
2866
|
-
{
|
|
2867
|
-
"text": "8.0.0",
|
|
2868
|
-
"name": "since"
|
|
2869
|
-
}
|
|
2870
|
-
],
|
|
2871
|
-
"docs": "The current installation status.",
|
|
2872
|
-
"complexTypes": [
|
|
2873
|
-
"FlexibleUpdateInstallStatus"
|
|
2874
|
-
],
|
|
2875
|
-
"type": "FlexibleUpdateInstallStatus"
|
|
2876
|
-
},
|
|
2877
|
-
{
|
|
2878
|
-
"name": "bytesDownloaded",
|
|
2879
|
-
"tags": [
|
|
2880
|
-
{
|
|
2881
|
-
"text": "8.0.0",
|
|
2882
|
-
"name": "since"
|
|
2883
|
-
}
|
|
2884
|
-
],
|
|
2885
|
-
"docs": "Number of bytes downloaded so far.\nOnly available during the `DOWNLOADING` status.",
|
|
2886
|
-
"complexTypes": [],
|
|
2887
|
-
"type": "number | undefined"
|
|
2888
|
-
},
|
|
2889
|
-
{
|
|
2890
|
-
"name": "totalBytesToDownload",
|
|
2891
|
-
"tags": [
|
|
2892
|
-
{
|
|
2893
|
-
"text": "8.0.0",
|
|
2894
|
-
"name": "since"
|
|
2895
|
-
}
|
|
2896
|
-
],
|
|
2897
|
-
"docs": "Total number of bytes to download.\nOnly available during the `DOWNLOADING` status.",
|
|
2898
|
-
"complexTypes": [],
|
|
2899
|
-
"type": "number | undefined"
|
|
2900
|
-
}
|
|
2901
|
-
]
|
|
2902
2902
|
}
|
|
2903
2903
|
],
|
|
2904
2904
|
"enums": [
|
|
2905
|
-
{
|
|
2906
|
-
"name": "AppUpdateAvailability",
|
|
2907
|
-
"slug": "appupdateavailability",
|
|
2908
|
-
"members": [
|
|
2909
|
-
{
|
|
2910
|
-
"name": "UNKNOWN",
|
|
2911
|
-
"value": "0",
|
|
2912
|
-
"tags": [],
|
|
2913
|
-
"docs": "Update availability is unknown.\nThis typically means the check hasn't completed or failed."
|
|
2914
|
-
},
|
|
2915
|
-
{
|
|
2916
|
-
"name": "UPDATE_NOT_AVAILABLE",
|
|
2917
|
-
"value": "1",
|
|
2918
|
-
"tags": [],
|
|
2919
|
-
"docs": "No update is available.\nThe installed version is the latest."
|
|
2920
|
-
},
|
|
2921
|
-
{
|
|
2922
|
-
"name": "UPDATE_AVAILABLE",
|
|
2923
|
-
"value": "2",
|
|
2924
|
-
"tags": [],
|
|
2925
|
-
"docs": "An update is available for download."
|
|
2926
|
-
},
|
|
2927
|
-
{
|
|
2928
|
-
"name": "UPDATE_IN_PROGRESS",
|
|
2929
|
-
"value": "3",
|
|
2930
|
-
"tags": [],
|
|
2931
|
-
"docs": "An update is currently being downloaded or installed."
|
|
2932
|
-
}
|
|
2933
|
-
]
|
|
2934
|
-
},
|
|
2935
2905
|
{
|
|
2936
2906
|
"name": "FlexibleUpdateInstallStatus",
|
|
2937
2907
|
"slug": "flexibleupdateinstallstatus",
|
|
@@ -2986,6 +2956,36 @@
|
|
|
2986
2956
|
}
|
|
2987
2957
|
]
|
|
2988
2958
|
},
|
|
2959
|
+
{
|
|
2960
|
+
"name": "AppUpdateAvailability",
|
|
2961
|
+
"slug": "appupdateavailability",
|
|
2962
|
+
"members": [
|
|
2963
|
+
{
|
|
2964
|
+
"name": "UNKNOWN",
|
|
2965
|
+
"value": "0",
|
|
2966
|
+
"tags": [],
|
|
2967
|
+
"docs": "Update availability is unknown.\nThis typically means the check hasn't completed or failed."
|
|
2968
|
+
},
|
|
2969
|
+
{
|
|
2970
|
+
"name": "UPDATE_NOT_AVAILABLE",
|
|
2971
|
+
"value": "1",
|
|
2972
|
+
"tags": [],
|
|
2973
|
+
"docs": "No update is available.\nThe installed version is the latest."
|
|
2974
|
+
},
|
|
2975
|
+
{
|
|
2976
|
+
"name": "UPDATE_AVAILABLE",
|
|
2977
|
+
"value": "2",
|
|
2978
|
+
"tags": [],
|
|
2979
|
+
"docs": "An update is available for download."
|
|
2980
|
+
},
|
|
2981
|
+
{
|
|
2982
|
+
"name": "UPDATE_IN_PROGRESS",
|
|
2983
|
+
"value": "3",
|
|
2984
|
+
"tags": [],
|
|
2985
|
+
"docs": "An update is currently being downloaded or installed."
|
|
2986
|
+
}
|
|
2987
|
+
]
|
|
2988
|
+
},
|
|
2989
2989
|
{
|
|
2990
2990
|
"name": "AppUpdateResultCode",
|
|
2991
2991
|
"slug": "appupdateresultcode",
|
|
@@ -3090,561 +3090,5 @@
|
|
|
3090
3090
|
]
|
|
3091
3091
|
}
|
|
3092
3092
|
],
|
|
3093
|
-
"pluginConfigs": [
|
|
3094
|
-
{
|
|
3095
|
-
"name": "CapacitorUpdater",
|
|
3096
|
-
"slug": "capacitorupdater",
|
|
3097
|
-
"properties": [
|
|
3098
|
-
{
|
|
3099
|
-
"name": "appReadyTimeout",
|
|
3100
|
-
"tags": [
|
|
3101
|
-
{
|
|
3102
|
-
"text": "10000 // (10 seconds)",
|
|
3103
|
-
"name": "default"
|
|
3104
|
-
},
|
|
3105
|
-
{
|
|
3106
|
-
"text": "1000 // (1 second, minimum 1000)",
|
|
3107
|
-
"name": "example"
|
|
3108
|
-
}
|
|
3109
|
-
],
|
|
3110
|
-
"docs": "Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n\nOnly available for Android and iOS.",
|
|
3111
|
-
"complexTypes": [],
|
|
3112
|
-
"type": "number | undefined"
|
|
3113
|
-
},
|
|
3114
|
-
{
|
|
3115
|
-
"name": "responseTimeout",
|
|
3116
|
-
"tags": [
|
|
3117
|
-
{
|
|
3118
|
-
"text": "20 // (20 second)",
|
|
3119
|
-
"name": "default"
|
|
3120
|
-
},
|
|
3121
|
-
{
|
|
3122
|
-
"text": "10 // (10 second)",
|
|
3123
|
-
"name": "example"
|
|
3124
|
-
}
|
|
3125
|
-
],
|
|
3126
|
-
"docs": "Configure the number of seconds the native plugin should wait before considering API timeout.\n\nOnly available for Android and iOS.",
|
|
3127
|
-
"complexTypes": [],
|
|
3128
|
-
"type": "number | undefined"
|
|
3129
|
-
},
|
|
3130
|
-
{
|
|
3131
|
-
"name": "autoDeleteFailed",
|
|
3132
|
-
"tags": [
|
|
3133
|
-
{
|
|
3134
|
-
"text": "true",
|
|
3135
|
-
"name": "default"
|
|
3136
|
-
},
|
|
3137
|
-
{
|
|
3138
|
-
"text": "false",
|
|
3139
|
-
"name": "example"
|
|
3140
|
-
}
|
|
3141
|
-
],
|
|
3142
|
-
"docs": "Configure whether the plugin should use automatically delete failed bundles.\n\nOnly available for Android and iOS.",
|
|
3143
|
-
"complexTypes": [],
|
|
3144
|
-
"type": "boolean | undefined"
|
|
3145
|
-
},
|
|
3146
|
-
{
|
|
3147
|
-
"name": "autoDeletePrevious",
|
|
3148
|
-
"tags": [
|
|
3149
|
-
{
|
|
3150
|
-
"text": "true",
|
|
3151
|
-
"name": "default"
|
|
3152
|
-
},
|
|
3153
|
-
{
|
|
3154
|
-
"text": "false",
|
|
3155
|
-
"name": "example"
|
|
3156
|
-
}
|
|
3157
|
-
],
|
|
3158
|
-
"docs": "Configure whether the plugin should use automatically delete previous bundles after a successful update.\n\nOnly available for Android and iOS.",
|
|
3159
|
-
"complexTypes": [],
|
|
3160
|
-
"type": "boolean | undefined"
|
|
3161
|
-
},
|
|
3162
|
-
{
|
|
3163
|
-
"name": "autoUpdate",
|
|
3164
|
-
"tags": [
|
|
3165
|
-
{
|
|
3166
|
-
"text": "true",
|
|
3167
|
-
"name": "default"
|
|
3168
|
-
},
|
|
3169
|
-
{
|
|
3170
|
-
"text": "false",
|
|
3171
|
-
"name": "example"
|
|
3172
|
-
}
|
|
3173
|
-
],
|
|
3174
|
-
"docs": "Configure whether the plugin should use Auto Update via an update server.\n\nOnly available for Android and iOS.",
|
|
3175
|
-
"complexTypes": [],
|
|
3176
|
-
"type": "boolean | undefined"
|
|
3177
|
-
},
|
|
3178
|
-
{
|
|
3179
|
-
"name": "resetWhenUpdate",
|
|
3180
|
-
"tags": [
|
|
3181
|
-
{
|
|
3182
|
-
"text": "true",
|
|
3183
|
-
"name": "default"
|
|
3184
|
-
},
|
|
3185
|
-
{
|
|
3186
|
-
"text": "false",
|
|
3187
|
-
"name": "example"
|
|
3188
|
-
}
|
|
3189
|
-
],
|
|
3190
|
-
"docs": "Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\nSetting this to false can broke the auto update flow if the user download from the store a native app bundle that is older than the current downloaded bundle. Upload will be prevented by channel setting downgrade_under_native.\nOnly available for Android and iOS.",
|
|
3191
|
-
"complexTypes": [],
|
|
3192
|
-
"type": "boolean | undefined"
|
|
3193
|
-
},
|
|
3194
|
-
{
|
|
3195
|
-
"name": "updateUrl",
|
|
3196
|
-
"tags": [
|
|
3197
|
-
{
|
|
3198
|
-
"text": "https://plugin.capgo.app/updates",
|
|
3199
|
-
"name": "default"
|
|
3200
|
-
},
|
|
3201
|
-
{
|
|
3202
|
-
"text": "https://example.com/api/auto_update",
|
|
3203
|
-
"name": "example"
|
|
3204
|
-
}
|
|
3205
|
-
],
|
|
3206
|
-
"docs": "Configure the URL / endpoint to which update checks are sent.\n\nOnly available for Android and iOS.",
|
|
3207
|
-
"complexTypes": [],
|
|
3208
|
-
"type": "string | undefined"
|
|
3209
|
-
},
|
|
3210
|
-
{
|
|
3211
|
-
"name": "channelUrl",
|
|
3212
|
-
"tags": [
|
|
3213
|
-
{
|
|
3214
|
-
"text": "https://plugin.capgo.app/channel_self",
|
|
3215
|
-
"name": "default"
|
|
3216
|
-
},
|
|
3217
|
-
{
|
|
3218
|
-
"text": "https://example.com/api/channel",
|
|
3219
|
-
"name": "example"
|
|
3220
|
-
}
|
|
3221
|
-
],
|
|
3222
|
-
"docs": "Configure the URL / endpoint for channel operations.\n\nOnly available for Android and iOS.",
|
|
3223
|
-
"complexTypes": [],
|
|
3224
|
-
"type": "string | undefined"
|
|
3225
|
-
},
|
|
3226
|
-
{
|
|
3227
|
-
"name": "statsUrl",
|
|
3228
|
-
"tags": [
|
|
3229
|
-
{
|
|
3230
|
-
"text": "https://plugin.capgo.app/stats",
|
|
3231
|
-
"name": "default"
|
|
3232
|
-
},
|
|
3233
|
-
{
|
|
3234
|
-
"text": "https://example.com/api/stats",
|
|
3235
|
-
"name": "example"
|
|
3236
|
-
}
|
|
3237
|
-
],
|
|
3238
|
-
"docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
|
|
3239
|
-
"complexTypes": [],
|
|
3240
|
-
"type": "string | undefined"
|
|
3241
|
-
},
|
|
3242
|
-
{
|
|
3243
|
-
"name": "publicKey",
|
|
3244
|
-
"tags": [
|
|
3245
|
-
{
|
|
3246
|
-
"text": "undefined",
|
|
3247
|
-
"name": "default"
|
|
3248
|
-
},
|
|
3249
|
-
{
|
|
3250
|
-
"text": "6.2.0",
|
|
3251
|
-
"name": "since"
|
|
3252
|
-
}
|
|
3253
|
-
],
|
|
3254
|
-
"docs": "Configure the public key for end to end live update encryption Version 2\n\nOnly available for Android and iOS.",
|
|
3255
|
-
"complexTypes": [],
|
|
3256
|
-
"type": "string | undefined"
|
|
3257
|
-
},
|
|
3258
|
-
{
|
|
3259
|
-
"name": "version",
|
|
3260
|
-
"tags": [
|
|
3261
|
-
{
|
|
3262
|
-
"text": "undefined",
|
|
3263
|
-
"name": "default"
|
|
3264
|
-
},
|
|
3265
|
-
{
|
|
3266
|
-
"text": "4.17.48",
|
|
3267
|
-
"name": "since"
|
|
3268
|
-
}
|
|
3269
|
-
],
|
|
3270
|
-
"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.",
|
|
3271
|
-
"complexTypes": [],
|
|
3272
|
-
"type": "string | undefined"
|
|
3273
|
-
},
|
|
3274
|
-
{
|
|
3275
|
-
"name": "directUpdate",
|
|
3276
|
-
"tags": [
|
|
3277
|
-
{
|
|
3278
|
-
"text": "false",
|
|
3279
|
-
"name": "default"
|
|
3280
|
-
},
|
|
3281
|
-
{
|
|
3282
|
-
"text": "5.1.0",
|
|
3283
|
-
"name": "since"
|
|
3284
|
-
}
|
|
3285
|
-
],
|
|
3286
|
-
"docs": "Configure when the plugin should direct install updates. Only for autoUpdate mode.\nWorks well for apps less than 10MB and with uploads done using --partial flag.\nZip or apps more than 10MB will be relatively slow for users to update.\n- false: Never do direct updates (use default behavior: download at start, set when backgrounded)\n- atInstall: Direct update only when app is installed, updated from store, otherwise act as directUpdate = false\n- onLaunch: Direct update only on app installed, updated from store or after app kill, otherwise act as directUpdate = false\n- always: Direct update in all previous cases (app installed, updated from store, after app kill or app resume), never act as directUpdate = false\n- true: (deprecated) Same as \"always\" for backward compatibility\n\nOnly available for Android and iOS.",
|
|
3287
|
-
"complexTypes": [],
|
|
3288
|
-
"type": "boolean | 'always' | 'atInstall' | 'onLaunch' | undefined"
|
|
3289
|
-
},
|
|
3290
|
-
{
|
|
3291
|
-
"name": "autoSplashscreen",
|
|
3292
|
-
"tags": [
|
|
3293
|
-
{
|
|
3294
|
-
"text": "false",
|
|
3295
|
-
"name": "default"
|
|
3296
|
-
},
|
|
3297
|
-
{
|
|
3298
|
-
"text": "7.6.0",
|
|
3299
|
-
"name": "since"
|
|
3300
|
-
}
|
|
3301
|
-
],
|
|
3302
|
-
"docs": "Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed.\nThis removes the need to manually listen for appReady events and call SplashScreen.hide().\nOnly works when directUpdate is set to \"atInstall\", \"always\", \"onLaunch\", or true.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\nRequires autoUpdate and directUpdate to be enabled.\n\nOnly available for Android and iOS.",
|
|
3303
|
-
"complexTypes": [],
|
|
3304
|
-
"type": "boolean | undefined"
|
|
3305
|
-
},
|
|
3306
|
-
{
|
|
3307
|
-
"name": "autoSplashscreenLoader",
|
|
3308
|
-
"tags": [
|
|
3309
|
-
{
|
|
3310
|
-
"text": "false",
|
|
3311
|
-
"name": "default"
|
|
3312
|
-
},
|
|
3313
|
-
{
|
|
3314
|
-
"text": "7.19.0",
|
|
3315
|
-
"name": "since"
|
|
3316
|
-
}
|
|
3317
|
-
],
|
|
3318
|
-
"docs": "Display a native loading indicator on top of the splashscreen while automatic direct updates are running.\nOnly takes effect when {@link autoSplashscreen} is enabled.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\n\nOnly available for Android and iOS.",
|
|
3319
|
-
"complexTypes": [],
|
|
3320
|
-
"type": "boolean | undefined"
|
|
3321
|
-
},
|
|
3322
|
-
{
|
|
3323
|
-
"name": "autoSplashscreenTimeout",
|
|
3324
|
-
"tags": [
|
|
3325
|
-
{
|
|
3326
|
-
"text": "10000 // (10 seconds)",
|
|
3327
|
-
"name": "default"
|
|
3328
|
-
},
|
|
3329
|
-
{
|
|
3330
|
-
"text": "7.19.0",
|
|
3331
|
-
"name": "since"
|
|
3332
|
-
}
|
|
3333
|
-
],
|
|
3334
|
-
"docs": "Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates.\nIf the timeout elapses, the update continues to download in the background while the splashscreen is dismissed.\nSet to `0` (zero) to disable the timeout.\nWhen the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch.\nRequires {@link autoSplashscreen} to be enabled.\n\nOnly available for Android and iOS.",
|
|
3335
|
-
"complexTypes": [],
|
|
3336
|
-
"type": "number | undefined"
|
|
3337
|
-
},
|
|
3338
|
-
{
|
|
3339
|
-
"name": "periodCheckDelay",
|
|
3340
|
-
"tags": [
|
|
3341
|
-
{
|
|
3342
|
-
"text": "0 (disabled)",
|
|
3343
|
-
"name": "default"
|
|
3344
|
-
},
|
|
3345
|
-
{
|
|
3346
|
-
"text": "3600 (1 hour)",
|
|
3347
|
-
"name": "example"
|
|
3348
|
-
},
|
|
3349
|
-
{
|
|
3350
|
-
"text": "86400 (24 hours)",
|
|
3351
|
-
"name": "example"
|
|
3352
|
-
}
|
|
3353
|
-
],
|
|
3354
|
-
"docs": "Configure the delay period for period update check. the unit is in seconds.\n\nOnly available for Android and iOS.\nCannot be less than 600 seconds (10 minutes).",
|
|
3355
|
-
"complexTypes": [],
|
|
3356
|
-
"type": "number | undefined"
|
|
3357
|
-
},
|
|
3358
|
-
{
|
|
3359
|
-
"name": "localS3",
|
|
3360
|
-
"tags": [
|
|
3361
|
-
{
|
|
3362
|
-
"text": "undefined",
|
|
3363
|
-
"name": "default"
|
|
3364
|
-
},
|
|
3365
|
-
{
|
|
3366
|
-
"text": "4.17.48",
|
|
3367
|
-
"name": "since"
|
|
3368
|
-
}
|
|
3369
|
-
],
|
|
3370
|
-
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
3371
|
-
"complexTypes": [],
|
|
3372
|
-
"type": "boolean | undefined"
|
|
3373
|
-
},
|
|
3374
|
-
{
|
|
3375
|
-
"name": "localHost",
|
|
3376
|
-
"tags": [
|
|
3377
|
-
{
|
|
3378
|
-
"text": "undefined",
|
|
3379
|
-
"name": "default"
|
|
3380
|
-
},
|
|
3381
|
-
{
|
|
3382
|
-
"text": "4.17.48",
|
|
3383
|
-
"name": "since"
|
|
3384
|
-
}
|
|
3385
|
-
],
|
|
3386
|
-
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
3387
|
-
"complexTypes": [],
|
|
3388
|
-
"type": "string | undefined"
|
|
3389
|
-
},
|
|
3390
|
-
{
|
|
3391
|
-
"name": "localWebHost",
|
|
3392
|
-
"tags": [
|
|
3393
|
-
{
|
|
3394
|
-
"text": "undefined",
|
|
3395
|
-
"name": "default"
|
|
3396
|
-
},
|
|
3397
|
-
{
|
|
3398
|
-
"text": "4.17.48",
|
|
3399
|
-
"name": "since"
|
|
3400
|
-
}
|
|
3401
|
-
],
|
|
3402
|
-
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
3403
|
-
"complexTypes": [],
|
|
3404
|
-
"type": "string | undefined"
|
|
3405
|
-
},
|
|
3406
|
-
{
|
|
3407
|
-
"name": "localSupa",
|
|
3408
|
-
"tags": [
|
|
3409
|
-
{
|
|
3410
|
-
"text": "undefined",
|
|
3411
|
-
"name": "default"
|
|
3412
|
-
},
|
|
3413
|
-
{
|
|
3414
|
-
"text": "4.17.48",
|
|
3415
|
-
"name": "since"
|
|
3416
|
-
}
|
|
3417
|
-
],
|
|
3418
|
-
"docs": "Configure the CLI to use a local server for testing or self-hosted update server.",
|
|
3419
|
-
"complexTypes": [],
|
|
3420
|
-
"type": "string | undefined"
|
|
3421
|
-
},
|
|
3422
|
-
{
|
|
3423
|
-
"name": "localSupaAnon",
|
|
3424
|
-
"tags": [
|
|
3425
|
-
{
|
|
3426
|
-
"text": "undefined",
|
|
3427
|
-
"name": "default"
|
|
3428
|
-
},
|
|
3429
|
-
{
|
|
3430
|
-
"text": "4.17.48",
|
|
3431
|
-
"name": "since"
|
|
3432
|
-
}
|
|
3433
|
-
],
|
|
3434
|
-
"docs": "Configure the CLI to use a local server for testing.",
|
|
3435
|
-
"complexTypes": [],
|
|
3436
|
-
"type": "string | undefined"
|
|
3437
|
-
},
|
|
3438
|
-
{
|
|
3439
|
-
"name": "localApi",
|
|
3440
|
-
"tags": [
|
|
3441
|
-
{
|
|
3442
|
-
"text": "undefined",
|
|
3443
|
-
"name": "default"
|
|
3444
|
-
},
|
|
3445
|
-
{
|
|
3446
|
-
"text": "6.3.3",
|
|
3447
|
-
"name": "since"
|
|
3448
|
-
}
|
|
3449
|
-
],
|
|
3450
|
-
"docs": "Configure the CLI to use a local api for testing.",
|
|
3451
|
-
"complexTypes": [],
|
|
3452
|
-
"type": "string | undefined"
|
|
3453
|
-
},
|
|
3454
|
-
{
|
|
3455
|
-
"name": "localApiFiles",
|
|
3456
|
-
"tags": [
|
|
3457
|
-
{
|
|
3458
|
-
"text": "undefined",
|
|
3459
|
-
"name": "default"
|
|
3460
|
-
},
|
|
3461
|
-
{
|
|
3462
|
-
"text": "6.3.3",
|
|
3463
|
-
"name": "since"
|
|
3464
|
-
}
|
|
3465
|
-
],
|
|
3466
|
-
"docs": "Configure the CLI to use a local file api for testing.",
|
|
3467
|
-
"complexTypes": [],
|
|
3468
|
-
"type": "string | undefined"
|
|
3469
|
-
},
|
|
3470
|
-
{
|
|
3471
|
-
"name": "allowModifyUrl",
|
|
3472
|
-
"tags": [
|
|
3473
|
-
{
|
|
3474
|
-
"text": "false",
|
|
3475
|
-
"name": "default"
|
|
3476
|
-
},
|
|
3477
|
-
{
|
|
3478
|
-
"text": "5.4.0",
|
|
3479
|
-
"name": "since"
|
|
3480
|
-
}
|
|
3481
|
-
],
|
|
3482
|
-
"docs": "Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.",
|
|
3483
|
-
"complexTypes": [],
|
|
3484
|
-
"type": "boolean | undefined"
|
|
3485
|
-
},
|
|
3486
|
-
{
|
|
3487
|
-
"name": "allowModifyAppId",
|
|
3488
|
-
"tags": [
|
|
3489
|
-
{
|
|
3490
|
-
"text": "false",
|
|
3491
|
-
"name": "default"
|
|
3492
|
-
},
|
|
3493
|
-
{
|
|
3494
|
-
"text": "7.14.0",
|
|
3495
|
-
"name": "since"
|
|
3496
|
-
}
|
|
3497
|
-
],
|
|
3498
|
-
"docs": "Allow the plugin to modify the appId dynamically from the JavaScript side.",
|
|
3499
|
-
"complexTypes": [],
|
|
3500
|
-
"type": "boolean | undefined"
|
|
3501
|
-
},
|
|
3502
|
-
{
|
|
3503
|
-
"name": "allowManualBundleError",
|
|
3504
|
-
"tags": [
|
|
3505
|
-
{
|
|
3506
|
-
"text": "false",
|
|
3507
|
-
"name": "default"
|
|
3508
|
-
},
|
|
3509
|
-
{
|
|
3510
|
-
"text": "7.20.0",
|
|
3511
|
-
"name": "since"
|
|
3512
|
-
}
|
|
3513
|
-
],
|
|
3514
|
-
"docs": "Allow marking bundles as errored from JavaScript while using manual update flows.\nWhen enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`.",
|
|
3515
|
-
"complexTypes": [],
|
|
3516
|
-
"type": "boolean | undefined"
|
|
3517
|
-
},
|
|
3518
|
-
{
|
|
3519
|
-
"name": "persistCustomId",
|
|
3520
|
-
"tags": [
|
|
3521
|
-
{
|
|
3522
|
-
"text": "false (will be true by default in a future major release v8.x.x)",
|
|
3523
|
-
"name": "default"
|
|
3524
|
-
},
|
|
3525
|
-
{
|
|
3526
|
-
"text": "7.17.3",
|
|
3527
|
-
"name": "since"
|
|
3528
|
-
}
|
|
3529
|
-
],
|
|
3530
|
-
"docs": "Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts.\n\nOnly available for Android and iOS.",
|
|
3531
|
-
"complexTypes": [],
|
|
3532
|
-
"type": "boolean | undefined"
|
|
3533
|
-
},
|
|
3534
|
-
{
|
|
3535
|
-
"name": "persistModifyUrl",
|
|
3536
|
-
"tags": [
|
|
3537
|
-
{
|
|
3538
|
-
"text": "false",
|
|
3539
|
-
"name": "default"
|
|
3540
|
-
},
|
|
3541
|
-
{
|
|
3542
|
-
"text": "7.20.0",
|
|
3543
|
-
"name": "since"
|
|
3544
|
-
}
|
|
3545
|
-
],
|
|
3546
|
-
"docs": "Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl},\n{@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts.\n\nOnly available for Android and iOS.",
|
|
3547
|
-
"complexTypes": [],
|
|
3548
|
-
"type": "boolean | undefined"
|
|
3549
|
-
},
|
|
3550
|
-
{
|
|
3551
|
-
"name": "allowSetDefaultChannel",
|
|
3552
|
-
"tags": [
|
|
3553
|
-
{
|
|
3554
|
-
"text": "true",
|
|
3555
|
-
"name": "default"
|
|
3556
|
-
},
|
|
3557
|
-
{
|
|
3558
|
-
"text": "7.34.0",
|
|
3559
|
-
"name": "since"
|
|
3560
|
-
}
|
|
3561
|
-
],
|
|
3562
|
-
"docs": "Allow or disallow the {@link CapacitorUpdaterPlugin.setChannel} method to modify the defaultChannel.\nWhen set to `false`, calling `setChannel()` will return an error with code `disabled_by_config`.",
|
|
3563
|
-
"complexTypes": [],
|
|
3564
|
-
"type": "boolean | undefined"
|
|
3565
|
-
},
|
|
3566
|
-
{
|
|
3567
|
-
"name": "defaultChannel",
|
|
3568
|
-
"tags": [
|
|
3569
|
-
{
|
|
3570
|
-
"text": "undefined",
|
|
3571
|
-
"name": "default"
|
|
3572
|
-
},
|
|
3573
|
-
{
|
|
3574
|
-
"text": "5.5.0",
|
|
3575
|
-
"name": "since"
|
|
3576
|
-
}
|
|
3577
|
-
],
|
|
3578
|
-
"docs": "Set the default channel for the app in the config. Case sensitive.\nThis will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.\nThis requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options",
|
|
3579
|
-
"complexTypes": [],
|
|
3580
|
-
"type": "string | undefined"
|
|
3581
|
-
},
|
|
3582
|
-
{
|
|
3583
|
-
"name": "appId",
|
|
3584
|
-
"tags": [
|
|
3585
|
-
{
|
|
3586
|
-
"text": "undefined",
|
|
3587
|
-
"name": "default"
|
|
3588
|
-
},
|
|
3589
|
-
{
|
|
3590
|
-
"text": "6.0.0",
|
|
3591
|
-
"name": "since"
|
|
3592
|
-
}
|
|
3593
|
-
],
|
|
3594
|
-
"docs": "Configure the app id for the app in the config.",
|
|
3595
|
-
"complexTypes": [],
|
|
3596
|
-
"type": "string | undefined"
|
|
3597
|
-
},
|
|
3598
|
-
{
|
|
3599
|
-
"name": "keepUrlPathAfterReload",
|
|
3600
|
-
"tags": [
|
|
3601
|
-
{
|
|
3602
|
-
"text": "false",
|
|
3603
|
-
"name": "default"
|
|
3604
|
-
},
|
|
3605
|
-
{
|
|
3606
|
-
"text": "6.8.0",
|
|
3607
|
-
"name": "since"
|
|
3608
|
-
}
|
|
3609
|
-
],
|
|
3610
|
-
"docs": "Configure the plugin to keep the URL path after a reload.\nWARNING: When a reload is triggered, 'window.history' will be cleared.",
|
|
3611
|
-
"complexTypes": [],
|
|
3612
|
-
"type": "boolean | undefined"
|
|
3613
|
-
},
|
|
3614
|
-
{
|
|
3615
|
-
"name": "disableJSLogging",
|
|
3616
|
-
"tags": [
|
|
3617
|
-
{
|
|
3618
|
-
"text": "false",
|
|
3619
|
-
"name": "default"
|
|
3620
|
-
},
|
|
3621
|
-
{
|
|
3622
|
-
"text": "7.3.0",
|
|
3623
|
-
"name": "since"
|
|
3624
|
-
}
|
|
3625
|
-
],
|
|
3626
|
-
"docs": "Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done",
|
|
3627
|
-
"complexTypes": [],
|
|
3628
|
-
"type": "boolean | undefined"
|
|
3629
|
-
},
|
|
3630
|
-
{
|
|
3631
|
-
"name": "shakeMenu",
|
|
3632
|
-
"tags": [
|
|
3633
|
-
{
|
|
3634
|
-
"text": "false",
|
|
3635
|
-
"name": "default"
|
|
3636
|
-
},
|
|
3637
|
-
{
|
|
3638
|
-
"text": "7.5.0",
|
|
3639
|
-
"name": "since"
|
|
3640
|
-
}
|
|
3641
|
-
],
|
|
3642
|
-
"docs": "Enable shake gesture to show update menu for debugging/testing purposes",
|
|
3643
|
-
"complexTypes": [],
|
|
3644
|
-
"type": "boolean | undefined"
|
|
3645
|
-
}
|
|
3646
|
-
],
|
|
3647
|
-
"docs": "CapacitorUpdater can be configured with these options:"
|
|
3648
|
-
}
|
|
3649
|
-
]
|
|
3093
|
+
"pluginConfigs": []
|
|
3650
3094
|
}
|