Fonctions et paramètres

Plugin de mise à jour Configurateur

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 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 comme un 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 utilise l'Auto Mise à jour 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 l'Auto Mise à jour - 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 l'Auto Mise à jour 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	Supprimez automatiquement les anciens bundles téléchargés lorsque l'un des nouveaux bundles d'applications natives 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 de mise à jour 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 sont envoyées les statistiques d'actualisation. Disponible sur Android, iOS et Electron. Définissez-la sur "" pour désactiver le rapport de statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurez la clé publique pour le chiffrement en direct de mise à jour live 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 native à partir de l'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. - 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é backward. Disponible sur Android, iOS et Electron.	false	5.1.0
autoSplashscreen	boolean	Gérez automatiquement la disparition de l'écran de démarrage lors de l'utilisation des modes d'application instantanée. Lorsque cette option est activée, le plugin cachera automatiquement l'écran de démarrage 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(). Seul fonctionne lorsque autoUpdate est défini sur “à l'installation”, “à la mise en route” ou “toujours”. Les valeurs directUpdate legacy sont toujours prises en charge pour la compatibilité backward. Exige la présence du plugin @capacitor/splash-screen installé et configuré avec launchAutoHide : false. Exige la mise à jour automatique être 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. 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 d'accès 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": "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
• Définitions de type

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifier l'Capacitor Metteur à jour que le bundle actuel fonctionne (un rollback 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 un rollback se produira. Modifiez 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éfinissez l'URL des statistiques pour l'application, cette URL 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>

Configurez l'URL du canal pour l'application, elle sera utilisée pour configurer le canal.

Paramètre	Type	Description
options	ChannelUrl	contient l'URL à utiliser pour configurer 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 ID 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

options de téléchargement pour un nouveau zip de bundle	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 BundleId} contenant le nouveau identifiant de bundle à définir en tant que courant. delete(…)Sous-section intitulée “delete(…)

---

Copier dans le presse-papier

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

Type

Description	Un objet {@link BundleId}	Param
options	BundleId	Type DescriptionObjet 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 ListOptions} pour lister les bundles

Retourne : Promise<BundleListResult>

---

réinitialiser(…)

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

Réinitialiser l'application vers la builtin dernière archive (celle envoyée sur l'App Store / Google Play Store) ou la dernière archive chargée avec succès.

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

---

current()

current() => Promise<CurrentBundleResult>

Obtenez le bundle actuel, si aucun n'est défini, il retourne builtin . currentNative est le bundle d'origine installé sur le dispositif

Résultats : 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 backgrounding ou la fermeture de l'application. Pour le la valeur doit être une chaîne de date ISO8601. Pour le la valeur doit être un nombre en millisecondes. Pour le date la valeur doit être le numéro de version. Pour le background la valeur n'est pas utilisée. La fonction présente un comportement incohérent : l'option 'kill' déclenche la mise à jour après le premier kill et pas après le prochain background comme les autres options. Cela sera corrigé dans une future mise à jour majeure. nativeVersion Paramètre kill Type

Description	Contenant le {@link	__CAPGO_KEEP_0__
options	MultiDelayConditions	__CAPGO_KEEP_1__ MultiConditionsDeRetard} tableau de conditions à définir

Depuis : 4.3.0

---

annulerRetard()

cancelDelay() => Promise<void>

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

Depuis : 4.0.0

---

getDernier(…)

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 activé pour que cela fonctionne.

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 Device Override sur le serveur, donc l'appareil ne sera pas affiché comme étant surchargé dans le tableau de bord Capgo. Seuls les affectations créées à partir du tableau de bord ou de Public API sont affichés dans l'interface d'UI de surcharge de l'appareil.

Remarques importantes :

• N'employez pas cette méthode pour définir le canal au démarrage. Utilisez au lieu de cela defaultChannel in your Capacitor config instead.
• Les canaux publics ne peuvent pas être affectés par l'utilisateur.
• Si un canal est marqué comme , l'appel à publicretournera une erreur. Pour utiliser un canal public, appelez setChannel() au lieu de cela - le dispositif tombera automatiquement sur le canal public correspondant. unsetChannel() Utilisez
• pour découvrir quels canaux sont disponibles et s'ils permettent l'affectation par l'utilisateur. listChannels() Paramètre

