Aller au contenu

Fonctions et paramètres

GitHub

Voir le Github Readme pour plus d’informations.

CapacitorUpdater peut être configuré avec ces options :

PropriétéTypeDescriptionPar défautDepuis
appReadyTimeoutnumberConfigurez le nombre de millisecondes que le plugin natif doit attendre avant de considérer qu'une mise à jour a « échoué ». Disponible sur Android, iOS et Electron.10000 // (10 seconds)
responseTimeoutnumberConfigurez le nombre de millisecondes que le plugin natif doit attendre avant de considérer un timeout API. Disponible sur Android, iOS et Electron.20000 // (20 seconds)
autoDeleteFailedbooleanConfigurez si le plugin doit supprimer automatiquement les bundles en échec. Disponible sur Android, iOS et Electron.true
autoDeletePreviousbooleanConfigurez si le plugin doit supprimer automatiquement les bundles précédents après une mise à jour réussie. Disponible sur Android, iOS et Electron.true
autoUpdateboolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’Configurez comment le plugin doit utiliser Auto Update via un serveur de mise à jour. true équivaut à « atBackground » ; false équivaut à « off ». - off : désactive Auto Update - atBackground : vérifie et télécharge automatiquement, puis applique quand l'app passe en arrière-plan - atInstall : applique immédiatement uniquement après une nouvelle installation ou une mise à jour de l'app native, sinon utilise atBackground - onLaunch : applique immédiatement au lancement, sinon utilise atBackground après la vérification au lancement - always : applique immédiatement à chaque exécution d'Auto Update - onlyDownload : vérifie et télécharge automatiquement, émet updateAvailable, et ne définit jamais le prochain bundle automatiquement. Les modes d'application instantanée (« atInstall », « onLaunch », « always ») doivent être envoyés avec --delta pour ne pas ralentir l'expérience utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen: true et @capacitor/splash-screen avec launchAutoHide: false. Disponible sur Android, iOS et Electron.“atBackground” // true is still accepted
resetWhenUpdatebooleanSupprime automatiquement les anciens bundles téléchargés lorsqu'un bundle d'application natif plus récent est installé sur l'appareil. Disponible sur Android, iOS et Electron.true
updateUrlstringConfigure l'URL / l'endpoint vers lequel les vérifications de mise à jour sont envoyées. Disponible sur Android, iOS et Electron.https://plugin.capgo.app/updates
channelUrlstringConfigure l'URL / l'endpoint pour les opérations de canal. Disponible sur Android, iOS et Electron.https://plugin.capgo.app/channel_self
statsUrlstringConfigure l'URL / l'endpoint vers lequel les statistiques de mise à jour sont envoyées. Disponible sur Android, iOS et Electron. Définissez-la sur "" pour désactiver l'envoi des statistiques.https://plugin.capgo.app/stats
publicKeystringConfigure la clé publique pour le chiffrement de bout en bout live update Version 2. Disponible sur Android, iOS et Electron.undefined6.2.0
versionstringConfigure la version actuelle de l'application. Elle sera utilisée pour la première requête de mise à jour. Si elle n'est pas définie, le plugin récupérera la version depuis le code natif. Disponible sur Android, iOS et Electron.undefined4.17.48
directUpdateboolean | ‘always’ | ‘atInstall’ | ‘onLaunch’Obsolète. Utilisez plutôt les modes string d'autoUpdate : « atInstall », « onLaunch » ou « always ». Cette option reste prise en charge pour les applications existantes. L'application immédiate doit être envoyée avec --delta pour ne pas ralentir l'expérience utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen: true et @capacitor/splash-screen avec launchAutoHide: false. - false : Ne jamais faire de mises à jour directes - atInstall : Identique à autoUpdate : « atInstall » - onLaunch : Identique à autoUpdate : « onLaunch » - always : Identique à autoUpdate : « always » - true : Identique à « always » pour la rétrocompatibilité. Disponible sur Android, iOS et Electron.false5.1.0
autoSplashscreenbooleanRequis lors de l’utilisation des modes d’application immédiate (« atInstall », « onLaunch » ou « always »), y compris les valeurs directUpdate obsolètes. @capacitor/splash-screen doit être installé et configuré avec launchAutoHide: false. Lorsqu’il est activé, le plugin masque le splashscreen une fois les mises à jour appliquées ou lorsqu’aucune mise à jour n’est nécessaire. Cela évite d’avoir à écouter manuellement les événements appReady et à appeler SplashScreen.hide(). Disponible sur Android et iOS.false7.6.0
periodCheckDelaynumberConfigure le délai de vérification périodique des mises à jour, en secondes. Disponible sur Android, iOS et Electron. Ne peut pas être inférieur à 600 secondes (10 minutes).600 // (10 minutes)
localS3booleanConfigurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.undefined4.17.48
localHoststringConfigurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.undefined4.17.48
localWebHoststringConfigurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.undefined4.17.48
localSupastringConfigurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.undefined4.17.48
localSupaAnonstringConfigure CLI pour utiliser un serveur local lors des tests.undefined4.17.48
localApistringConfigurez CLI afin de tester avec un api local.undefined6.3.3
localApiFilesstringConfigurez CLI afin de tester avec un fichier api local.undefined6.3.3
allowModifyUrlbooleanAutoriser le plugin à modifier dynamiquement updateUrl, statsUrl et channelUrl côté JavaScript.false5.4.0
defaultChannelstringDéfinit le canal par défaut de l’application dans la configuration. Sensible à la casse. Ce paramètre écrase le canal par défaut défini dans le cloud, mais respecte toujours les surcharges définies dans le cloud.undefined5.5.0
appIdstringConfigurez l'appId de l'application dans la configuration.undefined6.0.0
keepUrlPathAfterReloadbooleanConfigurez le plugin pour conserver le chemin de l'URL après un rechargement. ATTENTION : lorsqu'un rechargement est déclenché, « window.history » sera vidé.false6.8.0
disableJSLoggingbooleanDésactivez les logs JavaScript du plugin. Si cette option est à true, le plugin n'écrira aucun log dans la console JavaScript ; seul le log natif sera effectué.false7.3.0
shakeMenubooleanActivez le geste de secousse pour afficher le menu de mise à jour pour le débogage ou les testsfalse7.5.0

