Fonctions et paramètres

Copiez un prompt de configuration incluant les étapes d'installation et le guide markdown complet pour ce plugin.

Configuration du plugin Updater

Consultez le Github Readme pour plus d'informations.

CapacitorUpdater peut être configuré avec ces options :

Propriété	Type	Description	Par défaut	Depuis
`appReadyTimeout`	`number`	Configurez 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)`
`responseTimeout`	`number`	Configurez 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)`
`autoDeleteFailed`	`boolean`	Configurez si le plugin doit supprimer automatiquement les bundles ayant échoué. Disponible sur Android, iOS et Electron.	`true`
`autoDeletePrevious`	`boolean`	Configurez 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`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	Configurez le mode d'Auto Update via un serveur de mise à jour. true équivaut à « atBackground » ; false équivaut à « off ». - off : Désactive l'Auto Update - atBackground : Vérifie et télécharge automatiquement, puis applique quand l'app passe en arrière-plan - atInstall : Applique immédiatement seulement 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 de l'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`
`resetWhenUpdate`	`boolean`	Supprime 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`
`updateUrl`	`string`	Configure 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`
`channelUrl`	`string`	Configure l'URL / l'endpoint pour les opérations de canal. Disponible sur Android, iOS et Electron.	`https://plugin.capgo.app/channel_self`
`statsUrl`	`string`	Configure 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`
`publicKey`	`string`	Configure la clé publique pour le chiffrement de bout en bout live update Version 2. Disponible sur Android, iOS et Electron.	`undefined`	6.2.0
`version`	`string`	Configure 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.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘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.	`false`	5.1.0
`autoSplashscreen`	`boolean`	Requis lors de l'utilisation des modes d'application instantanée (« 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 l'écran de démarrage (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.	`false`	7.6.0
`periodCheckDelay`	`number`	Configure la période de délai pour la vérification périodique des mises à jour. L'unité est en secondes. Disponible sur Android, iOS et Electron. Ne peut pas être inférieur à 600 secondes (10 minutes).	`600 // (10 minutes)`
`localS3`	`boolean`	Configurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.	`undefined`	4.17.48
`localHost`	`string`	Configurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.	`undefined`	4.17.48
`localWebHost`	`string`	Configurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.	`undefined`	4.17.48
`localSupa`	`string`	Configurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.	`undefined`	4.17.48
`localSupaAnon`	`string`	Configure le CLI pour utiliser un serveur local pour les tests.	`undefined`	4.17.48
`localApi`	`string`	Configurez CLI afin de tester avec un api local.	`undefined`	6.3.3
`localApiFiles`	`string`	Configurez CLI afin de tester avec un fichier api local.	`undefined`	6.3.3
`allowModifyUrl`	`boolean`	Autorise le plugin à modifier dynamiquement l'updateUrl, la statsUrl et la channelUrl depuis le côté JavaScript.	`false`	5.4.0
`defaultChannel`	`string`	Définit le canal par défaut de l'application dans la config. Sensible à la casse. Ce paramètre remplacera le canal par défaut défini dans le cloud, tout en respectant les overrides effectués dans le cloud.	`undefined`	5.5.0
`appId`	`string`	Configurez l'appId de l'application dans la configuration.	`undefined`	6.0.0
`keepUrlPathAfterReload`	`boolean`	Configurez le plugin pour conserver le chemin de l'URL après un rechargement. ATTENTION : lorsqu'un rechargement est déclenché, « window.history » sera vidé.	`false`	6.8.0
`disableJSLogging`	`boolean`	Dé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é.	`false`	7.3.0
`shakeMenu`	`boolean`	Activez le geste de secousse pour afficher le menu de mise à jour pour le débogage ou les tests	`false`	7.5.0

Exemples

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()
setUpdateUrl(...)
setStatsUrl(...)
setChannelUrl(...)
download(...)
next(...)
set(...)
delete(...)
list(...)
reset(...)
current()
reload()
setMultiDelay(...)
cancelDelay()
getLatest(...)
setChannel(...)
unsetChannel(...)
getChannel()
listChannels()
setCustomId(...)
getBuiltinVersion()
getDeviceId()
getPluginVersion()
isAutoUpdateEnabled()
removeAllListeners()
addListener('download', ...)
addListener('noNeedUpdate', ...)
addListener('updateAvailable', ...)
addListener('downloadComplete', ...)
addListener('majorAvailable', ...)
addListener('updateFailed', ...)
addListener('downloadFailed', ...)
addListener('appReloaded', ...)
addListener('appReady', ...)
isAutoUpdateAvailable()
getNextBundle()
setShakeMenu(...)
isShakeMenuEnabled()
Interfaces
Alias de type

