Fonctions et paramètres

Configuration du plugin de mise à jour

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

CapacitorUpdater peut être configuré avec ces options :

Propriété	Type	Description	Configure la valeur par 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 paquets échoués. Disponible sur Android, iOS et Electron.	true
autoDeletePrevious	boolean	Configurez si le plugin devrait supprimer automatiquement les paquets précédents après une mise à jour réussie. Disponible sur Android, iOS et Electron.	true
autoUpdate	boolean	Configurez si le plugin devrait utiliser l'auto-mise à jour via un serveur de mise à jour. Disponible sur Android, iOS et Electron.	true
resetWhenUpdate	boolean	Supprimer automatiquement les paquets téléchargés précédents lorsque l'on installe une nouvelle version du bundle d'application native sur le dispositif. Disponible sur Android, iOS et Electron.	true
updateUrl	string	Configurez l'URL / point de terminaison vers lequel les vérifications de mise à jour sont envoyées. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configurez l'URL / point de terminaison pour les opérations de canal. Disponible sur Android, iOS et Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configurez l'URL / point de terminaison vers lequel les statistiques de mise à jour sont envoyées. Disponible sur Android, iOS et Electron. Définir sur "" pour désactiver la mise à jour des statistiques.	https://plugin.capgo.app/stats
publicKey	string	Configurez la clé publique pour la mise à jour en direct chiffrée de bout en bout, version 2. Disponible sur Android, iOS et Electron.	undefined	6.2.0
version	string	Configurez la version actuelle de l'application. Cette version sera utilisée pour la première demande de mise à jour. Si elle n'est pas définie, le plugin récupérera la version à partir du native code. Disponible sur Android, iOS et Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Configurez quand le plugin devrait installer directement les mises à jour. Seulement pour le mode autoUpdate. Fonctionne bien pour les applications inférieures à 10MB et avec des téléchargements effectués à l'aide de la —delta flag. Les fichiers zip ou les applications supérieures à 10MB seront relativement lents pour les utilisateurs à mettre à jour. - false : Jamais faire des mises à jour directes (utilisez le comportement par défaut : télécharger au démarrage, définir lorsque l'application est en arrière-plan) - atInstall : Mettre à jour directement uniquement lorsque l'application est installée, mise à jour depuis l'app store, sinon agissez comme si directUpdate était false - onLaunch : Mettre à jour directement uniquement lorsque l'application est installée, mise à jour depuis l'app store ou après avoir tué l'application, sinon agissez comme si directUpdate était false - toujours : Mettre à jour directement dans les cas précédents (application installée, mise à jour depuis l'app store, après avoir tué l'application ou l'application redémarrée), jamais agir comme si directUpdate était false - true : (déprécié) Même chose que “toujours” pour la compatibilité backward. Disponible sur Android, iOS et Electron.	false	5.1.0
autoSplashscreen	boolean	Gérer automatiquement la suppression de l'écran de splash lorsque vous utilisez directUpdate. Lorsque cette option est activée, le plugin supprimera automatiquement l'écran de splash après les mises à jour ou lorsque aucune mise à jour n'est nécessaire. Cela supprime la nécessité de s'abonner manuellement aux événements appReady et d'appeler SplashScreen.hide(). Cela fonctionne uniquement lorsque directUpdate est défini sur “atInstall”, “always” ou true. Exige que le plugin @capacitor/splash-screen soit installé et configuré avec launchAutoHide : false. Exige que autoUpdate et directUpdate soient activés. Disponible sur Android et iOS.	false	7.6.0
periodCheckDelay	number	Configurer 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	Configurer CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localHost	string	Configurer CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localWebHost	string	Configurer CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	undefined	4.17.48
localSupa	string	Configurer CLI pour utiliser un serveur local pour les tests.	undefined	4.17.48
localSupaAnon	string	Configurer CLI pour utiliser un serveur local __CAPGO_KEEP_1__ pour les tests.	undefined	4.17.48
localApi	string	Configurer CLI pour utiliser un fichier local api pour les tests.	undefined	6.3.3
localApiFiles	string	Configure the CLI to use a local file api for testing.	undefined	6.3.3
allowModifyUrl	boolean	Définir le canal par défaut pour l'application dans la configuration. Sensible à la casse. Cette mise à jour supplantera le canal par défaut défini dans le cloud, mais respectera toujours les mises à jour effectuées dans le cloud.	false	5.4.0
defaultChannel	string	Configurer __CAPGO_KEEP_0__ pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.	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ésactiver 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": false,
      "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: false,
      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>

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

Renvoie : Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Définissez 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 URL sera utilisée pour envoyer des statistiques. Passer une chaîne vide désactivera la collecte de statistiques.

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

Depuis : 5.4.0

---

setChannelUrl(…)

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

Fixez l'URL du canal pour l'application, elle sera utilisée 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 DownloadOptions} pour télécharger un nouveau bundle zip.

Renvoie : Promise<BundleInfo>

---

next(…)

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

Définir le prochain bundle à 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}

Retourne : Promise<BundleInfo>

---

set(…)

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

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