Dans capacitor.config.json:

{
"plugins": {
"CapacitorUpdater": {
"appReadyTimeout": 1000 // (1 second),
"responseTimeout": 10 // (10 second),
"autoDeleteFailed": false,
"autoDeletePrevious": false,
"autoUpdate": "onlyDownload",
"resetWhenUpdate": false,
"updateUrl": https://example.com/api/auto_update,
"channelUrl": https://example.com/api/channel,
"statsUrl": https://example.com/api/stats,
"publicKey": undefined,
"version": undefined,
"directUpdate": undefined,
"autoSplashscreen": undefined,
"periodCheckDelay": undefined,
"localS3": undefined,
"localHost": undefined,
"localWebHost": undefined,
"localSupa": undefined,
"localSupaAnon": undefined,
"localApi": undefined,
"localApiFiles": undefined,
"allowModifyUrl": undefined,
"defaultChannel": undefined,
"appId": undefined,
"keepUrlPathAfterReload": undefined,
"disableJSLogging": undefined,
"shakeMenu": undefined
}
}
}

Dans capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
plugins: {
CapacitorUpdater: {
appReadyTimeout: 1000 // (1 second),
responseTimeout: 10 // (10 second),
autoDeleteFailed: false,
autoDeletePrevious: false,
autoUpdate: 'onlyDownload',
resetWhenUpdate: false,
updateUrl: https://example.com/api/auto_update,
channelUrl: https://example.com/api/channel,
statsUrl: https://example.com/api/stats,
publicKey: undefined,
version: undefined,
directUpdate: undefined,
autoSplashscreen: undefined,
periodCheckDelay: undefined,
localS3: undefined,
localHost: undefined,
localWebHost: undefined,
localSupa: undefined,
localSupaAnon: undefined,
localApi: undefined,
localApiFiles: undefined,
allowModifyUrl: undefined,
defaultChannel: undefined,
appId: undefined,
keepUrlPathAfterReload: undefined,
disableJSLogging: undefined,
shakeMenu: undefined,
},
},
};
export default config;
notifyAppReady() => Promise<AppReadyResult>

Indique à l'Updater Capacitor que le bundle actuel fonctionne (un rollback se produira si cette méthode n'est pas appelée à chaque lancement de l'app). Par défaut, cette méthode doit être appelée dans les 10 secondes suivant le lancement de l'app, sinon un rollback se produira. Modifiez ce comportement avec {@link appReadyTimeout}

Retourne : Promise<AppReadyResult>


