Fonctions et paramètres

Configuration du plugin de mise à jour

Voir le Github Lire le README pour plus d'informations.

CapacitorUpdater peut être configuré avec ces options :

Propriété	Type	Description	Défaut	Depuis
appReadyTimeout	number	Configurez le nombre de millisecondes que le plugin natif devrait attendre avant de considérer une mise à jour comme ‘échouée’. Disponible sur Android, iOS et Electron.	10000 // (10 seconds)
responseTimeout	number	Configure the number of milliseconds the native plugin should wait before considering API timeout. Available on Android, iOS, and Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configurez si le plugin devrait supprimer automatiquement les paquets échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin devrait supprimer automatiquement les anciens paquets après une mise à jour réussie. Disponible sur Android, iOS et Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Configurez comment le plugin utilise l'auto-mise à jour via un serveur d'actualisation. true est le même que « à l'arrière-plan » ; false est le même que « éteint ». - éteint : Désactivez l'auto-mise à jour - à l'arrière-plan : Vérifiez et téléchargez automatiquement, puis appliquez lorsque l'application passe en arrière-plan - à l'installation : Appliquez immédiatement uniquement après une installation fraîche ou une mise à jour native de l'application, sinon utilisez à l'arrière-plan - à la mise en route : Appliquez immédiatement à la mise en route, sinon utilisez à l'arrière-plan après le contrôle de mise en route - toujours : Appliquez immédiatement chaque fois que l'auto-mise à jour s'exécute - seuls téléchargements : Vérifiez et téléchargez automatiquement, émettez updateAvailable, et n'appliquez jamais le prochain bundle automatiquement. Les modes d'application instantanée ( « à l'installation », « à la mise en route », « toujours » ) doivent être téléchargés avec —delta afin d'éviter de ralentir l'expérience utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen : true et @capacitor/écran de splash avec launchAutoHide : false. Disponible sur Android, iOS et Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Supprimez automatiquement les anciens bundles téléchargés lorsque l'un des nouveaux bundles de l'application native est installé sur le dispositif. Disponible sur Android, iOS et Electron.	true
updateUrl	string	Configurez l'URL / point de terminaison vers lequel les vérifications d'actualisation sont envoyées. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configurez l'URL / point de terminaison pour les opérations de canal. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configurez l'URL / point de terminaison vers lequel les statistiques d'actualisation sont envoyées. Disponible sur Android, iOS et Electron. Définissez-la sur "" pour désactiver la mise à jour des statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurez la clé publique pour le chiffrement en direct à la fin de l'actualisation Version 2. Disponible sur Android, iOS, et Electron.	undefined	6.2.0
version	string	Configurez la version actuelle de l'application. Cette version sera utilisée pour la première demande d'actualisation. Si elle n'est pas définie, le plugin récupérera la version à partir du natif code. Disponible sur Android, iOS, et Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Déprécié. Utilisez les modes de mise à jour automatique au lieu de cela : “à l'installation”, “à la mise en route” ou “toujours”. Cette option reste prise en charge pour les applications existantes. L'application instantanée doit être téléchargée avec —delta afin d'éviter de ralentir l'expérience utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen : true et @capacitor/écran de démarrage avec launchAutoHide : false. - false : Jamais faire des mises à jour directes - à l'installation : Même chose que autoUpdate : “à l'installation” - à la mise en route : Même chose que autoUpdate : “à la mise en route” - toujours : Même chose que autoUpdate : “toujours” - true : Même chose que “toujours” pour la compatibilité ascendante. Disponible sur Android, iOS, et Electron.	false	5.1.0
autoSplashscreen	boolean	Obligatoire lors de l'utilisation des modes d'application instantanée (“à l'installation”, “à la mise en route”, ou “toujours”), y compris les valeurs dépréciées directUpdate. @capacitor/écran de démarrage doit être installé et configuré avec launchAutoHide : false. Lorsque cela est activé, le plugin cache l'écran de démarrage après les mises à jour sont appliquées ou lorsque aucune mise à jour n'est nécessaire. Cela supprime la nécessité de s'abonner manuellement à l'événement appReady et d'appeler SplashScreen.hide(). Disponible sur Android et iOS.	false	7.6.0
periodCheckDelay	number	Configurez la période de délai pour la vérification des mises à jour périodiques. 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 le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localHost	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localWebHost	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localSupa	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localSupaAnon	string	Configurez le CLI pour utiliser un serveur local pour les tests.	undefined	4.17.48
localApi	string	Configurez le CLI pour utiliser un serveur local api pour les tests.	undefined	6.3.3
localApiFiles	string	Configurez le CLI pour utiliser un fichier local api pour les tests.	undefined	6.3.3
allowModifyUrl	boolean	Permettez au plugin de modifier dynamiquement l'URL de mise à jour, l'URL de statistiques et l'URL de canal depuis le côté JavaScript.	false	5.4.0
defaultChannel	string	Définissez le canal par défaut pour l'application dans la configuration. Sensible à la casse. Cette mise à jour remplacera le canal par défaut défini dans le cloud, mais respectera toujours les modifications apportées dans le cloud.	undefined	5.5.0
appId	string	Définissez l'ID de l'application dans la configuration.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configurez le plugin pour conserver l'URL de chemin après un rechargement. Avertissement : Lorsqu'un rechargement est déclenché, ‘window.history’ sera vidé.	false	6.8.0
disableJSLogging	boolean	Désactiver la journalisation JavaScript du plugin. Si vrai, le plugin ne loguera pas dans la console JavaScript. Seul le journal natif sera effectué	false	7.3.0
shakeMenu	boolean	Activer le geste de secousses pour afficher le menu de mise à jour aux fins de débogage/test	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
• Types d'alias

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifier Capacitor Mise à jour que le bundle actuel fonctionne (une annulation se produira si cette méthode n'est pas appelée à chaque lancement de l'application) Par défaut, cette méthode doit être appelée dans les 10 premières secondes après le lancement de l'application, sinon une annulation se produira. Modifier ce comportement avec {@link appReadyTimeout}

Renvoie : Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Définir l'URL de mise à jour pour 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éfinir l'URL des statistiques pour l'application, cette valeur sera utilisée pour envoyer des statistiques. Passer une chaîne vide désactivera la collecte de statistiques.

Paramètre	Type	Description
options	StatsUrl	contient l'URL à utiliser pour envoyer des statistiques.

Depuis : 5.4.0

---

setChannelUrl(…)

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

Définir l'URL de la chaîne pour l'application, qui sera utilisée pour définir la chaîne.

Paramètre	Type	Description
options	ChannelUrl	contient l'URL à utiliser pour définir la chaîne.

Depuis : 5.4.0

---

download(…)

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

Télécharger un nouveau bundle à partir de l'URL fournie, il doit s'agir d'un fichier zip, avec des fichiers à l'intérieur ou avec un ID unique à l'intérieur avec tous vos fichiers.

Paramètres	Type	Description
options	DownloadOptions	Le {@link} pour télécharger un nouveau zip de bundle. Renvoie :next(…)

Section intitulée “next(…)” Promise<BundleInfo>

---

Copier dans le presse-papier

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

Options de téléchargement pour un nouveau zip de bundle.

next(…)	Type	Description
options	BundleId	Contient l'ID du prochain Bundle à installer lors du prochain lancement de l'application. {@link BundleInfo.id}

Résultats : Promise<BundleInfo>

---

set(…)

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

Définir le bundle actuel et recharger immédiatement l'application.

Paramètre	Type	Description
options	BundleId	Un objet {@link} contenant l'identifiant du nouveau bundle à définir en tant que courant. delete(…)Section intitulée “delete(…)”

---

Copier dans le presse-papier

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

Type

Description	Un objet {@link} contenant l'identifiant du nouveau bundle à définir en tant que courant.	Copier dans le presse-papier
options	BundleId	Supprime le bundle spécifié du stockage de l'application native. Utilisez {@link list} pour obtenir les identifiants de Bundle stockés. Paramètreobjet contenant l'ID d'un bundle à supprimer (notez que c'est l'ID du bundle, ET PAS le nom de la version)

---

list(…)

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

Obtenir tous les bundles téléchargés localement dans votre application

Paramètre	Type	Description
options	ListOptions	Les {@link} ListOptions} pour lister les bundles

Renvoie : Promise<BundleListResult>

---

reset(…)

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

Réinitialiser l'application à la builtin dernière version distribuée (celle envoyée sur l'App Store d'Apple ou le Google Play Store) ou à la dernière version chargée avec succès.

Paramètre	Type	Description
options	ResetOptions	Contenant {@link ResetOptions.toLastSuccessful}}, true réinitialise à la version intégrée et false réinitialisera à la dernière version chargée avec succès.

