Fonctions et paramètres

Configuration du plugin de mise à jour

Voir le Github Lire le fichier 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	Configurez le nombre de millisecondes que le plugin natif devrait attendre avant de considérer API temps d'attente. Disponible sur Android, iOS et Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configurez si le plugin devrait supprimer automatiquement les bundles échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin devrait supprimer automatiquement les anciens bundles 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 devrait utiliser Mise à jour automatique via un serveur de mise à jour. true est le même que “en arrière-plan” ; false est le même que “désactivé”. - désactivé : Désactivez Mise à jour automatique - en 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 d'applications natives, sinon utilisez en arrière-plan - à lancement : Appliquez immédiatement au lancement, sinon utilisez en arrière-plan après le contrôle de lancement - toujours : Appliquez immédiatement chaque fois que Mise à jour automatique s'exécute - uniquementTéléchargement : Vérifiez et téléchargez automatiquement, émettez updateAvailable, et n'appliquez jamais le prochain bundle automatiquement. Disponible sur Android, iOS et Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Supprimer automatiquement les archives téléchargées précédentes lorsque l'une plus récente de l'application native est installée sur le dispositif. Disponible sur Android, iOS et Electron.	true
updateUrl	string	Configurer l'URL / point de terminaison vers lequel les vérifications de mise à jour sont envoyées. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configurer 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	Configurer l'URL / point de terminaison vers lequel les statistiques de mise à jour sont envoyées. Disponible sur Android, iOS et Electron. Définir sur "" pour désactiver la mise à jour des statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurer la clé publique pour la mise à jour en direct chiffrée de bout en bout, version 2. Disponible sur Android, iOS et Electron.	undefined	6.2.0
version	string	Configurer la version actuelle de l'application. Cette version sera utilisée pour la première demande de mise à jour. 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’	Désuet. 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. - false : Ne jamais faire de 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é de l'arrière. Disponible sur Android, iOS et Electron.	false	5.1.0
autoSplashscreen	boolean	Gérer automatiquement la suppression de l'écran de splash lorsque vous utilisez des modes d'application instantanée. Lorsque cette option est activée, 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 faire écouter manuellement les événements appReady et d'appeler SplashScreen.hide(). Cela fonctionne uniquement lorsque autoUpdate est défini sur “atInstall”, “onLaunch” ou “always”. Les valeurs directUpdate Legacy sont toujours prises en charge pour la compatibilité backward. Exige la présence et la configuration du plugin @capacitor/splash-screen avec launchAutoHide : false. Exige que l'actualisation automatique soit activée. Disponible sur Android et iOS.	false	7.6.0
periodCheckDelay	number	Configurez la période de retard 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 d'actualisation auto-hébergé.	undefined	4.17.48
localHost	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation auto-hébergé.	undefined	4.17.48
localWebHost	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation auto-hébergé.	undefined	4.17.48
localSupa	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation 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	Permettre 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éfinir le canal par défaut pour l'application dans la configuration. Sensible à la casse. Cette configuration remplacera le canal par défaut défini dans le cloud, mais respectera toujours les remplacements effectués dans le cloud.	undefined	5.5.0
appId	string	Configurer l'ID de l'application dans la configuration.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configurer 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ésactiver la journalisation JavaScript du plugin. Si vrai, le plugin ne loguera 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

Copier dans le presse-papiers 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
    }
  }
}

Copier dans le presse-papiers 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()
• In
• Type Aliases

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifiez l'actualiseur Capacitor 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. Modifiez ce comportement avec {@link appReadyTimeout}

Renvoie : Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Définissez l'URL d'actualisation 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 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 les statistiques.

Depuis : 5.4.0

---

setChannelUrl(…)

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

Définir l'URL de canal pour l'application, cela sera utilisé pour 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 à 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 contenant tous vos fichiers

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

next(…) Promise<BundleInfo>

---

Section intitulée « next(…) »

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

Définir le prochain ensemble de fichiers à utiliser lors du redémarrage de l'application.

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

Renvoie : 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'ID de bundle nouveau à définir en tant que courant. Supprimer la copie dans le presse-papierSupprime le spécifié bundle du stockage de l'application native. Utilisez {@link list} pour obtenir les ID de Bundle stockés.

---

Paramètre

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

Supprimer le spécifié bundle 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} contenant l'ID d'un bundle à supprimer (notez que c'est l'ID du bundle, PAS le nom de la version) BundleIdUn objet contenant l'ID d'un bundle à supprimer (notez que c'est l'ID du bundle, 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	Le {@link} Liste d'options} pour lister les bundles

Retourne : Promise<BundleListResult>

---

reset(…)

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

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

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

---

current()

current() => Promise<CurrentBundleResult>

Récupère la bibliothèque actuelle, si aucune n'est définie, elle retourne builtin. currentNative est la bibliothèque originale installée sur le dispositif

Retourne: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Rafraîchir la vue

---

setMultiDelay(…)

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

Définit un tableau {@link DelayCondition} contenant des 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. Cette 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	Type	Description
options	MultiDelayConditions	Contenant l'{@link __CAPGO_KEEP_0__} tableau d'conditions pour définir MultiDelayConditions} tableau d'conditions pour définir

Depuis : 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Depuis : 4.0.0

---

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.

Remarques importantes :