Méthodes

notifyAppReady()

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(…)

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

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

Paramètre	Type	Description
`options`	`UpdateUrl`	contient l'URL à utiliser pour vérifier les mises à jour.

Depuis : 5.4.0

setStatsUrl(…)

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ètre	Type	Description
`options`	`StatsUrl`	contient l'URL à utiliser pour envoyer les statistiques.

Depuis : 5.4.0

setChannelUrl(…)

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

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

Paramètre	Type	Description
`options`	`ChannelUrl`	contient l'URL à utiliser pour définir le canal.

Depuis : 5.4.0

download(…)

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ètre	Type	Description
`options`	`DownloadOptions`	L'objet {@link DownloadOptions} pour télécharger un nouveau zip de bundle.

Retourne : Promise<BundleInfo>

next(…)

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

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

Paramètre	Type	Description
`options`	`BundleId`	Contient l'ID du prochain bundle à appliquer au prochain lancement de l'application. {@link BundleInfo.id}

Retourne : Promise<BundleInfo>

set(…)

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

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

Paramètre	Type	Description
`options`	`BundleId`	Un objet {@link} BundleId} contenant le nouvel ID de bundle à définir comme actuel.

delete(…)

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

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

Paramètre	Type	Description
`options`	`BundleId`	Un objet {@link} BundleId} objet contenant l'ID d'un bundle à supprimer (attention, il s'agit de l'ID du bundle, et NON du nom de la version)

list(…)

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

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

Paramètre	Type	Description
`options`	`ListOptions`	L'objet {@link ListOptions} pour lister les bundles

Retourne : Promise<BundleListResult>

reset(…)

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

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

Paramètre	Type	Description
`options`	`ResetOptions`	Contenant {@link ResetOptions.toLastSuccessful}, `true` réinitialise vers le bundle intégré et `false` reviendra au dernier bundle chargé avec succès.

current()

current() => Promise<CurrentBundleResult>

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

Retourne : Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

Recharger la vue

setMultiDelay(…)

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ètre	Type	Description
`options`	`MultiDelayConditions`	Contenant le tableau {@link MultiDelayConditions} de conditions à définir

Depuis : 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

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

Depuis : 4.0.0

getLatest(…)

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

Récupérer le dernier bundle disponible via l'URL de mise à jour

Paramètre	Type
`options`	`GetLatestOptions`

Retourne : Promise<LatestVersion>

Depuis : 4.0.0