---

current()

current() => Promise<CurrentBundleResult>

Récupérer le bundle actuel, si aucun n'est défini il retourne builtinLe bundle native est le bundle original installé sur le dispositif

Retourne : Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recharger la vue

---

setMultiDelay(…)

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

Définit un tableau {@link} Condition de retard} contenant les conditions que le Plugin utilisera pour retarder la mise à jour. Après que toutes les conditions soient remplies, le processus de mise à jour sera relancé comme d'habitude, donc la mise à jour sera installée après un backgrounding ou la fermeture de l'application. Pour le date kind, la valeur doit être une chaîne de date ISO 8601. 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 la première fermeture et pas après le prochain background comme les autres options. Cela sera corrigé dans une future mise à jour majeure.

Paramètre	Type	Description
options	MultiDelayConditions	contenant le {@link} MultiDelayConditionsTableau d'arrêts de conditions à définir

Depuis : 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Annule une {@link DelayCondition } pour traiter une mise à jour immédiatement. Depuis :getLatest(…)

Section intitulée « getLatest(…) » 4.0.0

---

Cancels a {@link DelayCondition } to process an update immediately.

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

Obtenir le dernier bundle disponible à partir de l'URL de mise à jour

Paramètre	Type
options	GetLatestOptions

Renvoie : 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 vérifie le canal avec le serveur, puis stocke le canal sélectionné localement sur l'appareil. Il ne crée ni ne met à jour aucun surcharge de l'appareil sur le serveur, donc l'appareil ne sera pas affiché comme surchargé dans le tableau de bord __CAPGO_KEEP_0__. Seules les affectations créées à partir du tableau de bord ou de l'espace public __CAPGO_KEEP_1__ sont affichées dans l'interface de surcharge de l'appareil.

