Fonctions et paramètres

Configurateur de l'actualiseur de plugin

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

CapacitorUpdater peut être configuré avec ces options :

Propriété	Type	Description	Description	Since
appReadyTimeout	number	Configurez le nombre de millisecondes que le plugin natif doit attendre avant de considérer une mise à jour comme « échouée ». Disponible sur Android, iOS et Electron.	10000 // (10 seconds)
responseTimeout	number	Configurez le nombre de millisecondes pendant lequel le plugin natif attend avant de considérer API comme une erreur de temps limite. Disponible sur Android, iOS et Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configurez si le plugin doit supprimer automatiquement les bundles échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin doit supprimer automatiquement les précédents 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 d'actualisation. true est le même que « en arrière-plan » ; false est le même que « éteint ». - éteint : 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 native de l'application, 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 - téléchargement uniquement : Vérifiez et téléchargez automatiquement, émettez updateAvailable et n'appliquez jamais le prochain bundle automatiquement. Les modes d'application instantanée ( « à l'installation », « à la mise en route », « toujours » ) doivent être téléchargés avec —delta afin d'éviter de ralentir l'expérience utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen : true et @capacitor/écran de splash avec launchAutoHide : false. Disponible sur Android, iOS et Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Supprimez automatiquement les anciens bundles téléchargés lorsque l'un des nouveaux bundles de l'application native est installé sur le dispositif. Disponible sur Android, iOS et Electron.	true
updateUrl	string	Configurez l'URL / point de terminaison vers lequel les vérifications d'actualisation sont envoyées. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configurez l'URL / point de terminaison pour les opérations de canal. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configurez l'URL / point de terminaison vers lequel sont envoyées les statistiques d'actualisation. Disponible sur Android, iOS et Electron. Définissez sur "" pour désactiver l'envoi de statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurez la clé publique pour une encryption à bout de live update fin Version 2. Disponible sur Android, iOS et Electron.	undefined	6.2.0
version	string	Configurez la version actuelle de l'application. Cette version sera utilisée pour la première demande d'actualisation. Si elle n'est pas définie, le plugin récupérera la version à partir du code natif. Disponible sur Android, iOS et Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Obsolète. Utilisez les modes de mise à jour automatique au lieu de cela : « à l'installation », « à la mise en route » ou « toujours ». Cette option reste prise en charge pour les applications existantes. L'application instantanée doit être téléchargée avec —delta afin d'éviter de ralentir l'expérience utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen : true et @capacitor/splash-screen avec launchAutoHide : false. - false : Jamais faire des mises à jour directes - à l'installation : Même chose que autoUpdate : « à l'installation » - à la mise en route : Même chose que autoUpdate : « à la mise en route » - toujours : Même chose que autoUpdate : « toujours » - true : Même chose que « toujours » pour la compatibilité backward. Disponible sur Android, iOS et Electron.	false	5.1.0
autoSplashscreen	boolean	Requis lors de l'utilisation des modes d'application instantanée ( « à l'installation », « à la mise en route » ou « toujours »), y compris les valeurs obsolètes directUpdate. @capacitor/splash-screen doit être installé et configuré avec launchAutoHide : false. Lorsqu'il est activé, le plugin cache la splashscreen après les mises à jour ou lorsque aucune mise à jour n'est nécessaire. Cela supprime la nécessité de s'abonner manuellement à des événements appReady et d'appeler SplashScreen.hide(). 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 les URL d'actualisation, de statistiques et de canal de manière dynamique 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 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	Configure the app id for the app in the config.	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	Activer la suppression de 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 lors de la débogage/test.	false	7.5.0

Exemples

Dans capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": "onlyDownload",
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

Dans capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: 'onlyDownload',
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfaces
• Types aliasés

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

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

Renvoie : Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Définissez l'URL de mise à jour pour l'application, elle sera utilisée pour vérifier les mises à jour.

Paramètre	Type	Description
options	UpdateUrl	contient l'URL à utiliser pour vérifier les mises à jour.

Depuis : 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

Définir l'URL des statistiques pour l'application, cette valeur sera utilisée pour envoyer des statistiques. Passer une chaîne vide désactivera la collecte de statistiques.

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

Depuis : 5.4.0

---

setChannelUrl(…)

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

Configurez l'URL du canal pour l'application, qui sera utilisée pour définir le canal.

Paramètre	Type	Description
options	ChannelUrl	contient l'URL à utiliser pour définir le canal.

Since: 5.4.0

---

Depuis :

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

Titre de la section « download(…) » : télécharger un nouveau bundle à partir de l'URL fournie, il doit s'agir d'un fichier zip contenant des fichiers ou un identifiant unique avec tous vos fichiers

Paramètres	Type	Description
options	DownloadOptions	La {@link} DownloadOptions} pour télécharger un nouveau zip de bundle.

Résultats : Promise<BundleInfo>

---

next(…)

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

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

Paramètres	Type	Description
options	BundleId	Contient l'ID du prochain Bundle à installer lors du prochain lancement de l'application. BundleInfo.id}