Param	Type	Description
options	SetChannelOptions	Est-ce que le canal {@link SetChannelOptions} est défini pour

Retourne: 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 l'interface utilisateur ou public API pour le dispositif

After l'appel de cette méthode, la priorité normale des canaux s'applique : un Dashboard ou un API Override de dispositif public existant gagne encore ; 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 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>

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, c'est un canaux par défaut. Vous ne pouvez pas vous assigner à ce canal en utilisant setChannel(). Au lieu de cela, si vous supprimez votre affectation de canal en utilisant unsetChannel(), l'appareil recevra automatiquement les mises à jour à partir de ce canal public.
• allow_self_set: Si true, c'est une 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 Paramètres de l'ID personnaliséDepuis :

getBuiltinVersion() 4.9.0

---

Section intitulée “getBuiltinVersion()”

getBuiltinVersion() => Promise<BuiltinVersion>

Retourne :

Depuis : Promise<BuiltinVersion>

getDeviceId() 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 du plugin de mise à jour Capacitor (envoyée au serveur d'auto-mise à jour)

Retourne : Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Obtenez l'état de la configuration d'actualisation 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'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>

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

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

É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

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 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 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'App, vous informe quand l'appareil est prêt à l'utilisation

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

Renvoie : Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtenez le prochain lot qui sera utilisé lors du rechargement de l'application. Renvoie null si aucun prochain lot 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 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

Résultat de l'application prêt

Propriété	Type
bundle	BundleInfo

Informations de la mise en bundle

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

URL de mise à jour

Propriété	Type
url	string

URL des statistiques

Propriété	Type
url	string

UrlDuChaînon

Propriété	Type
url	string

OptionsDeTé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	OptionsDeTéléchargement	Description	Par 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 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

Id de la boutique

Propriété	Type
id	string

Résultat de la liste de la boutique

Propriété	Type
bundles	BundleInfo[]

Options de la liste

Propriété	Type	Description	Par défaut	Depuis
raw	boolean	Indiquez 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 multiples

Propriété	Type
delayConditions	DelayCondition[]

Condition de retard

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 de 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 de la mise en place du canal	4.7.0
error	string
message	string

Options de canal

Propriété	Type
channel	string
triggerAutoUpdate	boolean

Options de canal non définies

Propriété	Type
triggerAutoUpdate	boolean

Obtenir le résultat du canal

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

Résultat 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'ID de canal numérique	7.5.0
name	string	Le nom du canal	7.5.0
public	boolean	Si vrai, c'est un canal par défaut ou de secours. Les appareils ne peuvent pas se désigner eux-mêmes à des canaux publics. Au lieu de cela, lorsque l'appareil supprime son canal personnalisé (en utilisant __CAPGO_KEEP_0__) unsetChannel()Il recevra automatiquement les mises à jour correspondant au canal public correspondant.	7.5.0
allow_self_set	boolean	Si vrai, les appareils peuvent se désigner explicitement à ce canal en utilisant __CAPGO_KEEP_0__. setChannel()Ceci est généralement utilisé pour les tests de beta, les tests A/B ou les trajectoires d'actualisation par opt-in.	7.5.0

Commandes de canal utilisent le canal name, pas ce nombre id.

Options de configuration de l'ID personnalisé

Propriété	Typage
customId	string

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	Type
version	string

__CAPGO_KEEP_2__

__CAPGO_KEEP_1__	Type
deviceId	string

__CAPGO_KEEP_3__

__CAPGO_KEEP_1__	Type
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 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	É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

Disponible pour la mise à jour automatique

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’

Attendez le prochain

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

Continuez depuis Fonctions et paramètres

Si vous utilisez Fonctions et paramètres pour planifier les opérations de tableau de bord et API , connectez-le avec Utilisation de @capgo/capacitor-mises-à-jour pour la capacité native dans Utilisation de @capgo/capacitor-mises-à-jours API Vue d'ensemble pour les détails 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.