setChannel() vérifie le canal avec le serveur, puis stocke le canal sélectionné localement sur l'appareil. Il ne crée ni ne met à jour aucun surcharge de l'appareil sur le serveur, donc l'appareil ne sera pas affiché comme surchargé dans le tableau de bord Capgo. Seules les affectations créées à partir du tableau de bord ou de l'espace public API sont affichées dans l'interface de surcharge de l'appareil.

Remarques importantes :

• N'employez pas cette méthode pour définir le canal lors du démarrage. Utilisez plutôt defaultChannel in your Capacitor config instead.
• Cette méthode est destinée à être utilisée après que l'application soit prête et que l'utilisateur ait interagi (par exemple, en optant pour un programme bêta).
• Les canaux publics ne peuvent pas être attribués automatiquement. Si un canal est marqué comme public, l'appel à setChannel() retournera une erreur. Pour utiliser un canal public, appelez unsetChannel() au lieu - le dispositif tombera automatiquement sur le canal public correspondant.
• Utilisez listChannels() pour découvrir quels canaux sont disponibles et s'ils permettent l'attribution automatique.

Paramètre	Type	Description
options	SetChannelOptions	Est-ce que le {@link SetChannelOptions} canal à définir

Renvoie : Promise<ChannelRes>

Depuis : 4.7.0

---

unsetChannel(…)

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

Annulez 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 de la console ou de l'espace public API pour le dispositif.

Après l'appel de cette méthode, la priorité normale du canal s'applique : un canal Dashboard ou Public API Device Override existant gagne toujours ; sinon, le dispositif peut tomber en arrière sur le canal public/par défaut correspondant à ses conditions (plateforme, type de dispositif, type de build).

Cela est utile lorsque :

• Vous souhaitez déplacer un appareil vers la piste de mise à jour par défaut
• Vous souhaitez utiliser un canal public (puisquels les canaux publics ne peuvent pas être affectés automatiquement via setChannel())

Paramètre	Type
options	UnsetChannelOptions

Depuis : 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Obtenez le canal pour cet appareil

Retourne : Promise<GetChannelRes>