Résultats : Promise<BundleInfo>

---

set(…)

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

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

Paramètre	Type	Description
options	BundleId	A {@link} IdDeBundleobjet contenant l'identifiant de la nouvelle version à mettre en cours.

---

delete(…)

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

Supprime le bundle spécifié du stockage de l'application native. Utilisez avec {@link list} pour obtenir les IDs de Bundle stockés.

Paramètre	Type	Description
options	BundleId	A {@link} IdDeBundleobjet contenant l'ID d'un bundle à supprimer (notez que c'est l'ID du bundle, ET PAS le nom de la version)

---

list(…)

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

Get all locally downloaded bundles in your app

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

Résultats : Promise<BundleListResult>

---

reset(…)

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

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

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

---

current()

current() => Promise<CurrentBundleResult>

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

Retourne : Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recharger la vue

---

setMultiDelay(…)

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

Définit un tableau {@link} Condition de retard} contenant les conditions que le Plugin utilisera pour retarder la mise à jour. Après que toutes les conditions soient remplies, le processus de mise à jour sera relancé comme d'habitude, donc la mise à jour sera installée après un backgrounding ou la fermeture de l'application. Pour le date la valeur doit être une chaîne de date ISO 8601. Pour le background la valeur doit être un nombre en millisecondes. Pour le nativeVersion la valeur doit être le numéro de version. Pour le kill la valeur n'est pas utilisée. La fonction présente un comportement incohérent : l'option kill déclenche la mise à jour après la première fermeture et pas après le prochain background comme les autres options. Cela sera corrigé dans une future mise à jour majeure.

Paramètre	Type	Description
options	MultiDelayConditions	Contenant le {@link} MultiConditionsDeDélai} tableau de conditions à définir

Depuis : 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Depuis : 4.0.0

---

getLatest(…)

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

Get Latest bundle available from update Url

Paramètre	Type
options	GetLatestOptions

Retourne : 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 l'arrière-plan, puis stocke le canal sélectionné localement sur l'appareil. Il ne crée ni met à jour aucun Device Override sur l'arrière-plan, 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 du Public API sont affichés dans l'interface de surcharge de l'appareil.

Remarques importantes :

• N'employez pas cette méthode pour définir le canal au démarrage. Utilisez le defaultChannel dans votre configuration Capacitor à la place.
• 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).
• Si un canal est marqué comme Si un canal est marqué comme public, calling setChannel() Retournera une erreur. Pour utiliser un canal public, appelez unsetChannel() Au lieu de cela, le dispositif retombera automatiquement sur le canal public correspondant.
• Use listChannels() Découvrez les canaux disponibles et savoir si ils permettent l'auto-assignation.

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

Returns: 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 de bord ou du dispositif public API.

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

Cela est utile lorsque :

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

Paramètre	Type
options	UnsetChannelOptions

Since: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Copier dans le presse-papier

Returns: Promise<GetChannelRes>

Depuis : 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Chaque canal dans le résultat comprend :

• publicSi : trueCeci est une canaux par défautVous ne pouvez pas vous affecter à elle vous-même. setChannel()Enleverz votre affectation de canal en utilisant unsetChannel()Le dispositif recevra automatiquement les mises à jour de ce canal public.
• allow_self_set: Si true, ceci est un canal auto-attribuable. Vous pouvez attribuer explicitement le dispositif à ce canal à l'aide de setChannel().

