Fonctions et paramètres

Configurateur du Plugin de Mise à Jour

Voir le Github Readme pour plus d'informations.

Le 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 que le plugin natif doit 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 doit supprimer automatiquement les ensembles échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin doit supprimer automatiquement les ensembles 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 « à l'arrière-plan » ; false est le même que « éteint ». - éteint : Désactivez l'Auto Mise à jour - à l'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 à l'arrière-plan - à la mise en route : Appliquez immédiatement à la mise en route, sinon utilisez à l'arrière-plan après le contrôle de la mise en route - toujours : Appliquez immédiatement chaque fois que l'Auto Mise à jour s'exécute - uniquement télécharger : Vérifiez et téléchargez automatiquement, émettez updateAvailable et n'appliquez jamais le prochain ensemble automatiquement. Les modes d'application instantanée (« à l'installation », « à la mise en route », « toujours ») doivent être téléchargés avec —delta afin de ne pas 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	Supprime automatiquement les anciens bundles téléchargés lorsque l'une de nouvelles bundles d'applications natives est installée 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 bout live update 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 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. 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/écran de démarrage 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é ascendante. Disponible sur Android, iOS et Electron.	false	5.1.0
autoSplashscreen	boolean	Requis lors de l'utilisation des modes d'application instantanée ("atInstall", "onLaunch" ou "toujours"), y compris les valeurs de mise à jour directes obsolètes. @capacitor/écran de splash doit être installé et configuré avec launchAutoHide : false. Lorsqu'il est activé, le plugin masque l'écran de splash après les mises à jour sont appliquées ou lorsque aucune mise à jour n'est nécessaire. Cela supprime la nécessité de s'abonner manuellement aux é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 de mise à jour périodique. L'unité est en secondes. Disponible sur Android, iOS et Electron. Ne peut pas être inférieur à 600 secondes (10 minutes).	600 // (10 minutes)
localS3	boolean	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur 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. Cas sensible. Cette mise à jour supplantera le canal par défaut défini dans le cloud, mais respectera toujours les surdéfinitions effectuées dans le cloud.	undefined	5.5.0
appId	string	Configurez l'ID de l'application dans la configuration.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configurez le plugin pour conserver l'URL de chemin après un rechargement. Avertissement : Lorsqu'un rechargement est déclenché, ‘window.history’ sera effacé.	false	6.8.0
disableJSLogging	boolean	Désactivez l'affichage des logs JavaScript du plugin. Si vrai, le plugin ne loguera pas dans la console JavaScript. Seuls les logs natifs seront effectués	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
• Alias de type

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

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

Renvoie : Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Définir l'URL de mise à jour pour l'application, qui 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 valeur sera utilisée pour envoyer des statistiques. Passer une chaîne vide désactivera la collecte de statistiques.

Param	Paramètre	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, cette URL 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>

Telechargez un nouveau bundle à partir de l'URL fournie, il doit s'agir d'un fichier zip, avec des fichiers à l'intérieur ou avec un identifiant unique à l'intérieur avec tous vos fichiers

Paramètre	Type	Description
options	DownloadOptions	Les {@link} DownloadOptionstélécharger un nouveau zip de bundle.

next(…) Promise<BundleInfo>

---

next(…)

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

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

Paramètres	Type	Détails
options	BundleId	Contient l'ID du prochain Bundle à configurer lors du prochain lancement de l'application. BundleInfo.id}

BundleInfo.id Promise<BundleInfo>

---

Résultats :

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

Mettre à jour le bundle actuel et recharger l'application immédiatement.

Paramètres	Type	Description
options	BundleId	Un {@link IdDeBundle} objet contenant le nouveau identifiant de bundle à définir en tant que courant.

---

delete(…)

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

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

Param	Type	Description
options	BundleId	Un {@link BundleIdUn objet 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	La {@link
options	ListOptions	Le {@link} ListOptions} pour lister des ensembles

Retourne : Promise<BundleListResult>

---

reset(…)

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

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

Param	Paramètre	Type
options	ResetOptions	Contenant {@link} ResetOptions.àDernierSuccès}, true resets à la version intégrée du bundle et false se réinitialisera à la dernière bundle chargée avec succès.

---

current()

current() => Promise<CurrentBundleResult>

