Configuration des fonctions

Configuration du plugin de mise à jour

Voir le Github Lisez le fichier Readme pour en savoir plus.

Le CapacitorUpdater peut être configuré avec ces options :

Propriété	Type	Description	Default	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	Configure the number of milliseconds the native plugin should wait before considering API timeout. Available on Android, iOS, and Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configurez si le plugin doit utiliser automatiquement la suppression des paquets échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin doit utiliser automatiquement la suppression des paquets précédents après une mise à jour réussie. Disponible sur Android, iOS et Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Configurez 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 - à la mise en route : Appliquez immédiatement à la mise en route, sinon utilisez en arrière-plan après le contrôle de mise en route - toujours : Appliquez immédiatement chaque fois que l'auto-mise à jour s'exécute - uniquementTéléchargement : Vérifiez et téléchargez automatiquement, émettez updateAvailable et n'appliquez jamais le prochain paquet automatiquement. Disponible sur Android, iOS et Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Supprimez automatiquement les paquets téléchargés précédemment lorsque l'un des paquets d'applications natives plus récents 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 la mise à jour des statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurez la clé publique pour l'encryption de mise à jour en direct à bout en bout, 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 de mise à jour. Si elle n'est pas définie, le plugin récupérera la version du native 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 à la place : “à l'installation”, “à la mise en route” ou “toujours”. Cette option reste prise en charge pour les applications existantes. - false : N'effectuez jamais 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é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é avec les versions antérieures. 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 CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation auto-hébergé.	undefined	4.17.48
localHost	string	Configurez CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation auto-hébergé.	undefined	4.17.48
localWebHost	string	Configurez CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation auto-hébergé.	undefined	4.17.48
localSupa	string	Configurez CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation auto-hébergé.	undefined	4.17.48
localSupaAnon	string	Configurez CLI pour utiliser un serveur local pour les tests.	undefined	4.17.48
localApi	string	Configurez CLI pour utiliser un serveur local api pour les tests.	undefined	6.3.3
localApiFiles	string	Configurez CLI pour utiliser un fichier local api pour les tests.	undefined	6.3.3
allowModifyUrl	boolean	Permettre au plugin de modifier dynamiquement l'URL d'actualisation, l'URL de statistiques et l'URL de canal depuis le côté JavaScript.	false	5.4.0
defaultChannel	string	Configurez 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	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 vidé.	false	6.8.0
disableJSLogging	boolean	Désactivez l'affichage des journaux JavaScript du plugin. Si vrai, le plugin ne loguera pas dans la console JavaScript. Seuls les journaux natifs seront effectués	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
• Type Aliases

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifier l'Capacitor Updater que le bundle actuel est en cours d'exécution (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 sera effectué. 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 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 du 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écharger un nouveau bundle à partir de l'URL fournie, il doit s'agir d'un fichier zip, avec des fichiers à l'intérieur ou avec un ID unique à l'intérieur avec tous vos fichiers

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

next (…) Promise<BundleInfo>

---

Téléchargement (…)

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 l'ensemble de fichiers 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. delete(…)Section intitulée “delete(…)

---

Copier dans le presse-papier

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

Type

Description	A {@link} object containing the new bundle id to set as current.	Description
options	BundleId	Un {@link Un objet BundleId contenant l'ID d'un bundle à supprimer (notez que c'est l'ID du bundle, ET PAS le nom de la version)list(…)

---

Section intitulée “list(…)

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

Paramètre

Type	Description	Le {@link
options	ListOptions	protectedTokens 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 (lequel a été envoyé à l'App Store d'Apple / Google Play Store) ou le dernier bundle chargé avec succès.

Paramètre	Type	Description
options	ResetOptions	Contenant {@link} RéinitialiserOptions.toLastSuccessful}, true se réinitialise sur le bundle intégré et false se réinitialisera sur le dernier bundle chargé avec succès.

---

current()

current() => Promise<CurrentBundleResult>

Récupère le bundle actuel, si aucun n'est défini, il retourne builtin. currentNative est le bundle original installé sur le dispositif

Retourne: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Rafraîchir la vue

---

setMultiDelay(…)

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

Configure un tableau {@link DelayCondition} contenant des conditions que le Plugin utilisera pour retarder l'actualisation. Après que toutes les conditions soient remplies, le processus d'actualisation sera relancé comme d'habitude, donc l'actualisation sera installée après un backgrounding ou la fermeture de l'application. Pour le date kind, la valeur doit être une chaîne de date ISO 8601. Pour le background kind, la valeur doit être un nombre en millisecondes. Pour le nativeVersion kind, la valeur doit être le numéro de version. Pour le kill kind, la valeur n'est pas utilisée. La fonction présente un comportement incohérent lorsque l'option kill déclenche l'actualisation 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'array {@link MultiDelayConditions} de conditions à 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>

[targetLanguage] allow_device_self_set Sets the plugin-managed local channel for this device. The channel must have

setChannel() validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in the Capgo dashboard. Only assignments created from the dashboard or the Public API are shown in the Device Override UI.

validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in le tableau de bord de __CAPGO_KEEP_0__. Only assignments created from the tableau de bord or the Public __CAPGO_KEEP_1__ are shown in the Device Override UI.

• Important notes: defaultChannel in your Capacitor config instead.
• in votre fichier de configuration de __CAPGO_KEEP_0__ au lieu de cela.
• This method is intended for use after the app is ready and the user has interacted (e.g., opting into a beta program). Public channels cannot be self-assigned. publicIf a channel is marked as setChannel() , calling unsetChannel() will return an error. To use a public channel, call instead - the device will automatically fall back to the matching public channel.
• Utilisez listChannels() pour découvrir quels 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

Retourne : Promise<ChannelRes>

Depuis : 4.7.0

---

unsetChannel(…)

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

Définir 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 la mise à jour de l'appareil.

Après l'appel de cette méthode, la priorité normale du canal s'applique : un canal existant de l'interface utilisateur ou public API pour la mise à jour de l'appareil gagne toujours ; sinon, l'appareil peut tomber en arrière sur le canal public/par défaut correspondant à ses conditions (plateforme, type d'appareil, type de construction).

Cela est utile lorsque :

• Vous souhaitez déplacer un appareil vers la piste de mise à jour par défaut
• Vous souhaitez utiliser un canal public (puisquels les canaux publics ne peuvent pas être attribué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>

Listez 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 dev/prod) et qui sont soit publics, soit autorisent l'auto-assignation.

Chaque canal dans le résultat comprend :

• publicSi cela est vrai, c'est un truecanal par défaut Copier dans le presse-papier. Vous ne pouvez pas vous affecter vous-même à elle en utilisant setChannel(). Au lieu de cela, si vous supprimez votre affectation de 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 affectable par l'utilisateur. Vous pouvez affecter explicitement le dispositif à ce canal en utilisant setChannel().

Returns: Promise<ListChannelsResult>

Depuis: 7.5.0

---

setCustomId(…)

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

Configurez une ID personnalisée pour cet appareil

Paramètre	Type	Description
options	SetCustomIdOptions	est la {@link SetCustomIdOptions} ID personnalisée à configurer

Depuis : 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Obtenez la version de l'application native ou la version intégrée si définie dans la configuration

Returns: Promise<BuiltinVersion>

Depuis: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Returns: 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)