setUpdateUrl(options: UpdateUrl) => Promise<void>

Définit l'updateUrl de l'application, qui sera utilisée pour vérifier les mises à jour.

ParamètreTypeDescription
optionsUpdateUrlcontient l'URL à utiliser pour vérifier les mises à jour.

Depuis : 5.4.0


setStatsUrl(options: StatsUrl) => Promise<void>

Définit la statsUrl de l'application, utilisée pour envoyer les statistiques. Passer une chaîne vide désactive la collecte des statistiques.

ParamètreTypeDescription
optionsStatsUrlcontient l'URL à utiliser pour envoyer les statistiques.

Depuis : 5.4.0


setChannelUrl(options: ChannelUrl) => Promise<void>

Définit le channelUrl de l'application ; cette URL servira à définir le canal.

ParamètreTypeDescription
optionsChannelUrlcontient l'URL à utiliser pour définir le canal.

Depuis : 5.4.0


download(options: DownloadOptions) => Promise<BundleInfo>

Téléchargez un nouveau bundle depuis l'URL fournie ; il doit s'agir d'un fichier zip contenant vos fichiers ou un ID unique regroupant tous vos fichiers.

ParamètreTypeDescription
optionsDownloadOptionsL'objet {@link DownloadOptions} pour télécharger un nouveau zip de bundle.

Retourne : Promise<BundleInfo>


next(options: BundleId) => Promise<BundleInfo>

Définit le prochain bundle à utiliser lors du rechargement de l'application.

ParamètreTypeDescription
optionsBundleIdContient l’ID du bundle suivant à définir au prochain lancement de l’app. {@link BundleInfo.id}

Retourne : Promise<BundleInfo>


set(options: BundleId) => Promise<void>

Définit le bundle actuel et recharge immédiatement l’application.

ParamètreTypeDescription
optionsBundleIdUn {@link BundleId} contenant le nouveau bundle id à définir comme actuel.

delete(options: BundleId) => Promise<void>

Supprime le bundle spécifié du stockage de l'application native. Utilisez avec {@link list} pour obtenir les identifiants de bundle stockés.

ParamètreTypeDescription
optionsBundleIdUn {@link BundleId} contenant l'ID d'un bundle à supprimer (notez que c'est l'ID du bundle, et non le nom de la version)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

Récupérer tous les bundles téléchargés localement dans votre app

ParamètreTypeDescription
optionsListOptionsL'objet {@link ListOptions} pour lister les bundles

Retourne : Promise<BundleListResult>


reset(options?: ResetOptions | undefined) => Promise<void>

Réinitialisez l'application vers le builtin bundle (celui envoyé sur l'App Store d'Apple / le Play Store de Google) ou le dernier bundle chargé avec succès.

ParamètreTypeDescription
optionsResetOptionsContenant {@link ResetOptions.toLastSuccessful}, true réinitialise sur le bundle intégré et false reviendra au dernier bundle chargé avec succès.

current() => Promise<CurrentBundleResult>

Récupère le bundle actuel ; si aucun n’est défini, renvoie builtin. currentNative est le bundle d’origine installé sur l’appareil

Retourne : Promise<CurrentBundleResult>


reload() => Promise<void>

Recharger la vue


setMultiDelay(options: MultiDelayConditions) => Promise<void>

Définit un tableau {@link DelayCondition} contenant les conditions que le plugin utilisera pour retarder la mise à jour. Une fois toutes les conditions remplies, le processus de mise à jour redémarrera normalement, la mise à jour sera donc installée après un passage en arrière-plan ou la fermeture de l'app. Pour le date kind, la valeur doit être une chaîne de date ISO8601. Pour le background kind, la valeur doit être un nombre en millisecondes. Pour le nativeVersion kind, la valeur doit être le numéro de version. Pour le kill kind, la valeur n'est pas utilisée. La fonction présente un comportement incohérent : l'option kill déclenche la mise à jour après le premier kill et non après le passage en arrière-plan suivant, contrairement aux autres options. Cela sera corrigé dans une future version majeure.

ParamètreTypeDescription
optionsMultiDelayConditionsContenant le tableau {@link MultiDelayConditions} de conditions à définir

Depuis : 4.3.0


cancelDelay() => Promise<void>

Annule un {@link DelayCondition} pour traiter immédiatement une mise à jour.

Depuis : 4.0.0


getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

Get Latest bundle available from update Url

