Fonctions et paramètres

Configuration du plugin de mise à jour

Voir le Github Lire le fichier Readme pour plus d'informations.

CapacitorUpdater peut être configuré avec ces options :

Propriété	Type	Description	Défaut	Depuis
appReadyTimeout	number	Configurez le nombre de millisecondes que le plugin natif devrait attendre avant de considérer une mise à jour comme ‘échouée’. Disponible sur Android, iOS et Electron.	10000 // (10 seconds)
responseTimeout	number	Configurez le nombre de millisecondes que le plugin natif devrait attendre avant de considérer API temps d'attente. Disponible sur Android, iOS et Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configurez si le plugin devrait supprimer automatiquement les bundles échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin devrait supprimer automatiquement les anciens bundles après une mise à jour réussie. Disponible sur Android, iOS et Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Configurez comment le plugin devrait utiliser Mise à jour automatique via un serveur de mise à jour. true est le même que “en arrière-plan” ; false est le même que “désactivé”. - désactivé : Désactivez Mise à jour automatique - en arrière-plan : Vérifiez et téléchargez automatiquement, puis appliquez lorsque l'application passe en arrière-plan - à l'installation : Appliquez immédiatement uniquement après une installation fraîche ou une mise à jour d'application native, 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 Mise à jour automatique s'exécute - uniquementTéléchargement : Vérifiez et téléchargez automatiquement, émettez updateAvailable, et n'appliquez jamais automatiquement le prochain bundle. Disponible sur Android, iOS et Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Supprimer automatiquement les archives téléchargées précédentes lorsqu'une nouvelle archive native d'application est installée sur le dispositif. Disponible sur Android, iOS et Electron.	true
updateUrl	string	Configurer l'URL / point de terminaison vers lequel les vérifications de mise à jour sont envoyées. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configurer l'URL / point de terminaison pour les opérations de canal. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configurer l'URL / point de terminaison vers lequel les statistiques de mise à jour sont envoyées. Disponible sur Android, iOS et Electron. Définir sur "" pour désactiver la mise en rapport des statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurer la clé publique pour la cryptage en direct à la fin de la mise à jour. Version 2. Disponible sur Android, iOS et Electron.	undefined	6.2.0
version	string	Configurer la version actuelle de l'application. Cette version sera utilisée pour la première demande de mise à jour. Si elle n'est pas définie, le plugin récupérera la version de la 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 au lieu de cela : “à l'installation”, “à la mise en route” ou “toujours”. Cette option reste prise en charge pour les applications existantes. - false : Ne jamais faire de mises à jour directes - à l'installation : Même chose que autoUpdate : “à l'installation” - à la mise en route : Même chose que autoUpdate : “à la mise en route” - toujours : Même chose que autoUpdate : “toujours” - true : Même chose que “toujours” pour la compatibilité de l'arrière-plan. 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 les modes d'application instantanée. Lorsque l'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 s'abonner manuellement à l'événement appReady et d'appeler SplashScreen.hide(). Cela fonctionne uniquement lorsque autoUpdate est défini sur “atInstall”, “onLaunch” ou “toujours”. Les valeurs directUpdate Legacy sont toujours prises en charge pour la compatibilité ascendante. Exige que le plugin @capacitor/splash-screen soit installé et configuré avec launchAutoHide : false. Exige que la mise à jour automatique soit activée. Disponible sur Android et iOS.	false	7.6.0
periodCheckDelay	number	Configurez la période de retard pour la vérification des mises à jour périodiques. L'unité est en secondes. Disponible sur Android, iOS et Electron. Ne peut pas être inférieur à 600 secondes (10 minutes).	600 // (10 minutes)
localS3	boolean	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localHost	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localWebHost	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localSupa	string	Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localSupaAnon	string	Configurez le CLI pour utiliser un serveur local pour les tests.	undefined	4.17.48
localApi	string	Configurez le CLI pour utiliser un serveur local api pour les tests.	undefined	6.3.3
localApiFiles	string	Configurez le CLI pour utiliser un fichier local api pour les tests.	undefined	6.3.3
allowModifyUrl	boolean	Autorisez le plugin à modifier dynamiquement l'URL de mise à jour, l'URL de statistiques et l'URL de canal depuis le côté JavaScript.	false	5.4.0
defaultChannel	string	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 surcharges 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 la journalisation JavaScript du plugin. Si vrai, le plugin ne loguera pas dans la console JavaScript. Seule la journalisation native sera effectuée	false	7.3.0
shakeMenu	boolean	Activer le geste de secousses pour afficher le menu de mise à jour pour des fins de débogage/test	false	7.5.0