Renvoie : Promise<ListChannelsResult>

Depuis : 7.5.0

---

setCustomId(…)

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

Attribuez un ID personnalisé à ce dispositif

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

Depuis : 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Retourne : Promise<BuiltinVersion>

Depuis : 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Récupère 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 d'actualisation Capacitor (envoyée au serveur d'actualisation automatique)

Retourne : Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Get the state of auto update config.

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. Cet événement se déclenche une fois le téléchargement commencé, pendant le téléchargement et lorsque celui-ci est terminé. Cela vous retourne 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

---

addListener('pasDeMiseAJour', …)

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

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

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener('miseÀJourDisponible', …)

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>

É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

---

ajouterUnEcouteur(‘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>

Listen for update fail event in the App, let you know when update has fail to install at next app start

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

Returns: Promise<PluginListenerHandle>

Renvoie : 2.3.0

---

ajouterUnEcouteurDeDownloadEchec(‘downloadFailed’, …)

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

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

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

ajouterUnEcouteur(‘appReloadé’, …)

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

Écoutez l'événement de rechargement de l'application, vous informez quand le rechargement est terminé

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.3.0

---

ajouterUnEcouteur(‘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'app 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>

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

Retourne : Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

Renvoie : Promise<BundleInfo | null>

Depuis : 6.8.0

---

setShakeMenu(…)

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

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

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

Depuis : 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

Retourne : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

---

Interfaces

AppReadyResult

Propriété	Type
bundle	BundleInfo

BundleInfo

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

UpdateUrl

Propriété	Type
url	string

StatsUrl

Propriété	Type
url	string

URL du canal

Propriété	Type
url	string

DownloadOptions

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

Propriété	Type	Description	Default	Depuis
url	string	URL du fichier zip du bundle (par exemple : dist.zip) à télécharger. (Cela peut être n'importe quel URL. Par exemple : Amazon S3, un tag GitHub, 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 les téléchargements Delta (manifest) multi-fichier	undefined	6.1.0

ManifestEntry

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

BundleId

Propriété	Type
id	string

BundleListResult

Propriété	Type
bundles	BundleInfo[]

Options de liste

Propriété	Type	Description	Default	Depuis
raw	boolean	Déterminez si vous souhaitez retourner la liste brute du bundle ou le manifeste. Si vrai, la liste tentera de lire la base de données interne au lieu des fichiers sur le disque.	false	6.14.0

ResetOptions

Propriété	Type
toLastSuccessful	boolean

Résultat du Bundle Actuel

Propriété	Type
bundle	BundleInfo
native	string

MultiDelayConditions

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 du canal défini	4.7.0
error	string
message	string

SetChannelOptions

Propriété	Type
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Propriété	Type
triggerAutoUpdate	boolean

GetChannelRes

Propriété	Type	Description	Depuis
channel	string	État actuel de récupération de canal	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	ID numérique du canal	7.5.0
name	string	Nom du canal	7.5.0
public	boolean	Si vrai, c'est un canal par défaut ou de remplacement. Les appareils ne peuvent pas se désigner eux-mêmes à des canaux publics. 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()Ceci est généralement utilisé pour les tests de version bêta, les tests A/B ou les trajectoires d'actualisation opt-in.	7.5.0

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

SetCustomIdOptions

Propriété	Type
customId	string

Version Intégré

Propriété	Type
version	string

DeviceId

Propriété	Type
deviceId	string

PluginVersion

Propriété	Type
version	string

AutoUpdateEnabled

Propriété	Type
enabled	boolean

PluginListenerHandle

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

DownloadEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

Propriété	Type	Description	Description
bundle	BundleInfo	Emit when a new update is available.	4.0.0

MajorAvailableEvent

Propriété	Type	Description	Depuis
version	string	Emit when a new major bundle is available.	4.0.0

UpdateFailedEvent

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

DownloadFailedEvent

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

AppReadyEvent

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

AutoUpdateAvailable

Propriété	Type
available	boolean

SetShakeMenuOptions

Propriété	Type
enabled	boolean

ShakeMenuEnabled

Propriété	Type
enabled	boolean

Type d'alias

Statut du bundle

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

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

DelayUntilNext

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

Continuez depuis Fonctions et paramètres

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