Paramètre	Type	Description
options	BundleId	Un objet {@link} contenant l'ID de bundle nouveau à définir en tant que courant. __CAPGO_KEEP_0__Paramètres

---

Type

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

Section intitulée « Supprimer (…) »

Copier dans le presse-papier	Supprime l'ID de bundle spécifié du stockage de l'application native. Utilisez {@link list} pour obtenir les ID de bundle stockés.	Paramètre
options	BundleId	Un objet {@link BundleId} contenant l'ID d'un ensemble à supprimer (notez que c'est l'ID de l'ensemble, ET PAS le nom de la version) __CAPGO_KEEP_0__list(…)

---

Section intitulée “list(…)

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

Paramètre

Type	Description	Un objet {@link ListOptions}
options	ListOptions	Copier dans le presse-papier Obtenir tous les ensembles téléchargés localement dans votre application} pour lister les bundles

Retourne : Promise<BundleListResult>

---

reset(…)

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

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

Paramètre	Type	Description
options	ResetOptions	Contenant {@link Options de réinitialisation à l'état dernierement chargé}, true se réinitialise sur le bundle intégré et false se réinitialisera sur le dernier bundle chargé avec succès.

---

current()

current() => Promise<CurrentBundleResult>

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

Retourne : Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recharge la vue

---

setMultiDelay(…)

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

Configurez un tableau {@link DelayCondition} contenant les 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 redémarrage en arrière-plan ou la fermeture de l'application. Pour le « kind », la valeur doit être une chaîne de date ISO 8601. Pour le « kind », la valeur doit être un nombre en millisecondes. Pour le « kind », la valeur doit être le numéro de version. Pour le « 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 le premier redémarrage et pas après le prochain redémarrage en arrière-plan comme les autres options. Cela sera corrigé dans une prochaine version majeure. ParamètreType date Copy to clipboard background Param nativeVersion Type kill setMultiDelay(…)

Section titled “setMultiDelay(…)	DelayCondition	Description
options	MultiDelayConditions	Contenant l'array {@link MultiDelayConditions} de conditions à définir

Depuis : 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Depuis : 4.0.0

---

getLatest(…)

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

Obtenir le bundle le plus récent disponible à partir de l'URL de mise à jour

Paramètre	Type
options	GetLatestOptions

Renvoie : Promise<LatestVersion>

Depuis : 4.0.0

---

setChannel(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Définit le canal pour cet appareil. Le canal doit exister allow_device_self_set n'est pas activé pour que cela fonctionne.

Remarques importantes :

• N'utilisez pas cette méthode pour définir le canal au démarrage. Utilisez l' defaultChannel ceci dans votre Capacitor de configuration 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 attribués par soi-même. Si un canal est marqué comme public, l'appel à setChannel() retournera une erreur. Pour utiliser un canal public, appelez unsetChannel() au lieu de cela - le dispositif tombera automatiquement sur le canal public correspondant.
• Utilisez listChannels() pour découvrir quels canaux sont disponibles et s'ils permettent l'attribution par soi-même.

Paramètre	Type	Description
options	SetChannelOptions	Est-ce que le {@link lien vers SetChannelOptions} canal à définir

Retourne : Promise<ChannelRes>

Depuis : 4.7.0

---

unsetChannel(…)

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

Annulez la mise en surbrayage du canal pour cet appareil. Après l'appel de cette méthode, l'appareil recevra automatiquement des mises à jour à partir de canal public qui correspond à ses conditions (plateforme, type d'appareil, type de build).

Cela est utile lorsque :

• Vous souhaitez remettre un appareil sur la piste d'actualisation par défaut
• Vous souhaitez utiliser un canal public (puisquels canaux publics ne peuvent pas être attribués automatiquement via setChannel())

Paramètre	Type
options	UnsetChannelOptions

Depuis : 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Obtenir le canal pour cet appareil

Returns: Promise<GetChannelRes>

Depuis : 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Chaque canal dans le résultat comprend :

• publicSi true, c'est un canal par défaut.Vous ne pouvez pas vous y assigner vous-même à l'aide setChannel(). Au lieu de cela, si vous supprimez votre affectation de canal à l'aide unsetChannel(), le dispositif recevra automatiquement les mises à jour de ce canal public.
• allow_self_set: Si true, c'est 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 une ID personnalisée pour ce dispositif

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

getBuiltinVersion() 4.9.0

---

Section intitulée “getBuiltinVersion()”

getBuiltinVersion() => Promise<BuiltinVersion>

Retourne :

Depuis : Promise<BuiltinVersion>

Section titled “getBuiltinVersion()” 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>

Récupère la version native Capacitor de l'extension de mise à jour native (envoyée au serveur d'auto-mise à jour)

Retourne : Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Récupérer l'état de la configuration d'actualisation automatique.

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>

Écouter 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ètre	Type
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.0.11

---

addListener('noNeedUpdate', …)

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

Écouter l'événement 'no need to update', utile lorsque vous souhaitez forcer la vérification chaque fois que l'application est lancée

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

ajouter un écouteur d'actualisation (‘updateAvailable’, …)

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

Écouter l'événement d'actualisation 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

---

ajouter un écouteur de téléchargement complet (‘downloadComplete’, …)

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 2.3.0

---

ajouter un écouteur d'événement 'mise à jour échouée', …

addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

Écouter l'événement de mise à jour échouée dans l'application, vous informe quand une 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

---

ajouter un écouteur d'événement 'téléchargement échoué', …

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

Écouter l'événement de téléchargement échoué dans l'application, vous informe quand un téléchargement de bundle a échoué

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

Renvoi : Promise<PluginListenerHandle>

Depuis : 4.0.0

---

addListener('appReloaded', …)

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

Écoutez l'événement de rechargement de l'application, vous informez quand le rechargement a eu lieu

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

Renvoi : Promise<PluginListenerHandle>

Depuis : 4.3.0

---

ajouter un écouteur (‘appReady’, …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

Écouter l'événement d'appareil prêt dans l'application, vous informe quand l'application est prête à l'utilisation

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

Renvoie : Promise<PluginListenerHandle>

Depuis : 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

Renvoie : Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Récupère le prochain bundle qui sera utilisé lors du redémarrage 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 secousse 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>

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

Retourne : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

---

Interfaces

Résultat de l'application prête

Propriété	Type
bundle	BundleInfo

Informations de l'ensemble

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

URL de mise à jour

Propriété	Type
url	string

StatsUrl

Propriété	Type
url	string

ChannelUrl

Propriété	Type
url	string

Options de téléchargement

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. Checksum and sessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

Type	Type	Description	Défaut	Depuis
url	string	L'URL du fichier zip du bundle (par exemple : dist.zip) à télécharger. (Cela peut être n'importe quelle URL. Par exemple : Amazon S3, un GitHub tag, tout autre endroit où vous avez hébergé votre bundle.)
version	string	La version code/nom de ce bundle/version
sessionKey	string	La clé de session pour la mise à jour, lorsque le bundle est chiffré avec une clé de session	undefined	4.0.0
checksum	string	Le checksum pour la mise à jour, il devrait être en sha256 et chiffré avec une clé privée si le bundle est chiffré	undefined	4.0.0
manifest	ManifestEntry[]	Le manifeste pour Delta (manifeste) téléchargements multi-fichier	undefined	6.1.0

ManifestEntry

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

BundleId

Propriété	Type
id	string

Résultat de la liste des bundles

Propriété	Type
bundles	BundleInfo[]

Options de la liste

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

Réinitialiser les options

Propriété	Type
toLastSuccessful	boolean

Résultat du bundle actuel

Propriété	Type
bundle	BundleInfo
native	string

Conditions de retard multiples

Propriété	Type
delayConditions	DelayCondition[]

Condition de retard

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

Dernière version disponible

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

SetChannelOptions

Propriété	Type
channel	string
triggerAutoUpdate	boolean

Options de canal non définies

Propriété	Type
triggerAutoUpdate	boolean

Obtenir les résultats du canal

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

Informations sur le canal

Propriété	Type	Description	Depuis
id	string	L'ID du canal	7.5.0
name	string	Le nom du canal	7.5.0
public	boolean	Si vrai, il s'agit d'un canal par défaut ou de substitution. Les appareils ne peuvent pas se désigner eux-mêmes à des canaux publics. Au lieu de cela, lorsque l'appareil supprime son canal de substitution (en utilisant unsetChannel()), il recevra automatiquement les mises à jour du canal public correspondant.	7.5.0
allow_self_set	boolean	Si vrai, les appareils peuvent se désigner explicitement à ce canal en utilisant setChannel(). Cela est généralement utilisé pour les tests de version bêta, les tests A/B ou les trajectoires d'actualisation par option.	7.5.0

Options de définition de l'ID personnalisé

Propriété	Type
customId	string

Version Builtin

Propriété	Type
version	string

Id de l'appareil

Propriété	Type
deviceId	string

Version du plugin

Propriété	Type
version	string

Mise à jour automatique activée

Propriété	Type
enabled	boolean

Gestionnaire d'écouteur de plugin

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

Événement de téléchargement

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

NoNeedEvent

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

UpdateAvailableEvent

Propriété	Type	Description	Depuis
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

Événement de téléchargement complet

Propriété	Type	Description	Depuis
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

Événement de mise à jour majeure disponible

Propriété	Type	Description	Depuis
version	string	Émettre lorsqu'un nouveau bundle majeur est disponible.	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

Mise à jour automatique disponible

Propriété	Type
available	boolean

Définir les options du menu de secousses

Propriété	Type
enabled	boolean

Menu de secousses activé

Propriété	Type
enabled	boolean

Type d'alias

État de la mise en boîte

en attente : La mise en boîte est en attente de téléchargement. SET comme la prochaine mise en boîte. téléchargement en cours : La mise en boîte est en cours de téléchargement. SET comme la prochaine mise en boîte. erreur : La mise en boîte a échoué à se télécharger.

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

Retarder jusqu'à la prochaine

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