Returns: Promise<PluginVersion>

---

estActivéLaMiseÀJourAutomatique()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

Retourne: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Supprimez tous les écouteurs pour ce plugin.

Depuis: 1.0.0

---

addListener('download', …)

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

Écoutez l'événement de téléchargement 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

---

Ajoutez l'é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 la 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>

Écoutez l'événement de mise à jour disponible, utile lorsque vous souhaitez forcer la vérification chaque fois que l'application est lancée

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

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

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

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

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

Ajouter un écouteur pour les mises à jour majeures (‘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

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 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('téléchargement échoué', …)

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

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

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener(‘appReloaded’, …)

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

É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

Retourne : Promise<PluginListenerHandle>

Depuis : 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Obtenir 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 rechargement 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 une valeur booléenne pour activer ou désactiver le menu de secousses

Depuis : 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtenir l'état actuel du menu de secousses

Renvoie : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

---

Interfaces

AppReadyResult

Propriété	Type
bundle	BundleInfo

BundleInfo

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

URL de mise à jour

Propriété	Type
url	string

StatsUrl

Propriété	Type
url	string

ChannelUrl

Propriété	Type
url	string

Options de téléchargement

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

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

Entrée de manifeste

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 des paquets

Propriété	Type
bundles	BundleInfo[]

Options de la liste

Propriété	Type	Description	Valeur par défaut	Depuis
raw	boolean	Indiquez si vous souhaitez retourner la liste des bundles bruts ou le manifeste. Si true, la liste tentera de lire la base de données interne au lieu des fichiers sur le disque.	false	6.14.0

ResetOptions

Propriété	Type
toLastSuccessful	boolean

Résultat de la dernière mise à jour de bundle

Propriété	Type
bundle	BundleInfo
native	string

ConditionsDeRétardMultipliées

Propriété	Type
delayConditions	DelayCondition[]

ConditionDeRétard

Propriété	Type	Description
kind	DelayUntilNext	Configure 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	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

Définir les options de canal

Propriété	Type
triggerAutoUpdate	boolean

Obtenir les résultats du canal

Propriété	Type	Description	Depuis
channel	string	État actuel de la chaîne de récupération	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

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

ChannelInfo

Propriété	Type	Description	Depuis
id	number	__CAPGO_KEEP_0__	7.5.0
name	string	__CAPGO_KEEP_0__	7.5.0
public	boolean	Si vrai, ce canal est un canal par défaut/fallback. 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 surcharge (en utilisant unsetChannel()), il recevra automatiquement les 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(). Cela 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

Les commandes de canal utilisent le canal name et non ce nombre id.

. Utilisez la méthode SetCustomIdOptions pour définir le nom du canal personnalisé si nécessaire.

Propriété	Type
customId	string

VersionBuiltin

Propriété	Type
version	string

IdDeLAppareil

Propriété	Type
deviceId	string

VersionDuPlugin

Propriété	Type
version	string

Mise à jour automatique activée

Propriété	Type
enabled	boolean

Gestionnaire de listener du 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

Pas de besoin d'événement

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	Emit lorsque de nouvelles mises à jour sont disponibles.	4.0.0

MajorAvailableEvent

Prop	Type	Description	Depuis
version	string	Emit lorsque de nouvelles mises à jour majeures sont disponibles.	4.0.0

UpdateFailedEvent

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

DownloadFailedEvent

Propriété	Type	Description	Depuis
version	string	Émet lorsque le téléchargement a échoué.	4.0.0

Événement AppReady

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

Une mise à jour automatique est disponible

Propriété	Type
available	boolean

Paramètres de menu de secousses à définir

Propriété	Type
enabled	boolean

Activer le menu de secousses

Propriété	Type
enabled	boolean

Alias de type

État du bundle

en attente : Le bundle est en attente de traitement SÉLECTIONNER comme le prochain bundle. downloading : Le bundle est en cours de téléchargement. success : Le bundle a été téléchargé et est prêt à être SÉLECTIONNER comme le prochain bundle. error : Le bundle a échoué à se télécharger.

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

Attente de la prochaine étape

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

Continuez depuis les fonctions et les paramètres

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