• N'utilisez pas cette méthode pour définir le canal au démarrage. Utilisez l' defaultChannel à la place dans votre configuration Capacitor.
• 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 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 - l'appareil tombera automatiquement sur le canal public correspondant.
• Utilisez listChannels() pour découvrir lesquels canaux sont disponibles et s'ils permettent la réaffectation automatique.

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

Renvoi : Promise<ChannelRes>

Depuis : 4.7.0

---

Section intitulée “unsetChannel(…)”

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

Réinitialisez la prise en charge de canal pour cet appareil. Après avoir appelé cette méthode, l'appareil recevra automatiquement des mises à jour du canal public qui correspond à ses conditions (plateforme, type d'appareil, 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 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 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 par l'utilisateur.

Chaque canal dans le résultat comprend :

• publicSi cela est vrai, alors c'est un truecanal par défaut Vous ne pouvez pas vous y assigner vous-même.Vous ne pouvez pas vous y assigner vous-même. setChannel(). Au lieu de cela, si vous supprimez l'affectation de votre canal en utilisant unsetChannel(), le dispositif recevra automatiquement des mises à jour à partir de ce canal public.
• allow_self_set: Si true, ce canal est un canal auto-assignable, vous pouvez affecter explicitement le dispositif à ce canal en utilisant setChannel().

Returns: 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__} identifiant personnalisé à définir

Depuis : 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Récupérer 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 un 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>

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

Retourne : Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Supprimer 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 du bundle dans l'application. Déclenché une fois que le téléchargement a 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

Retourne : Promise<PluginListenerHandle>

Depuis : 2.0.11

---

ajouter un écouteur (‘noNeedUpdate’, …)

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

Écoutez l'événement sans mise à jour nécessaire, utile lorsque vous souhaitez forcer une vérification chaque fois que l'application est lancée

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener('mise à jour disponible', …)

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

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

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

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

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

Ajoutez un écouteur pour les événements ‘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

Retourne : Promise<PluginListenerHandle>

Depuis : 2.3.0

---

addListener('mise à jour échouée', …)

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

Écoutez l'événement de fail de mise à jour 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

Renvoie : 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 fail de téléchargement dans l'Application, vous informez quand un bundle de téléchargement a échoué

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

Ajoutez un écouteur pour l'événement 'appReloaded', …

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

Écoutez l'événement de rechargement dans l'Application, vous informez quand un rechargement 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>

Écoutez 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

Renvoie : Promise<PluginListenerHandle>

Depuis : 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Obtenez si une mise à jour automatique est disponible (pas désactivée par serverUrl).

Retourne : Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtenez le prochain bundle qui sera utilisé lors du redémarrage de l'application. 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 secousses pour des fins de débogage/test

Paramètre	Type	Description
options	SetShakeMenuOptions	Contient un booléen activé pour activer ou désactiver le menu de secousses

Depuis : 7.5.0

---

__CAPGO_KEEP_0__

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Récupérer l'état actuel du menu de secousses

Retourne : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

---

Interfaces

Résultat d'AppReady

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

StatsUrl

Prop	Type
url	string

ChannelUrl

Prop	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.

Propriété	Type	Description	Défaut	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

Manifeste d'entrée

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

Identifiant de l'application

Propriété	Type
id	string

Résultat de la liste des identifiants d'application

Options de la liste	Section intitulée « Options de la liste »
bundles	BundleInfo[]

Section intitulée « Options de la liste »

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

Condition de retard

Description	Configurer les conditions de retard dans setMultiDelay	Propriété
kind	DelayUntilNext	Type
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	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

Options de canal de mise à jour

Propriété	Type
channel	string
triggerAutoUpdate	boolean

Options de canal non définies

Propriété	Type
triggerAutoUpdate	boolean

Résultat de canal

Propriété	Type	Description	Depuis
channel	string	État actuel du canal de récupération	4.8.0
error	string
message	string
status	string
allowSet	boolean

Liste des résultats 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 du canal	7.5.0
public	boolean	Si vrai, ce canal est par défaut ou de rechange. Les appareils ne peuvent pas se désigner eux-mêmes à des canaux publics. Au lieu de cela, lorsque l'appareil supprime son canal de surcouche (en utilisant unsetChannel()), il recevra automatiquement des mises à jour 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(). C'est généralement utilisé pour les tests de version bêta, les tests A/B ou les pistes d'actualisation opt-in.	7.5.0

Options de définition de l'ID personnalisé

Propriété	Type
customId	string

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
version	string

__CAPGO_KEEP_3__

__CAPGO_KEEP_5__	__CAPGO_KEEP_2__
deviceId	string

__CAPGO_KEEP_6__

__CAPGO_KEEP_5__	__CAPGO_KEEP_2__
version	string

Mise à jour automatique activée

Propriété	Type
enabled	boolean

Gestionnaire d'écouteur de plugin

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

Événement de téléchargement

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

NoNeedEvent

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

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

ÉvénementDisponibleMajeur

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

ÉvénementDeMiseÀJourÉchouée

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

Définir les options du menu de secousses

Propriété	Type
enabled	boolean

ShakeMenuActivé

Propriété	Type
enabled	boolean

Type d'alias

État de l'archive

en attente : L'archive est en attente de téléchargement. SET téléchargement en cours : L'archive est en cours de téléchargement. réussi : L'archive a été téléchargée et est prête à être utilisée. comme le prochain bundle. erreur : Le bundle a échoué à se télécharger.

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

DelayUntilNext

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