Exemples

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 d'alias

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifier l'Capacitor Metteur à jour que le bundle actuel fonctionne (un roulage sera effectué si cette méthode n'est pas appelée à chaque lancement de l'application) Par défaut, cette méthode doit être appelée dans les 10 premières secondes après le lancement de l'application, sinon un roulage se produira. 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, cette valeur sera utilisée pour vérifier les mises à jour.

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

Depuis : 5.4.0

---

setStatsUrl(…)

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

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

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

Depuis : 5.4.0

---

setChannelUrl(…)

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

Définir l'URL de canal pour l'application, cela sera utilisé pour définir le canal.

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

Depuis : 5.4.0

---

download(…)

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

Téléchargez un nouveau bundle à partir de l'URL fournie, il doit s'agir d'un fichier zip, avec des fichiers à l'intérieur ou avec un identifiant unique à l'intérieur 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>

---

Section intitulée « next(…) »

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

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

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

Renvoie : Promise<BundleInfo>

---

set(…)

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

Définir 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 objet {@link} contenant l'ID d'un ensemble à supprimer (notez que c'est l'ID de l'ensemble, PAS le nom de la version) BundleIdObtenir tous les ensembles téléchargés localement dans votre application

---

list(…)

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

Paramètre

Type	La {@link}	Copier dans le presse-papiers
options	ListOptions	Obtenir tous les ensembles téléchargés localement dans votre application Liste d'options} pour lister les bundles

Retourne : Promise<BundleListResult>

---

reset(…)

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

Réinitialiser l'application sur le builtin bundle (le bundle envoyé à l'App Store 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>

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

Retourne: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Rafraîchir la vue

---

__CAPGO_KEEP_0__

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

Définit 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, de sorte que 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. Cette fonction présente un comportement incohérent : 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'{@link MultiDelayConditions} tableau d'conditions pour définir

Depuis : 4.3.0

---

annulerDelay()

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>

Configure le canal local géré par le plugin pour cet appareil. Le canal doit être allow_device_self_set activé pour que cela fonctionne.

setChannel() vérifie le canal avec le serveur, puis stocke le canal sélectionné localement sur l'appareil. Il ne crée ni met à jour aucun survolage de l'appareil sur le serveur, donc l'appareil ne sera pas affiché comme survolé dans le tableau de bord Capgo. Seuls les affectations créées à partir du tableau de bord ou de l'API Public sont affichés dans l'interface de survolage de l'appareil.

Notes importantes :

• Ne utilisez pas cette méthode pour configurer le canal au démarrage. Utilisez l' defaultChannel en votre Capacitor config au lieu de cela.
• Cette méthode est destinée à être utilisée après que l'application soit prête et que l'utilisateur ait interagi (par exemple, en optant pour un programme bêta).
• Les canaux publics ne peuvent pas être affectés par l'utilisateur. Si un canal est marqué comme public, l'appel à setChannel() retournera une erreur. Pour utiliser un canal public, appelez unsetChannel() au lieu de cela - l'appareil tombera automatiquement sur le canal public correspondant.
• Utilisez-le pour découvrir quels canaux sont disponibles et s'ils permettent l'auto-assignation. listChannels() Paramètre

Type	Description	Est-ce le canal {@link
options	SetChannelOptions	SetChannelOptions } à définirRetourne :

Depuis : Promise<ChannelRes>

unsetChannel(…) 4.7.0

---

Section intitulée “unsetChannel(…)

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

Désactiver le canal local géré par le plugin pour cet appareil. Cette action supprime uniquement le canal stocké localement par setChannel(); it does not delete Dashboard or Public API Device Override records.

After calling this method, normal channel precedence applies: an existing Dashboard or Public API Device Override still wins; otherwise the device can fall back to the matching public/default channel for its conditions (platform, device type, build type).

Cela est utile dans les cas suivants :

• 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 par l'utilisateur 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>

Lister 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>

Définir un ID personnalisé pour cet appareil

Paramètre	Type	Description
options	SetCustomIdOptions	est le {@link __CAPGO_KEEP_0__Depuis :

getBuiltinVersion() 4.9.0

---

Section intitulée “getBuiltinVersion()”

getBuiltinVersion() => Promise<BuiltinVersion>

getBuiltinVersion()

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>

---

isAutoUpdateEnabled()

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

---

ajoutez un écouteur (‘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 le téléchargement commencé, pendant le téléchargement et lorsque terminé. Cela vous retournera tous les pourcentages de téléchargement pendant le téléchargement

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

Retourne: Promise<PluginListenerHandle>

Depuis: 2.0.11

---

Ajoutez un écouteur pour l'événement ‘noNeedUpdate’

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

Écoutez l'événement ‘no need to update’, utile lorsque vous souhaitez forcer une mise à jour chaque fois que l'application est lancée

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

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

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

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

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

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

ajouter un écouteur (‘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

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.3.0

---

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

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

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

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

Retourne : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

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

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

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

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

Obtenir 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

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

Url de mise à jour

Propriété	Type
url	string

Url de statistiques

Propriété	Type
url	string

Url de canal

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 tant que 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 hachage 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

Manifeste d'entrée

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

Id de la mise en bundle

Propriété	Type
id	string

Résultat de la liste de mise en bundle

Propriété	Type
bundles	BundleInfo[]

Options de la liste

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

Réinitialiser les options

Propriété	Type
toLastSuccessful	boolean

Résultat du bundle actuel

Propriété	Type
bundle	BundleInfo
native	string

ConditionsDeRétardMultipliées

Propriété	Type
delayConditions	DelayCondition[]

ConditionDeRétard

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

Annuler 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 personnalisé (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(). C'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 name, pas ce numéro id.

Définir les options de l'ID personnalisé

Propriété	Type
customId	string

Version intégrée

Propriété	Type
version	string

Identifiant de l'appareil

Type	Version du plugin
deviceId	string

protectedTokens

Propriété	Type
version	string

Mise à jour automatique activée

Propriété	Type
enabled	boolean

Gestionnaire de l'écouteur de plugin

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

Événement de téléchargement

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

NoNeedEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

Propriété	Type	Description	Depuis
bundle	BundleInfo	Emit lorsque de nouvelles mises à jour sont disponibles.	4.0.0

MajorAvailableEvent

Propriété	Type	Description	Depuis
version	string	Emit lorsque de nouvelles versions majeures sont disponibles.	4.0.0

UpdateFailedEvent

Propriété	Type	Description	Depuis
bundle	BundleInfo	Émettre lors d'une mise à jour impossible à installer.	4.0.0

DownloadFailedEvent

Propriété	Type	Description	Depuis
version	string	Émettre lors d'un téléchargement impossible.	4.0.0

AppReadyEvent

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

Mise à jour automatique disponible

Propriété	Type
available	boolean

Définir les options du menu de secousse

Propriété	Type
enabled	boolean

ShakeMenuEnabled

Propriété	Type
enabled	boolean

Type de synonymes

État de l'archive

en attente : L'archive est en attente de traitement METTRE EN PLACE comme le prochain bundle. en téléchargement : Le bundle est en cours de téléchargement. succès : Le bundle a été téléchargé et est prêt à être

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

METTRE EN PLACE

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

erreur : Le bundle a échoué à se télécharger.

Section intitulée “Attente de la prochaine étape” Continuez depuis les fonctions et les paramètres to plan dashboard and API operations, connect it with Si vous utilisez les fonctions et les paramètres pour planifier votre tableau de bord et les opérations capgo , connectez-le avec : « @capgo/capacitor-mises à jour » pour la capacité native en utilisant @capgo/capacitor-mises à 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.