Récupérez le bundle actuel, si aucun n'est défini, il retourne builtinLe bundle natif actuel est l'installation d'origine sur le dispositif.

Retourne : Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recharger la vue

---

setMultiDelay(…)

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

Configure un tableau {@link} DelayCondition} array containing conditions that the Plugin will use to delay the update. After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app. For the date kind, la valeur doit être une chaîne de date ISO8601. background La valeur doit être un nombre en millisecondes. nativeVersion Le type doit être 'kind', la valeur doit être le numéro de version. kill kind, the value is not used. The function has inconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.

Param	Type	DelayCondition
options	MultiDelayConditions	Langue cible : Français Contenant l'array {@link}un tableau d'opérations à configurer

Since: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Copier dans le presse-papier DelayCondition} pour traiter une mise à jour immédiatement.

Since: 4.0.0

---

ConditionDeDélai

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 ce dispositif. Le canal doit avoir 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 le dispositif. Il ne crée ni met à jour aucun surcharge du dispositif sur le serveur, donc le dispositif ne sera pas affiché comme surchargé dans le tableau de bord Capgo. Seules les affectations créées à partir du tableau de bord ou du Public API sont affichées dans l'interface de surcharge du dispositif.

Notes importantes :

• N'utilisez pas cette méthode pour définir le canal au démarrage. Utilisez l' defaultChannel à la place dans votre Capacitor config.
• Cette méthode est destinée à être utilisée après que l'application est prête et que l'utilisateur a interagi (par exemple, en optant pour un programme bêta).
• Public channels cannot be self-assigned. Si un canal est marqué comme public, l'appel à setChannel() retournera une erreur. Pour utiliser un canal public, appelez unsetChannel() au lieu - le dispositif tombera automatiquement sur le canal public correspondant.
• Utilisez listChannels() pour découvrir les canaux disponibles et savoir si ils permettent l'affectation par l'utilisateur.

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

Renvoie : 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 des canaux s'applique : un enregistrement de la table de bord ou d'un appareil public API existant 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 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 (puisqu'il ne peut pas être affecté par lui-même via setChannel())

Paramètre	Type
options	UnsetChannelOptions

Depuis : 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Obtenir le canal pour cet appareil

Retourne : Promise<GetChannelRes>

Depuis : 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

context : Page/zone : Site de marketing Capgo. Rôle : Étiquette de l'interface utilisateur. Vu dans : page agents/[slug].astro. Clé de message `agents_page_copy_label` (Étiquette de copie de page Agents).

Chaque canal dans le résultat comprend :

• public: If trueSi canal par défautVous ne pouvez pas vous affecter à elle vous-même. setChannel(). Vous ne pouvez pas vous y assigner vous-même en utilisant : unsetChannel()Le dispositif recevra automatiquement les mises à jour de ce canal public.
• allow_self_set: Si true, c'est un un canal auto-attribuable. Vous pouvez attribuer explicitement le dispositif à ce canal à l'aide de setChannel().

Returns : Promise<ListChannelsResult>

Depuis : 7.5.0

---

setCustomId(…)

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

Définir un ID personnalisé pour cet appareil

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

Depuis : 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Get the native app version or the builtin version if set in config

Renvoie : Promise<BuiltinVersion>

Depuis : 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Renvoie : Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Obtenez la version native du plugin d'actualisation Capacitor (transmise au serveur d'actualisation automatique)

Renvoie : Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Get the state of auto update config.

Renvoie : Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Supprimer tous les écouteurs pour ce plugin.

Depuis : 1.0.0

---

addListener('download', …)

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

Écoutez l'événement de téléchargement de l'ensemble dans l'application. Déclenche une fois le téléchargement commencé, pendant le téléchargement et lorsque terminé. Cela vous renverra tous les pourcentages de téléchargement pendant le téléchargement

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

Retourne : Promise<PluginListenerHandle>

Depuis : 2.0.11

---

ajouterUnEcouteur(‘pasDeMiseAJour’, …)

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

Écoutez l'événement de mise à jour sans nécessité, utile lorsque vous souhaitez vérifier à chaque lancement de l'application.

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

ajouterUnEcouteur(‘miseÀJourDisponible’, …)

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

Écoutez l'événement de mise à jour disponible, utile lorsque vous souhaitez forcer une vérification à chaque lancement de l'application.

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