Depuis : 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Affichez la liste de tous les canaux disponibles pour ce dispositif. Retourne les canaux qui sont compatibles avec l'environnement actuel du dispositif (plateforme, émulateur/dispositif réel, build de développement/prod) et qui sont soit publics, soit autorisent l'auto-assignation.

Chaque canal dans le résultat comprend :

• publicSi truececi est un canaux par défautVous ne pouvez pas vous assigner à ce canal en utilisant setChannel()Au lieu de cela, si vous supprimez votre assignation de canal en utilisant unsetChannel()le dispositif recevra automatiquement les mises à jour à partir de ce canal public.
• allow_self_set: Si true, ceci est un un canal auto-attribuable. Vous pouvez attribuer explicitement le dispositif à ce canal à l'aide de setChannel().

Renvoie : Promise<ListChannelsResult>

Depuis : 7.5.0

---

setCustomId(…)

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

Définir un ID personnalisé pour ce dispositif

Paramètre	Type	Description
options	SetCustomIdOptions	est le {@link} SetCustomIdOptions} l'identifiant personnalisé à définir

Depuis : 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Retourne : Promise<BuiltinVersion>

Depuis : 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Obtenez l'ID unique utilisé pour identifier le dispositif (envoyé au serveur d'auto-mise à jour)

Retourne : Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Obtenez la version native Capacitor de l'extension de mise à jour (envoyée au serveur d'auto-mise à jour)

Retourne : Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Obtenez l'état de la configuration de mise à jour automatique.

Retourne : Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Supprimez tous les écouteurs pour ce plugin.

Depuis : 1.0.0

---

addListener('download', …)

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

Écoutez l'événement de téléchargement de l'ensemble dans l'application. Déclenche une fois le téléchargement commencé, pendant le téléchargement et lorsque terminé. Cela vous retournera tous les pourcentages de téléchargement pendant le téléchargement

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

Returns : Promise<PluginListenerHandle>

Depuis : 2.0.11

---

addListener(‘noNeedUpdate’, …)

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

Écoutez l'événement sans mise à jour nécessaire, utile lorsque vous souhaitez effectuer une vérification à chaque lancement de l'application

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

Returns : 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 lorsque vous souhaitez forcer la vérification chaque fois que l'application est lancée

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener(‘téléchargement complet’, …)

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

Écouter les événements de téléchargement complet.

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

Returns : 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, vous informez quand une mise à jour majeure est bloquée en définissant disableAutoUpdateBreaking

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

Returns : Promise<PluginListenerHandle>

Depuis : 2.3.0

---

addListener(‘updateFailed’, …)

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

Écoutez l'événement de mise à jour échouée dans l'application, vous informez quand une mise à jour a échoué à l'installation à la prochaine démarrage de l'application

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

Retourne : Promise<PluginListenerHandle>

Depuis : 2.3.0

---

addListener('téléchargement échoué', …)

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

Écoutez l'événement de téléchargement échoué dans l'application, vous informez quand un téléchargement de bundle a échoué

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

Returns : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener(‘appReloaded’, …)

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

Écoutez l'événement de rechargement de l'application, vous informez quand le rechargement a eu lieu

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

Returns : Promise<PluginListenerHandle>

Depuis : 4.3.0

---

addListener(‘appReady’, …)

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

Écouter l'événement d'appareil prêt dans l'Application, vous informe quand l'application est prête à l'utilisation

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

Retourne : Promise<PluginListenerHandle>

Depuis : 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Obtenir si l'auto-mise à jour est disponible (pas désactivé par serverUrl).

Retourne : Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Récupère le prochain bundle qui sera utilisé lors du rechargement de l'application. Renvoie null si aucun prochain bundle n'est défini.

Renvoie : Promise<BundleInfo | null>

Depuis : 6.8.0

---

setShakeMenu(…)

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

Activer ou désactiver le menu de secousses pour des fins de débogage/test.

Paramètre	Type	Description
options	SetShakeMenuOptions	Contient la valeur boolean pour activer ou désactiver le menu de secousses

Depuis : 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Récupère l'état actuel du menu de secousses

Retourne : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

---

Interfaces

AppReadyResult

Propriété	Type
bundle	BundleInfo

Informations de l'ensemble

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

URL de mise à jour

Propriété	Type
url	string

URL de statistiques

Propriété	Type
url	string

URL de canal

Propriété	Type
url	string

Options de téléchargement

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

