Fonctions et paramètres

Comprend les étapes d'installation, de synchronisation et la guide markdown source.

Voir le Github 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 doit attendre avant de considérer une mise à jour comme « échouée ». 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 API comme temps d'attente. Disponible sur Android, iOS et Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configurez si le plugin doit supprimer automatiquement les bundles échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin doit supprimer automatiquement les anciens bundles après une mise à jour réussie. Disponible sur Android, iOS et Electron.	true
autoUpdate	boolean	Configurez si le plugin doit utiliser l'actualisation automatique via un serveur d'actualisation. Disponible sur Android, iOS et Electron.	true
resetWhenUpdate	boolean	Supprimer automatiquement les anciens bundles téléchargés lorsque l'on installe une nouvelle version de l'application native 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 sur "" pour désactiver la mise à jour des statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurez la clé publique pour l'encryption en direct à la fin de la mise à jour. 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 requête d'actualisation. Si elle n'est pas définie, le plugin récupérera la version de l'application native code. Disponible sur Android, iOS et Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Configurez quand le plugin doit effectuer des mises à jour directes. Seulement pour le mode autoUpdate. Fonctionne bien pour les applications inférieures à 10MB et avec des téléchargements effectués à l'aide de la flag —delta. Les fichiers zip ou les applications supérieures à 10MB seront relativement lents pour les utilisateurs lors des mises à jour. - faux : Jamais effectuer des mises à jour directes (utiliser le comportement par défaut : télécharger au démarrage, définir lorsqu'on est en arrière-plan) - à l'installation : Mettre à jour uniquement lorsque l'application est installée, mise à jour depuis l'App Store, sinon agir comme directUpdate = faux - à la mise en route : Mettre à jour uniquement lorsque l'application est installée, mise à jour depuis l'App Store ou après avoir tué l'application, sinon agir comme directUpdate = faux - toujours : Mettre à jour dans tous les cas précédents (application installée, mise à jour depuis l'App Store, après avoir tué l'application ou l'application redémarrée), ne jamais agir comme directUpdate = faux - vrai : (déprécié) Même chose que “toujours” pour la compatibilité backward. Disponible sur Android, iOS et Electron.	false	5.1.0
autoSplashscreen	boolean	Automatisez la gestion de la suppression de l'écran de splash lorsque vous utilisez directUpdate. Lorsque cela est activé, le plugin supprimera automatiquement l'écran de splash après les mises à jour ou lorsque aucune mise à jour n'est nécessaire. Cela supprime la nécessité de s'abonner à des événements appReady et d'appeler SplashScreen.hide(). Seulement fonctionne lorsque directUpdate est défini sur “à l'installation”, “toujours” ou vrai. Exige que le plugin @capacitor/splash-screen soit installé et configuré avec launchAutoHide : faux. Exige que autoUpdate et directUpdate soient activés. Disponible sur Android et iOS.	false	7.6.0
periodCheckDelay	number	Configurez la période de retard pour la mise à jour périodique. 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	Autorisez le plugin à modifier l'URL de mise à jour, l'URL de statistiques et l'URL de canal dynamiquement 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 surcharges effectuées dans le cloud.	undefined	5.5.0
appId	string	Configurez l'ID de l'application pour 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 effacé.	false	6.8.0
disableJSLogging	boolean	Désactivez la journalisation JavaScript du plugin. Si vrai, le plugin ne journalira pas dans la console JavaScript. Seule la journalisation native sera effectuée	false	7.3.0
shakeMenu	boolean	Activer le geste de secousses pour afficher le menu de mise à jour pour des 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": false,
      "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: false,
      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
• Définitions de types

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifier l'Capacitor Metteur à jour que le bundle actuel fonctionne (un roulage sera effectué 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 un roulage se produira. Modifier ce comportement avec {@link appReadyTimeout}

Retourne: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Définir l'URL de mise à jour pour l'application, cette valeur 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 URL sera utilisée pour envoyer des statistiques. La transmission d'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, cela sera utilisé 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 identifiant unique à l'intérieur avec tous vos fichiers

Paramètre	Type	Description
options	DownloadOptions	Le {@link Options de téléchargement pour un nouveau zip de bundle.Renvoie :

next(…) Promise<BundleInfo>

---

Section intitulée “next(…)”

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

Paramètre

__CAPGO_KEEP_0__	Type	Description
options	BundleId	Contient l'ID du prochain Bundle à définir lors du prochain lancement de l'application. {@link BundleInfo.id}

Retourne: 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 BundleId} contenant le nouveau identifiant de bundle à définir en tant que courant. BundleIdSupprimer (…)

---

Section intitulée “Supprimer (…)

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

Paramètre

Type	Description	Un objet {@link BundleId}
options	BundleId	__CAPGO_KEEP_0__ __CAPGO_KEEP_1__Objet contenant l'ID d'un bundle à supprimer (note, ceci est l'ID du bundle, ET PAS le nom de la version)

---

liste(…)

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

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

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

Renvoie : Promise<BundleListResult>

---

reset(…)

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

Réinitialiser l'application sur la builtin paquet (celui envoyé sur l'App Store d'Apple / Google Play Store ) ou le dernier paquet chargé avec succès.

Paramètre	Type	Description
options	ResetOptions	Contenant {@link ResetOptions.toLastSuccessful}, true réinitialise sur le paquet intégré et false réinitialisera sur le dernier paquet 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 le dispositif

Renvoie : 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. 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 background ou la fermeture de l'application. Pour le "kind", la valeur doit être une chaîne de date ISO 8601. Pour le "kind", la valeur doit être un nombre en millisecondes. Pour le "kind", la valeur doit être le numéro de version. Pour le "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 prochaine version majeure. ParamètreType date Description background Contenant le {@link "DelayCondition"} nativeVersion Copier dans le presse-papier kill Définit un tableau {@link "DelayCondition"} 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 background ou la fermeture de l'application. Pour le "kind", la valeur doit être une chaîne de date ISO 8601. Pour le "kind", la valeur doit être un nombre en millisecondes. Pour le "kind", la valeur doit être le numéro de version. Pour le "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 prochaine version majeure.

Paramètre	Type	Description
options	MultiDelayConditions	Contenant le {@link "DelayCondition"} MultiConditionsDeRetard__CAPGO_KEEP_0__

Depuis : 4.3.0

---

annulerRetard()

cancelDelay() => Promise<void>

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

Section intitulée « getLatest(…) » 4.0.0

---

Section intitulée « getLatest(…) »

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

Obtenir le dernier bundle disponible à partir de 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 pour cet appareil. Le canal doit être allow_device_self_set activé pour que cela fonctionne.

Notes importantes :

• N'utilisez pas cette méthode pour définir le canal lors du démarrage. Utilisez au lieu de cela defaultChannel dans votre Capacitor de configuration.
• Cette méthode est destinée à l'utilisation après que l'application est prête et que l'utilisateur a interagi (par exemple, en optant pour un programme bêta).
• Les canaux publics ne peuvent pas être attribués par soi-même. Si un canal est marqué comme public, l'appel à setChannel() retournera une erreur. Pour utiliser un canal public, appelez unsetChannel() au lieu de cela - le dispositif tombera automatiquement sur le canal public correspondant.
• Utilisez listChannels() pour découvrir quels canaux sont disponibles et s'ils permettent l'attribution par soi-même.

Paramètre	Type	Description
options	SetChannelOptions	Est-ce que le canal {@link Définir les options du canalRetourne :

Depuis : Promise<ChannelRes>

unsetChannel(…) 4.7.0

---

Section intitulée “unsetChannel(…)

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

canal public qui correspond à ses conditions (plateforme, type d'appareil, type de build). Copier dans le presse-papier

Cela est utile lorsque :

• Vous souhaitez remettre un appareil sur la piste d'actualisation par défaut
• Vous souhaitez utiliser un canal public (puisquels canaux publics ne peuvent pas être attribués 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

---

listCanaux()

listChannels() => Promise<ListChannelsResult>

Liste de tous les canaux disponibles pour cet appareil. Retourne les canaux qui sont compatibles avec l'environnement actuel de l'appareil (plateforme, émulateur/appareil réel, build de développement/prod) et qui sont soit publics, soit autorisent la mise à jour automatique.

Chaque canal dans le résultat comprend :

• publicSi true, ce canal est un canaux par défaut. Vous ne pouvez pas vous y assigner vous-même à l'aide de setChannel(). Au lieu de cela, si vous supprimez votre affectation de canal à l'aide de unsetChannel(), l'appareil recevra automatiquement les mises à jour de ce canal public.
• allow_self_setSi true, c'est une chaîne auto-attribuable. Vous pouvez attribuer explicitement le dispositif à cette chaîne en utilisant setChannel().

Renvoie : Promise<ListChannelsResult>

Depuis : 7.5.0

---

setCustomId(…)

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

Définir une ID personnalisée pour ce dispositif

Paramètre	Type	Description
options	SetCustomIdOptions	est le {@link __CAPGO_KEEP_0__} __CAPGO_KEEP_0__ à définir Options de configuration de l'ID personnaliséDepuis : __CAPGO_KEEP_1__

getBuiltinVersion() 4.9.0

---

Section intitulée « getBuiltinVersion() »

getBuiltinVersion() => Promise<BuiltinVersion>

Retourne : __CAPGO_KEEP_2__

Depuis : __CAPGO_KEEP_3__ Promise<BuiltinVersion>

getDeviceId() 5.2.0

---

Section intitulée « getDeviceId() »

getDeviceId() => Promise<DeviceId>

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

Renvoie : Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Renvoie : Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Obtenez l'état de la configuration d'auto-mise à jour.

Renvoie : Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Supprime tous les écouteurs pour 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'application. Déclenché une fois le téléchargement commencé, pendant le téléchargement et lorsque terminé. Cela vous renverra tous les pourcentages de téléchargement pendant le téléchargement

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.0.11

---

addListener('noNeedUpdate', …)

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

Écouter l'événement sans mise à jour nécessaire, utile lorsque vous souhaitez effectuer une vérification toutes les fois que l'application est lancée

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener('updateAvailable', …)

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

Écouter pour 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('downloadComplete', …)

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

Écouter les événements downloadComplete.

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener('majorAvailable', …)

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

Écouter l'événement de mise à jour majeure dans l'application, vous informe quand une mise à jour majeure est bloquée en définissant disableAutoUpdateBreaking

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

Renvoie : 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 la 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('downloadFailed', …)

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

Renvoie : 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

Renvoie : 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 la mise à jour automatique est disponible (pas désactivée 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 une valeur booléenne 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

Résultat de l'application prête

Propriété	Type
bundle	BundleInfo

Informations de bundle

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

Cette URL et versions sont utilisées pour télécharger le bundle depuis le serveur. Si vous utilisez un backend, toutes les informations seront fournies par la méthode getLatest. Si vous ne utilisez pas de backend, vous devez fournir l'URL et la version du bundle. Les clés de session sont requises si vous avez chiffré le bundle avec la commande CLI encrypt, vous devriez les recevoir en tant que résultat de la commande.

Propriété	Type	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 devrait ê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

IdBundle

Propriété	Type
id	string

Résultat de la liste des bundles

Propriété	Type
bundles	BundleInfo[]

Options de la liste

Propriété	Type	Description	Par défaut	Depuis
raw	boolean	Déterminez si vous souhaitez retourner la liste brute du bundle 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

Conditions de retard multiple

Propriété	Type
delayConditions	DelayCondition[]

MultiDelayCondition

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

Dernière version

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

Options pour GetLatest

Propriété	Type	Description	Valeur 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	État actuel de la mise en canal	4.7.0
error	string
message	string

Options de mise en canal

Propriété	Type
channel	string
triggerAutoUpdate	boolean

Options de désactivation de mise en canal

Propriété	Type
triggerAutoUpdate	boolean

Obtenir les résultats du canal

Propriété	Type	Description	Depuis
channel	string	État actuel de récupération 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

Informations sur le canal

Propriété	Type	Description	Depuis
id	string	L'ID du canal	7.5.0
name	string	Le nom de la chaîne	7.5.0
public	boolean	Si vrai, il s'agit d'une chaîne par défaut ou de remplacement. Les appareils ne peuvent pas se désigner eux-mêmes à des chaînes publiques. Au lieu de cela, lorsque l'appareil supprime son décalage de chaîne (en utilisant __CAPGO_KEEP_0__), il recevra automatiquement les mises à jour de la chaîne publique correspondante. unsetChannel()Si vrai, les appareils peuvent se désigner explicitement à cette chaîne en utilisant __CAPGO_KEEP_0__. 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
allow_self_set	boolean	Options de définition d'ID personnalisé setChannel()Section intitulée “Options de définition d'ID personnalisé”	7.5.0

Propriété

Version intégrée	Section intitulée “Version intégrée”
customId	string

Propriété

Section titled “SetCustomIdOptions”	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

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

Pas de besoin d'événement

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

Événement de mise à jour disponible

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

MajorAvailableEvent

Propriété	Type	Description	Depuis
version	string	Émettre lorsque de nouvelles versions majeures du bundle sont disponibles.	4.0.0

UpdateFailedEvent

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

DownloadFailedEvent

Propriété	Type	Description	Depuis
version	string	Émettre lorsque le téléchargement échoue.	4.0.0

Événement d'AppReady

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

Définir les options du menu de secousse

Propriété	Type
enabled	boolean

Menu de secousse activé

Propriété	Type
enabled	boolean

Type Aliases

État de la Bundling

pending : La mise en bundle est en attente de SET comme la prochaine mise en bundle. downloading : La mise en bundle est en cours de téléchargement. success : La mise en bundle a été téléchargée et est prête à être SET comme la prochaine mise en bundle. error : La mise en bundle a échoué à se télécharger.

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

Attendre Jusqu'à la Prochaine

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