Type Promise<PluginListenerHandle>

Since: 4.0.0

---

ajouterUnEcouteurDeDownloadComplete(… )

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

ajouterUnEcouteur(‘téléchargementComplet’, …)

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

ajouter un écouteur('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ètres	Type
eventName	‘majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Retourne : Promise<PluginListenerHandle>

Depuis : 2.3.0

---

ajouterUnEcouteur(‘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	Paramètre
eventName	‘updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Type Promise<PluginListenerHandle>

Since: 2.3.0

---

ajouterUnEcouteurDeDownloadEchec(… )

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ètres	Type
eventName	‘downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Renvoie : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

ajouterUnEcouteur(‘appReloadé’, …)

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

Écoutez l'événement de rechargement dans l'Application, vous informez quand le rechargement est survenu.

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

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

Résultats : 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.

Résultats : 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 pour activer ou désactiver le menu de secousses

Depuis : 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtenez l'état actuel du menu de secousses

Retourne : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

---

Interfaces

RésultatPrêtDApp

Propriété	Type
bundle	BundleInfo

BundleInfo

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

URLDeMiseÀJour

Propriété	Type
url	string

StatsUrl

Prop	Type
url	string

ChannelUrl

Prop	Type
url	string

DownloadOptions

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.

Prop	Type	Description	Default	Depuis
url	string	The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you’ve hosted your bundle.)
version	string	La version code/nom de ce bundle/version
sessionKey	string	La clé de session pour la mise à jour, lorsque le bundle est chiffré avec une clé de session.	undefined	4.0.0
checksum	string	Le checksum pour la mise à jour, il doit être en sha256 et chiffré avec la clé privée si le bundle est chiffré.	undefined	4.0.0
manifest	ManifestEntry[]	Le manifeste pour les téléchargements Delta (manifeste) multi-fichier	undefined	6.1.0

ManifestEntry

Prop	Type
file_name	string | null
file_hash	string | null
download_url	string | null

__CAPGO_KEEP_0__

Propriété	Type
id	string

BundleListResult

Propriété	Type
bundles	BundleInfo[]

Propriété

Propriété	Type	Description	Défaut	Depuis
raw	boolean	Whether to return the raw bundle list or the manifest. If true, the list will attempt to read the internal database instead of files on disk.	false	6.14.0

ResetOptions

Prop	Type
toLastSuccessful	boolean

CurrentBundleResult

Prop	Type
bundle	BundleInfo
native	string

MultiConditionsDeRetard

Propriété	Type
delayConditions	DelayCondition[]

ConditionDeRetard

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

DernièreVersion

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	Default	Depuis
channel	string	Le canal pour obtenir la dernière version doit permettre '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 du canal	4.8.0
error	string
message	string
status	string
allowSet	boolean

Résultats 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'identifiant numérique du canal	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, lorsqu'un appareil supprime son canal personnalisé (en utilisant __CAPGO_KEEP_0__) 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 bêta, les tests A/B ou les trajectoires d'actualisation par opt-in.	7.5.0

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

SetCustomIdOptions

Propriété	Type
customId	string

__CAPGO_KEEP_0__

Propriété	Type
version	string

Id de l'appareil

Propriété	Type
deviceId	string

Version intégrée

Propriété	Type
version	string

__CAPGO_KEEP_0__

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	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 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 when an update failed to install.	4.0.0

DownloadFailedEvent

Propriété	Type	Description	Depuis
version	string	Emit when a download fails.	4.0.0

AppReadyEvent

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

ShakeMenuActivé

Propriété	Type
enabled	boolean

Type alias

État du bundle

en attente : Le bundle est en attente d'être SET en téléchargement : Le bundle est en cours de téléchargement. reussi : Le bundle a été téléchargé et est prêt à être METTRE Configurez-le comme le prochain bundle. Erreur : Le bundle a échoué à se télécharger.

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

DelayUntilNext

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

Continuez de la section Fonctions et paramètres

Si vous utilisez Fonctions et paramètres pour planifier votre tableau de bord et les opérations API, connectez-l’avec En utilisant @capgo/capacitor-metteur à jour pour la capacité native en En utilisant @capgo/capacitor-metteur à jour, 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.