Type	ChannelUrl	Description	Default	Depuis
url	string	L’URL du fichier zip du bundle (par exemple : dist.zip) à télécharger. (Cela peut être n'importe quelle URL. Par exemple : Amazon S3, un GitHub tag, tout autre endroit où vous avez hébergé votre bundle.)
version	string	La version code/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 pour 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 Delta (manifeste) téléchargements multi-fichier	undefined	6.1.0

ManifestEntry

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

Identifiant de la mise en paquet

Propriété	Type
id	string

Résultat de la liste de la mise en paquet

Propriété	Type
bundles	BundleInfo[]

Options de la liste

Propriété	Type	Description	Default	Depuis
raw	boolean	Renvoie la liste brute des bundles ou le manifeste. Si vrai, la liste tentera de lire la base de données interne au lieu des fichiers sur le disque.	false	6.14.0

Réinitialiser les options

Propriété	Type
toLastSuccessful	boolean

Résultat du bundle actuel

Propriété	Type
bundle	BundleInfo
native	string

MultiConditionsDeRetard

Propriété	Type
delayConditions	DelayCondition[]

ConditionDeRetard

Propriété	Type	Description
kind	DelayUntilNext	Configurer les conditions de retard dans setMultiDelay
value	string

DernièreVersion

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 pour Le canal doit autoriser ‘self_assign’ pour que cela fonctionne	undefined	6.8.0

ChannelRes

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

SetChannelOptions

Propriété	Type
channel	string
triggerAutoUpdate	boolean

Désactiver les options de canal

Propriété	Type
triggerAutoUpdate	boolean

Obtenir les résultats du canal

Propriété	Type	Description	Depuis
channel	string	État actuel d'obtention du canal	4.8.0
error	string
message	string
status	string
allowSet	boolean

Résultats de la liste des canaux

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

ChannelInfo

Propriété	Type	Description	Depuis
id	number	L'identifiant numérique du canal	7.5.0
name	string	Le nom du canal	7.5.0
public	boolean	Si vrai, il s'agit d'un canal par défaut ou de substitution. Les appareils ne peuvent pas se désigner eux-mêmes à des canaux publics. Au lieu de cela, lorsqu'un appareil supprime son canal de substitution (en utilisant unsetChannel()), il recevra automatiquement les mises à jour correspondantes du canal public correspondant.	7.5.0
allow_self_set	boolean	Si vrai, les appareils peuvent se désigner explicitement à ce canal en utilisant setChannel()Cela est généralement utilisé pour les tests de version bêta, les tests A/B ou les trajectoires d'actualisation par option.	7.5.0

Les commandes de canal utilisent le canal nameet non cet identifiant numérique id.

Options de définition de l'ID personnalisé

Propriété	Type
customId	string

Version Intégré

Propriété	Type
version	string

Id de l'appareil

Propriété	Type
deviceId	string

Version du Plugin

Propriété	Type
version	string

Mise à jour automatique activée

Propriété	Type
enabled	boolean

Gestionnaire de listener de plugin

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

Événement de téléchargement

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	Émet lorsqu'une nouvelle mise à jour est disponible.	4.0.0

MajorAvailableEvent

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

UpdateFailedEvent

Propriété	Type	Description	Depuis
bundle	BundleInfo	Emit lorsque l'installation d'une mise à jour a échoué.	4.0.0

DownloadFailedEvent

Propriété	Type	Description	Depuis
version	string	Emit lorsque le téléchargement a échoué.	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

Mise à jour automatique disponible

Propriété	Type
available	boolean

Options de menu de secousse

Propriété	Type
enabled	boolean

Activer le menu de secousses

Propriété	Type
enabled	boolean

Types de types

Statut du paquet

en attente : Le paquet est en attente d'être SET comme le prochain paquet. downloading : Le paquet est en cours de téléchargement. success : Le paquet a été téléchargé et est prêt à être SET comme le prochain bundle. erreur : Le bundle a échoué à se télécharger.

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

DelayUntilNext

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

Continuez à partir de Fonctions et paramètres

Si vous utilisez Fonctions et paramètres pour planifier le tableau de bord et les opérations API, connectez-l’avec En utilisant @capgo/capacitor-mises-à-jour pour la capacité native dans En utilisant @capgo/capacitor-mises-à-jour, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.