setChannel(…)

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. Cela ne crée pas et n'actualise pas de Device Override sur le backend, l'appareil n'apparaîtra donc pas comme étant en override dans le dashboard Capgo. Seules les affectations créées depuis le dashboard ou via 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 la defaultChannel dans votre configuration Capacitor.
Cette méthode est destinée à être utilisée une fois que l'application est prête et que l'utilisateur a interagi (par exemple, en s'inscrivant à un programme bêta).
Les canaux publics ne peuvent pas être auto-assignés. Si un canal est marqué comme public, l'appel à setChannel() renverra une erreur. Pour utiliser un canal public, appelez unsetChannel() à la place : l'appareil basculera automatiquement vers le canal public correspondant.
Utiliser listChannels() pour découvrir quels canaux sont disponibles et s'ils autorisent l'auto-assignation.

Paramètre	Type	Description
`options`	`SetChannelOptions`	Est le {@link SetChannelOptions} canal pour définir

Retourne : Promise<ChannelRes>

Depuis : 4.7.0

unsetChannel(…)

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(); cela ne supprime pas les enregistrements Dashboard ou Public API Device Override.

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

Ceci est utile quand :

Vous souhaitez replacer un appareil sur le canal de mise à jour par défaut
Vous souhaitez utiliser un canal public (puisque les canaux publics ne peuvent pas être auto-assignés via setChannel())

Paramètre	Type
`options`	`UnsetChannelOptions`

Depuis : 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

Récupérer le canal pour cet appareil

Retourne : Promise<GetChannelRes>

Depuis : 4.8.0

listChannels()

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 de ce canal public.
allow_self_set: Si true, il s'agit d'un canal auto-assignable. Vous pouvez assigner explicitement l'appareil à ce canal en utilisant setChannel().

Retourne : Promise<ListChannelsResult>

Depuis : 7.5.0

setCustomId(…)

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

Définir un ID personnalisé pour cet appareil

Paramètre	Type	Description
`options`	`SetCustomIdOptions`	est le {@link SetCustomIdOptions} customId à définir

Depuis : 4.9.0

getBuiltinVersion()

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()

getDeviceId() => Promise<DeviceId>

Récupère l'ID unique utilisé pour identifier l'appareil (envoyé au serveur d'auto update)

Retourne : Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Récupère la version du plugin natif Capacitor Updater (envoyée au serveur d'auto update)

Retourne : Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Récupérer l'état de la configuration de l'auto update.

Retourne : Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

Supprimez tous les écouteurs de ce plugin.

Depuis : 1.0.0

addListener(‘download’, …)

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

Écoute l'événement de téléchargement du bundle dans l'App. Se déclenche une fois le téléchargement lancé, pendant le processus et une fois terminé. Cela vous retourne le pourcentage de téléchargement en temps réel.

Paramètre	Type
`eventName`	`‘download’`
`listenerFunc`	`(state: DownloadEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 2.0.11

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ètre	Type
`eventName`	`‘noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

addListener(‘updateAvailable’, …)

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ètre	Type
`eventName`	`‘updateAvailable’`
`listenerFunc`	`(state: UpdateAvailableEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

addListener(‘downloadComplete’, …)

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

Écouter les événements downloadComplete.

Paramètre	Type
`eventName`	`‘downloadComplete’`
`listenerFunc`	`(state: DownloadCompleteEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

addListener(‘majorAvailable’, …)

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ètre	Type
`eventName`	`‘majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 2.3.0

addListener(‘updateFailed’, …)

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

Écoute l'événement d'échec de mise à jour dans l'application pour vous informer si une mise à jour n'a pas pu s'installer au prochain démarrage

Paramètre	Type
`eventName`	`‘updateFailed’`
`listenerFunc`	`(state: UpdateFailedEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 2.3.0

addListener(‘downloadFailed’, …)

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

Écoute l'événement d'échec de téléchargement dans l'application pour vous informer si le téléchargement d'un bundle a échoué

Paramètre	Type
`eventName`	`‘downloadFailed’`
`listenerFunc`	`(state: DownloadFailedEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

addListener(‘appReloaded’, …)

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

Écoute l'événement de rechargement de l'application pour vous informer quand le reload a eu lieu

Paramètre	Type
`eventName`	`‘appReloaded’`
`listenerFunc`	`() => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 4.3.0

addListener(‘appReady’, …)

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ètre	Type
`eventName`	`‘appReady’`
`listenerFunc`	`(state: AppReadyEvent) => void`

Retourne : Promise<PluginListenerHandle>

Depuis : 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

Retourne : Promise<AutoUpdateAvailable>

getNextBundle()

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(…)

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

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

Paramètre	Type	Description
`options`	`SetShakeMenuOptions`	Contient un booléen enabled pour activer ou désactiver le menu shake

Depuis : 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

Retourne : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

Interfaces

AppReadyResult

Propriété	Type
`bundle`	`BundleInfo`

BundleInfo

Propriété	Type
`id`	`string`
`version`	`string`
`downloaded`	`string`
`checksum`	`string`
`status`	`BundleStatus`

UpdateUrl

Propriété	Type
`url`	`string`

StatsUrl

Propriété	Type
`url`	`string`

ChannelUrl

Propriété	Type
`url`	`string`

DownloadOptions

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é	Type	Description	Par défaut	Depuis
`url`	`string`	L'URL du fichier zip du bundle (ex: dist.zip) à télécharger. (Il peut s'agir de n'importe quelle URL. Ex: Amazon S3, un tag GitHub, ou tout autre endroit où vous hébergez votre bundle.)
`version`	`string`	La version code/le nom de ce bundle/version
`sessionKey`	`string`	La clé de session pour la mise à jour, lorsque le bundle est chiffré avec une clé de session	`undefined`	4.0.0
`checksum`	`string`	Le checksum de la mise à jour, il doit être en sha256 et chiffré avec une clé privée si le bundle est chiffré	`undefined`	4.0.0
`manifest`	`ManifestEntry[]`	Le manifeste pour les téléchargements multi-fichiers Delta (manifest)	`undefined`	6.1.0

ManifestEntry

Propriété	Type
`file_name`	`string \| null`
`file_hash`	`string \| null`
`download_url`	`string \| null`

BundleId

Propriété	Type
`id`	`string`

BundleListResult

Propriété	Type
`bundles`	`BundleInfo[]`

ListOptions

Propriété	Type	Description	Par défaut	Depuis
`raw`	`boolean`	Indique 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.	`false`	6.14.0

ResetOptions

Propriété	Type
`toLastSuccessful`	`boolean`

CurrentBundleResult

Propriété	Type
`bundle`	`BundleInfo`
`native`	`string`

MultiDelayConditions

Propriété	Type
`delayConditions`	`DelayCondition[]`

DelayCondition

Propriété	Type	Description
`kind`	`DelayUntilNext`	Configurez les conditions de délai dans setMultiDelay
`value`	`string`

LatestVersion

Propriété	Type	Description	Depuis
`version`	`string`	Résultat de la méthode getLatest	4.0.0
`checksum`	`string`		6
`major`	`boolean`
`message`	`string`
`sessionKey`	`string`
`error`	`string`
`old`	`string`
`url`	`string`
`manifest`	`ManifestEntry[]`		6.1

GetLatestOptions

Propriété	Type	Description	Par défaut	Depuis
`channel`	`string`	Le canal pour obtenir la dernière version. Le canal doit autoriser « self_assign » pour que cela fonctionne	`undefined`	6.8.0

ChannelRes

Propriété	Type	Description	Depuis
`status`	`string`	Statut actuel du canal défini	4.7.0
`error`	`string`
`message`	`string`

SetChannelOptions

Propriété	Type
`channel`	`string`
`triggerAutoUpdate`	`boolean`

UnsetChannelOptions

Propriété	Type
`triggerAutoUpdate`	`boolean`

GetChannelRes

Propriété	Type	Description	Depuis
`channel`	`string`	Statut actuel de get channel	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

Propriété	Type	Description	Depuis
`channels`	`ChannelInfo[]`	Liste des canaux disponibles	7.5.0

ChannelInfo

Propriété	Type	Description	Depuis
`id`	`number`	L'ID numérique du canal	7.5.0
`name`	`string`	Le nom du canal	7.5.0
`public`	`boolean`	Si 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_set`	`boolean`	Si 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.

SetCustomIdOptions

Propriété	Type
`customId`	`string`

BuiltinVersion

Propriété	Type
`version`	`string`

DeviceId

Propriété	Type
`deviceId`	`string`

PluginVersion

Propriété	Type
`version`	`string`

AutoUpdateEnabled

Propriété	Type
`enabled`	`boolean`

PluginListenerHandle

Propriété	Type
`remove`	`() => Promise<void>`

DownloadEvent

Propriété	Type	Description	Depuis
`percent`	`number`	État actuel du téléchargement, entre 0 et 100.	4.0.0
`bundle`	`BundleInfo`

NoNeedEvent

Propriété	Type	Description	Depuis
`bundle`	`BundleInfo`	État actuel du téléchargement, entre 0 et 100.	4.0.0

UpdateAvailableEvent

Propriété	Type	Description	Depuis
`bundle`	`BundleInfo`	État actuel du téléchargement, entre 0 et 100.	4.0.0

DownloadCompleteEvent

Propriété	Type	Description	Depuis
`bundle`	`BundleInfo`	Émis lorsqu'une nouvelle mise à jour est disponible.	4.0.0

MajorAvailableEvent

Propriété	Type	Description	Depuis
`version`	`string`	Émis lorsqu'un nouveau bundle majeur est disponible.	4.0.0

UpdateFailedEvent

Propriété	Type	Description	Depuis
`bundle`	`BundleInfo`	Emit when a update failed to install.	4.0.0

DownloadFailedEvent

Propriété	Type	Description	Depuis
`version`	`string`	Émis lorsqu'un téléchargement échoue.	4.0.0

AppReadyEvent

Propriété	Type	Description	Depuis
`bundle`	`BundleInfo`	Émis lorsque l'application est prête à être utilisée.	5.2.0
`status`	`string`

AutoUpdateAvailable

Propriété	Type
`available`	`boolean`

SetShakeMenuOptions

Propriété	Type
`enabled`	`boolean`

ShakeMenuEnabled

Propriété	Type
`enabled`	`boolean`

Alias de type

BundleStatus

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 DÉFINIR comme le prochain bundle. erreur : l'échec du téléchargement du bundle a eu lieu.

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

DelayUntilNext

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

Continuer depuis Functions et paramètres

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.