ParamètreType
optionsGetLatestOptions

Retourne : Promise<LatestVersion>

Depuis : 4.0.0


setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Définit le canal local géré par le plugin pour cet appareil. Le canal doit être allow_device_self_set activé pour que cela fonctionne.

setChannel() valide le canal auprès du backend, puis stocke le canal sélectionné localement sur l’appareil. Il ne crée ni ne met à jour un Device Override côté backend, l’appareil n’apparaîtra donc pas comme surchargé dans le dashboard Capgo. Seules les affectations créées depuis le dashboard ou l’API public sont affichées dans l’interface Device Override.

Notes importantes :

  • N’utilisez pas cette méthode pour définir le canal au démarrage. Utilisez plutôt defaultChannel dans votre configuration Capacitor.
  • Cette méthode est destinée à être utilisée une fois l’application prête et après interaction de l’utilisateur (par exemple, en s’inscrivant à un programme bêta).
  • Les canaux publics ne peuvent pas être auto-affectés. Si un canal est marqué comme public, l’appel de setChannel() renverra une erreur. Pour utiliser un canal public, appelez unsetChannel() à la place – l’appareil basculera automatiquement sur le canal public correspondant.
  • Utiliser listChannels() pour découvrir les canaux disponibles et s’ils autorisent l’auto-affectation.
ParamètreTypeDescription
optionsSetChannelOptionsEst le {@link SetChannelOptions} canal à définir

Retourne : Promise<ChannelRes>

Depuis : 4.7.0


unsetChannel(options: UnsetChannelOptions) => Promise<void>

Désactive le canal local géré par le plugin pour cet appareil. Cela efface uniquement le canal stocké localement par setChannel(); il ne supprime pas les enregistrements Device Override du Dashboard ou publics API.

Après l’appel de cette méthode, la priorité normale des canaux s’applique : un Device Override existant du Dashboard ou public API reste prioritaire ; sinon, l’appareil peut revenir au canal public/par défaut correspondant à ses conditions (plateforme, type d’appareil, type de build).

C'est utile quand :

  • Vous voulez remettre un appareil sur la piste de mise à jour par défaut
  • Vous voulez utiliser un canal public (les canaux publics ne peuvent pas être auto-attribués via setChannel())
ParamètreType
optionsUnsetChannelOptions

Depuis : 4.7.0


getChannel() => Promise<GetChannelRes>

Récupérer le canal de cet appareil

Retourne : Promise<GetChannelRes>

Depuis : 4.8.0


listChannels() => Promise<ListChannelsResult>

Liste tous les canaux disponibles pour cet appareil. Renvoie les canaux compatibles avec l'environnement actuel de l'appareil (plateforme, émulateur/appareil réel, build dev/prod) et qui sont publics ou permettent l'auto-assignation.

Chaque canal du résultat inclut :

  • public: Si true, il s'agit d'un canal par défaut. Vous ne pouvez pas vous y auto-assigner via setChannel(). À la place, si vous supprimez votre assignation de canal via unsetChannel(), l’appareil recevra automatiquement les mises à jour depuis ce canal public.
  • allow_self_set: Si true, il s'agit d'un canal auto-assignable. Vous pouvez affecter explicitement l’appareil à ce canal en utilisant setChannel().

Retourne : Promise<ListChannelsResult>

Depuis : 7.5.0


setCustomId(options: SetCustomIdOptions) => Promise<void>

Définir un ID personnalisé pour cet appareil

ParamètreTypeDescription
optionsSetCustomIdOptionsest le {@link SetCustomIdOptions} customId à définir

Depuis : 4.9.0


getBuiltinVersion() => Promise<BuiltinVersion>

Récupère la version native de l'app ou la version intégrée si définie dans la config

Retourne : Promise<BuiltinVersion>

Depuis : 5.2.0


getDeviceId() => Promise<DeviceId>

Récupère l’ID unique utilisé pour identifier l’appareil (envoyé au serveur de live update)

Retourne : Promise<DeviceId>


getPluginVersion() => Promise<PluginVersion>

Récupère la version du plugin natif Capacitor Updater (envoyée au serveur de mise à jour automatique)

Retourne : Promise<PluginVersion>


isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Get the state of auto update config.

Retourne : Promise<AutoUpdateEnabled>


removeAllListeners() => Promise<void>

Supprimez tous les écouteurs de ce plugin.

Depuis : 1.0.0


addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

Écouter l’événement de téléchargement du bundle dans l’application. Se déclenche une fois le téléchargement démarré, pendant le téléchargement et à la fin de celui-ci. Retourne tous les pourcentages de téléchargement pendant le téléchargement.

ParamètreType
eventName‘download’
listenerFunc(state: DownloadEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 2.0.11


addListener(‘noNeedUpdate’, …)

Section « addListener(‘noNeedUpdate’, …) »
addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

Écoutez l'événement no need to update, utile pour forcer une vérification à chaque lancement de l'app

ParamètreType
eventName‘noNeedUpdate’
listenerFunc(state: NoNeedEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0


addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>

Écouter l'événement de mise à jour disponible, utile pour forcer une vérification à chaque lancement de l'app

ParamètreType
eventName‘updateAvailable’
listenerFunc(state: UpdateAvailableEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0


addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>

Écouter les événements downloadComplete.

ParamètreType
eventName‘downloadComplete’
listenerFunc(state: DownloadCompleteEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0


addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>

Écoutez l'événement de mise à jour majeure dans l'application, et soyez informé lorsqu'une mise à jour majeure est bloquée par disableAutoUpdateBreaking

ParamètreType
eventName‘majorAvailable’
listenerFunc(state: MajorAvailableEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 2.3.0


addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

Écoutez l'événement d'échec de mise à jour dans l'application pour savoir quand une mise à jour n'a pas pu être installée au prochain démarrage

ParamètreType
eventName‘updateFailed’
listenerFunc(state: UpdateFailedEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 2.3.0


addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>

Écoutez l'événement d'échec de téléchargement dans l'application pour savoir quand le téléchargement d'un bundle a échoué

ParamètreType
eventName‘downloadFailed’
listenerFunc(state: DownloadFailedEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0


addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>

Écoutez l’événement de reload dans l’app pour savoir quand le rechargement a eu lieu

ParamètreType
eventName‘appReloaded’
listenerFunc() => void

Retourne : Promise<PluginListenerHandle>

Depuis : 4.3.0


addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

Écouter l'événement app ready de l'App, pour savoir quand l'app est prête à l'emploi

ParamètreType
eventName‘appReady’
listenerFunc(state: AppReadyEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 5.1.0


isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Vérifier si la mise à jour automatique est disponible (non désactivée par serverUrl).

Retourne : Promise<AutoUpdateAvailable>


getNextBundle() => Promise<BundleInfo | null>

Récupère le prochain bundle qui sera utilisé au rechargement de l'app. Retourne null si aucun prochain bundle n'est défini.

Retourne : Promise<BundleInfo | null>

Depuis : 6.8.0


setShakeMenu(options: SetShakeMenuOptions) => Promise<void>

Activer ou désactiver le menu de secousse pour le débogage ou les tests

ParamètreTypeDescription
optionsSetShakeMenuOptionsContient un booléen enabled pour activer ou désactiver le menu shake

Depuis : 7.5.0


isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Récupérer l'état actuel du menu shake

Retourne : Promise<ShakeMenuEnabled>

Depuis : 7.5.0


PropriétéType
bundleBundleInfo
PropriétéType
idstring
versionstring
downloadedstring
checksumstring
statusBundleStatus
PropriétéType
urlstring
PropriétéType
urlstring
PropriétéType
urlstring

Cette URL et les versions servent à télécharger le bundle depuis le serveur. Si vous utilisez un backend, toutes les informations sont fournies par la méthode getLatest. Si vous n'utilisez pas de backend, vous devez fournir l'URL et la version du bundle. Les SessionKey sont requises si vous avez chiffré le bundle avec la commande CLI encrypt ; vous les recevez normalement en résultat de la commande.

PropriétéTypeDescriptionPar défautDepuis
urlstringL’URL du fichier zip du bundle (par ex. : dist.zip) à télécharger. (Cela peut être n’importe quelle URL. Par ex. : Amazon S3, une balise GitHub, ou tout autre endroit où vous avez hébergé votre bundle.)
versionstringLa version code/nom de ce bundle/version
sessionKeystringLa clé de session de la mise à jour, lorsque le bundle est chiffré avec une clé de sessionundefined4.0.0
checksumstringLe checksum de la mise à jour, qui doit être en sha256 et chiffré avec la clé privée si le bundle est chiffréundefined4.0.0
manifestManifestEntry[]Le manifeste pour les téléchargements multi-fichiers Delta (manifeste)undefined6.1.0
PropriétéType
file_namestring | null
file_hashstring | null
download_urlstring | null
PropriétéType
idstring
PropriétéType
bundlesBundleInfo[]
PropriétéTypeDescriptionPar défautDepuis
rawbooleanIndique s'il faut retourner la liste brute des bundles ou le manifeste. Si true, la liste tentera de lire la base de données interne plutôt que les fichiers sur le disque.false6.14.0
PropriétéType
toLastSuccessfulboolean
PropriétéType
bundleBundleInfo
nativestring
PropriétéType
delayConditionsDelayCondition[]
PropriétéTypeDescription
kindDelayUntilNextConfigurez les conditions de délai dans setMultiDelay
valuestring
PropriétéTypeDescriptionDepuis
versionstringRésultat de la méthode getLatest4.0.0
checksumstring6
majorboolean
messagestring
sessionKeystring
errorstring
oldstring
urlstring
manifestManifestEntry[]6.1
PropriétéTypeDescriptionPar défautDepuis
channelstringLe canal pour obtenir la dernière version. Le canal doit autoriser « self_assign » pour que cela fonctionneundefined6.8.0
PropriétéTypeDescriptionDepuis
statusstringStatut actuel du canal défini4.7.0
errorstring
messagestring
PropriétéType
channelstring
triggerAutoUpdateboolean
PropriétéType
triggerAutoUpdateboolean
PropriétéTypeDescriptionDepuis
channelstringStatut actuel de get channel4.8.0
errorstring
messagestring
statusstring
allowSetboolean
PropriétéTypeDescriptionDepuis
channelsChannelInfo[]Liste des canaux disponibles7.5.0
PropriétéTypeDescriptionDepuis
idnumberL'ID numérique du canal7.5.0
namestringLe nom du canal7.5.0
publicbooleanSi true, il s'agit d'un canal par défaut/de secours. Les appareils ne peuvent pas s'assigner eux-mêmes à des canaux publics. À la place, lorsqu'un appareil supprime son override de canal (en utilisant unsetChannel()), il recevra automatiquement les mises à jour du canal public correspondant.7.5.0
allow_self_setbooleanSi true, les appareils peuvent s'assigner explicitement à ce canal en utilisant setChannel(). On l'utilise généralement pour les tests bêta, l'A/B testing ou les canaux de mise à jour opt-in.7.5.0

Les commandes de canal utilisent le canal name, et non cet ID numérique id.

PropriétéType
customIdstring
PropriétéType
versionstring
PropriétéType
deviceIdstring
PropriétéType
versionstring
PropriétéType
enabledboolean
PropriétéType
remove() => Promise<void>
PropriétéTypeDescriptionDepuis
percentnumberÉtat actuel du téléchargement, entre 0 et 100.4.0.0
bundleBundleInfo
PropriétéTypeDescriptionDepuis
bundleBundleInfoÉtat actuel du téléchargement, entre 0 et 100.4.0.0
PropriétéTypeDescriptionDepuis
bundleBundleInfoÉtat actuel du téléchargement, entre 0 et 100.4.0.0
PropriétéTypeDescriptionDepuis
bundleBundleInfoÉmis lorsqu'une nouvelle mise à jour est disponible.4.0.0
PropriétéTypeDescriptionDepuis
versionstringÉmis lorsqu'un nouveau bundle majeur est disponible.4.0.0
PropriétéTypeDescriptionDepuis
bundleBundleInfoÉmis lorsqu’une mise à jour échoue à l’installation.4.0.0
PropriétéTypeDescriptionDepuis
versionstringÉmis lorsqu’un téléchargement échoue.4.0.0
PropriétéTypeDescriptionDepuis
bundleBundleInfoÉmis lorsque l'application est prête à être utilisée.5.2.0
statusstring
PropriétéType
availableboolean
PropriétéType
enabledboolean
PropriétéType
enabledboolean

pending : le bundle est en attente d'être SET comme bundle suivant. downloading : le bundle est en cours de téléchargement. success : le bundle a été téléchargé et est prêt à être SET en tant que prochain bundle. error: Le téléchargement du bundle a échoué.

‘success’ | ‘error’ | ‘pending’ | ‘downloading’

‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’

Si vous utilisez Fonctions et paramètres pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-updater pour la capacité native dans « Utiliser @capgo/capacitor-updater », Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.