Fonctions et paramètres

Configuration du plugin de mise à jour

Consultez le Readme de Github pour plus d’informations.

CapacitorUpdater peut être configuré avec ces options :| Accessoire | Tapez | Descriptif | Par défaut | Depuis | | ---------------------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ------- | | appReadyTimeout | numéro | 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 secondes) | | | responseTimeout | numéro | Configurez le nombre de millisecondes que le plugin natif doit attendre avant de prendre en compte le délai d’attente API. Disponible sur Android, iOS et Electron. | 20000 // (20 secondes) | | | autoDeleteFailed | booléen | Configurez si le plugin doit utiliser la suppression automatique des bundles ayant échoué. Disponible sur Android, iOS et Electron. | true | | | autoDeletePrevious | booléen | Configurez si le plugin doit utiliser la suppression automatique des bundles précédents après une mise à jour réussie. Disponible sur Android, iOS et Electron. | true | | | autoUpdate | booléen | Configurez si le plugin doit utiliser la mise à jour automatique via un serveur de mise à jour. Disponible sur Android, iOS et Electron. | true | | | resetWhenUpdate | booléen | Supprimez automatiquement les bundles téléchargés précédents lorsqu’un bundle d’applications natives plus récent est installé sur l’appareil. Disponible sur Android, iOS et Electron. | true | | | updateUrl | string | Configurez l’URL/le point de terminaison auquel 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/le 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/le point de terminaison auquel les statistiques de mise à jour sont envoyées. Disponible sur Android, iOS et Electron. Réglez sur "" pour désactiver les rapports de statistiques. | https://plugin.capgo.app/stats | | | publicKey | string | Configure the public key for end to end live update encryption Version 2. Available on Android, iOS, and Electron. | undefined | 6.2.0 | | version | string | Configurez la version actuelle de l’application. Celui-ci sera utilisé pour la première demande de mise à jour. If not set, the plugin will get the version from the native code. Disponible sur Android, iOS et Electron.| undefined | 4.17.48 | | directUpdate | booléen | ‘toujours’ | ‘atInstall’ | ‘au lancement’ | Configurez quand le plugin doit diriger l’installation des mises à jour. Uniquement pour le mode autoUpdate. Fonctionne bien pour les applications de moins de 10 Mo et avec les téléchargements effectués à l’aide de l’indicateur —delta. Les fichiers Zip ou les applications de plus de 10 Mo seront relativement lents à mettre à jour pour les utilisateurs. - false : ne jamais effectuer de mises à jour directes (utiliser le comportement par défaut : télécharger au démarrage, défini en arrière-plan) - atInstall : mise à jour directe uniquement lorsque l’application est installée, mise à jour depuis le magasin, sinon agir comme directUpdate = false - onLaunch : mise à jour directe uniquement sur l’application installée, mise à jour depuis le magasin ou après la suppression de l’application, sinon agir comme directUpdate = false - toujours : mise à jour directe dans tous les cas précédents (application installée, mise à jour depuis le magasin, après la suppression ou la reprise de l’application), ne jamais agir comme directUpdate = false - true : (obsolète) Idem comme “toujours” pour une compatibilité descendante. Disponible sur Android, iOS et Electron. | false | 5.1.0 | | autoSplashscreen | booléen | Gérez automatiquement le masquage de l’écran de démarrage lors de l’utilisation de directUpdate. Lorsqu’il est activé, le plugin masquera automatiquement l’écran de démarrage une fois les mises à jour appliquées ou lorsqu’aucune mise à jour n’est nécessaire. Cela supprime le besoin d’écouter manuellement les événements appReady et d’appeler SplashScreen.hide(). Fonctionne uniquement lorsque directUpdate est défini sur “atInstall”, “always” ou true. Nécessite que le plugin @capacitor/splash-screen soit installé et configuré avec launchAutoHide : false. Nécessite l’activation d’autoUpdate et de directUpdate. Disponible sur Android et iOS. | false | 7.6.0 | | periodCheckDelay | numéro | Configurez le délai pour la vérification de la mise à jour de la période. 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 | booléen | 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.| non défini | 4.17.48 | | localApi | string | Configurez le CLI pour utiliser une API locale pour les tests. | undefined | 6.3.3 | | localApiFiles | string | Configurez le CLI pour utiliser une API de fichier local pour les tests. | undefined | 6.3.3 | | allowModifyUrl | booléen | Autorisez le plugin à modifier dynamiquement updateUrl, statsUrl et channelUrl du côté JavaScript. | false | 5.4.0 | | defaultChannel | string | Définissez le canal par défaut pour l’application dans la configuration. Sensible aux majuscules et minuscules. Ce paramètre remplacera le canal par défaut défini dans le cloud, mais respectera toujours les remplacements effectués dans le cloud. | undéfini | 5.5.0 | | appId | string | Configurez l’ID de l’application pour l’application dans la configuration. | undefined | 6.0.0 | | keepUrlPathAfterReload | booléen | Configurez le plugin pour conserver le chemin de l’URL après un rechargement. AVERTISSEMENT : lorsqu’un rechargement est déclenché, ‘window.history’ sera effacé. | false | 6.8.0 | | disableJSLogging | booléen | Désactivez la journalisation JavaScript du plugin. si c’est vrai, le plugin ne se connectera pas à la console JavaScript. seul le log natif sera réalisé | false | 7.3.0 | | shakeMenu | booléen | Activer le geste de secousse pour afficher le menu de mise à jour à 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
Type d’alias

Méthodes

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Informez Capacitor Updater que le bundle actuel fonctionne (une restauration se produira 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 une restauration se produira. Modifiez ce comportement avec {@link appReadyTimeout}

Retours : Promise<AppReadyResult>

setUpdateUrl(…)

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

Définissez la updateUrl pour l’application, elle sera utilisée pour vérifier les mises à jour.

Paramètres	Tapez	Descriptif
`options`	`UpdateUrl`	contient l’URL à utiliser pour vérifier les mises à jour.

Depuis : 5.4.0

setStatsUrl(…)

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

Définissez la statsUrl pour l’application, elle sera utilisée pour envoyer des statistiques. Passer une chaîne vide désactivera la collecte de statistiques.| Paramètres | Tapez | Descriptif | | ------------- | --------------------------------------------- | ----------------------------------------------- | | options | StatsUrl | contient l’URL à utiliser pour l’envoi des statistiques. |

Depuis : 5.4.0

setChannelUrl(…)

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

Définissez le ChannelUrl pour l’application, celui-ci sera utilisé pour définir le canal.

Paramètres	Tapez	Descriptif
`options`	`ChannelUrl`	contient l’URL à utiliser pour définir la chaîne.

Depuis : 5.4.0

téléchargement(…)

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ètres	Tapez	Descriptif
`options`	`Options de téléchargement`	Le {@link DownloadOptions} pour télécharger un nouveau zip de bundle.

Retours : Promesse<BundleInfo>

suivant(…)

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

Définissez le prochain bundle à utiliser lorsque l’application est rechargée.

Paramètres	Tapez	Descriptif
`options`	`BundleId`	Contient l’ID du prochain Bundle à définir lors du prochain lancement de l’application. {@link BundleInfo.id}

Retours : Promesse<BundleInfo>

ensemble(…)

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

Définissez le bundle actuel et rechargez immédiatement l’application.| Paramètres | Tapez | Descriptif | | ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------- | | options | BundleId | Un objet {@link BundleId} contenant le nouvel identifiant de bundle à définir comme actuel. |

supprimer(…)

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

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

Paramètres	Tapez	Descriptif
`options`	`BundleId`	Un objet {@link BundleId} contenant l’ID d’un bundle à supprimer (notez qu’il s’agit de l’ID du bundle, PAS du nom de la version)

liste(…)

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

Obtenez tous les bundles téléchargés localement dans votre application

Paramètres	Tapez	Descriptif
`options`	`ListOptions`	Le {@link ListOptions} pour répertorier les offres groupées

Retours : Promise<BundleListResult>

réinitialiser (…)

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

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

Paramètres	Tapez	Descriptif
`options`	`ResetOptions`	Contenant {@link ResetOptions.toLastSuccessful}, `true` se réinitialise au bundle intégré et `false` sera réinitialisé au dernier bundle chargé avec succès.

actuel()

current() => Promise<CurrentBundleResult>
```Obtenez le bundle actuel, si aucun n'est défini, il renvoie `builtin`. currentNative est le bundle d'origine installé sur l'appareil

**Retours :** <code>Promise<<a href="#currentbundleresult">CurrentBundleResult</a>></code>

--------------------


## recharger()

```typescript
reload() => Promise<void>

Recharger la vue

setMultiDelay(…)

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

Définit un tableau {@link DelayCondition} contenant les conditions que le plugin utilisera pour retarder la mise à jour. Une fois que toutes les conditions sont remplies, le processus de mise à jour redémarrera comme d’habitude, la mise à jour sera donc installée après une mise en arrière-plan ou la suppression de l’application. Pour le type date, la valeur doit être une chaîne de date iso8601. Pour le genre background, la valeur doit être un nombre en millisecondes. Pour le genre nativeVersion, la valeur doit être le numéro de version. Pour le genre kill, la valeur n’est pas utilisée. La fonction a un comportement incohérent, l’option kill déclenche la mise à jour après le premier kill et non après le prochain arrière-plan comme les autres options. Ce problème sera corrigé dans une prochaine version majeure.

Paramètres	Tapez	Descriptif
`options`	`MultiDelayConditions`	Contenant le tableau {@link MultiDelayConditions} de conditions à définir

Depuis : 4.3.0

##cancelDelay()

cancelDelay() => Promise<void>

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

Depuis : 4.0.0

getLatest(…)

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

Obtenez le dernier bundle disponible à partir de l’URL de mise à jour

Paramètres	Tapez
`options`	`GetLatestOptions`

Retours : Promesse<LatestVersion>

Depuis : 4.0.0

setChannel(…)

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

Définit le canal pour cet appareil. Le canal doit avoir allow_device_self_set activé pour que cela fonctionne.Remarques importantes :

N’utilisez pas cette méthode pour définir le canal au démarrage. Utilisez plutôt le defaultChannel dans votre configuration Capacitor.
Cette méthode est destinée à être utilisée une fois que l’application est prête et que l’utilisateur a interagi (par exemple, en optant pour un programme bêta).
Les chaînes publiques ne peuvent pas être auto-attribuées. Si une chaîne est marquée comme public, l’appel de setChannel() renverra une erreur. Pour utiliser une chaîne publique, appelez plutôt unsetChannel() - l’appareil reviendra automatiquement sur la chaîne publique correspondante.
Utilisez listChannels() pour découvrir quels canaux sont disponibles et s’ils permettent l’auto-attribution.

Paramètres	Tapez	Descriptif
`options`	`SetChannelOptions`	Le canal {@link SetChannelOptions} est-il à définir

Retours : Promise<ChannelRes>

Depuis : 4.7.0

unsetChannel(…)

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

Annulez la priorité du canal pour cet appareil. Après avoir appelé cette méthode, l’appareil recevra automatiquement les mises à jour du canal public qui correspondent à ses conditions (plate-forme, type d’appareil, type de build).

Ceci est utile lorsque :

Vous souhaitez remettre un appareil sur la piste de mise à jour par défaut
Vous souhaitez utiliser une chaîne publique (puisque les chaînes publiques ne peuvent pas être auto-attribuées via setChannel())

Paramètres	Tapez
`options`	`UnsetChannelOptions`

Depuis : 4.7.0

##getChannel()

getChannel() => Promise<GetChannelRes>

Obtenez la chaîne pour cet appareil

Retours : Promise<GetChannelRes>

Depuis : 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

Répertoriez toutes les chaînes disponibles pour cet appareil. Renvoie les canaux compatibles avec l’environnement actuel de l’appareil (plate-forme, émulateur/appareil réel, version dev/prod) et qui sont soit publics, soit autorisant l’auto-affectation.

Chaque canal du résultat comprend :

public : Si true, il s’agit d’un canal par défaut. Vous ne pouvez pas vous y attribuer vous-même en utilisant setChannel(). Au lieu de cela, si vous supprimez votre attribution de canal à l’aide de unsetChannel(), l’appareil recevra automatiquement les mises à jour de ce canal public.
allow_self_set : Si true, il s’agit d’un canal auto-attribuable. Vous pouvez attribuer explicitement l’appareil à ce canal en utilisant setChannel().

Retours : Promise<ListChannelsResult>

Depuis : 7.5.0

setCustomId(…)

setCustomId(options: SetCustomIdOptions) => Promise<void>
```Définir un identifiant personnalisé pour cet appareil

| Paramètres | Tapez | Descriptif |
| ------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| **`options`** | <code><a href="#setcustomidoptions">SetCustomIdOptions</a></code> | est le {@link <a href="#setcustomidoptions">SetCustomIdOptions</a>} customId à définir |

**Depuis :** 4.9.0

--------------------


##getBuiltinVersion()

```typescript
getBuiltinVersion() => Promise<BuiltinVersion>

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

Retours : Promesse<BuiltinVersion>

Depuis : 5.2.0

##getDeviceId()

getDeviceId() => Promise<DeviceId>

Obtenez un identifiant unique utilisé pour identifier l’appareil (envoyé au serveur de mise à jour automatique)

Retours : Promesse<DeviceId>

##getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Obtenez la version native du plugin Capacitor Updater (envoyée au serveur de mise à jour automatique)

Retours : Promesse<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

Retours : Promise<AutoUpdateEnabled>

RemoveAllListeners()

removeAllListeners() => Promise<void>

Supprimez tous les écouteurs de ce plugin.

Depuis : 1.0.0

addListener(‘télécharger’, …)

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

Écoutez l’événement de téléchargement du bundle dans l’application. Se déclenche une fois qu’un téléchargement a commencé, pendant le téléchargement et une fois terminé. Cela vous renverra tous les pourcentages de téléchargement pendant le téléchargement

Paramètres	Tapez
`eventName`	`’télécharger’`
`listenerFunc`	`(état : DownloadEvent) => void`

Renvois : Promise<PluginListenerHandle>

Depuis : 2.0.11

addListener(‘noNeedUpdate’, …)

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

Écoutez l’événement sans qu’il soit nécessaire de le mettre à jour, utile lorsque vous souhaitez forcer la vérification à chaque lancement de l’application

Paramètres	Tapez
`eventName`	`’noNeedUpdate’`
`listenerFunc`	`(état : NoNeedEvent) => void`

Depuis : 4.0.0

addListener(‘updateAvailable’, …)

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 lancement de l’application

Paramètres	Tapez
`eventName`	`’mise à jour disponible’`
`listenerFunc`	`(état : UpdateAvailableEvent) => void`

Retours : Promise<PluginListenerHandle>

Depuis : 4.0.0

addListener(‘downloadComplete’, …)

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

Écoutez les événements downloadComplete.

Paramètres	Tapez
`eventName`	`’téléchargementComplet’`
`listenerFunc`	`(état : DownloadCompleteEvent) => void`

Retours : 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, informez-vous lorsque la mise à jour majeure est bloquée en définissant DisableAutoUpdateBreaking

Paramètres	Tapez
`eventName`	`’majorAvailable’`
`listenerFunc`	`(état : MajorAvailableEvent) => void`

Retours : Promise<PluginListenerHandle>

Depuis : 2.3.0

addListener(‘updateFailed’, …)

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

Écoutez l’événement d’échec de la mise à jour dans l’application, vous informez lorsque la mise à jour n’a pas pu être installée au prochain démarrage de l’application.

Paramètres	Tapez
`eventName`	`’updateFailed’`
`listenerFunc`	`(état : UpdateFailedEvent) => void`

Depuis : 2.3.0

addListener(‘downloadFailed’, …)

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

Écoutez l’événement d’échec de téléchargement dans l’application, vous informez lorsqu’un téléchargement de bundle a échoué

Paramètres	Tapez
`eventName`	`’échec du téléchargement’`
`listenerFunc`	`(état : DownloadFailedEvent) => void`

Renvois : Promise<PluginListenerHandle>

Depuis : 4.0.0

addListener(‘appReloaded’, …)

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

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

Paramètres	Tapez
`eventName`	`’appReloaded’`
`listenerFunc`	`() => void`

Renvois : Promise<PluginListenerHandle>

Depuis : 4.3.0

addListener(‘appReady’, …)

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

Écoutez l’événement de préparation de l’application dans l’application et informez-vous lorsque l’application est prête à être utilisée.

Paramètres	Tapez
`eventName`	`’appReady’`
`listenerFunc`	`(état : AppReadyEvent) => void`

Renvois : Promise<PluginListenerHandle>

Depuis : 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Obtenez si la mise à jour automatique est disponible (non désactivée par serverUrl).

Retours : Promise<AutoUpdateAvailable>

##getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtenez le prochain bundle qui sera utilisé lors du rechargement de l’application. Renvoie null si aucun bundle suivant n’est défini.

Retours : Promesse<BundleInfo | nul>

Depuis : 6.8.0

setShakeMenu(…)

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

Activer ou désactiver le menu shake à des fins de débogage/test| Paramètres | Tapez | Descriptif | | ------------- | ------------------------------------------------------------------- | -------------------------------------------------------- | | options | SetShakeMenuOptions | Contient un booléen activé pour activer ou désactiver le menu Shake |

Depuis : 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtenez l’état actuel du menu shake

Retours : Promise<ShakeMenuEnabled>

Depuis : 7.5.0

##Interfaces

AppReadyRésultat

Accessoire	Tapez
`bundle`	`BundleInfo`

Informations groupées

Accessoire	Tapez
`id`	`string`
`version`	`string`
`downloaded`	`string`
`checksum`	`string`
`status`	`BundleStatus`

Mettre à jour l’URL

Accessoire	Tapez
`url`	`string`

StatsUrl

Accessoire	Tapez
`url`	`string`

URL de la chaîne

Accessoire	Tapez
`url`	`string`

Options de téléchargement

Cette URL et ces versions sont utilisées pour télécharger le bundle depuis le serveur. Si vous utilisez le backend, toutes les informations seront fournies par la méthode getLatest. Si vous n’utilisez pas le backend, vous devez fournir l’URL et la version du bundle. La somme de contrôle et la sessionKey sont requises si vous avez chiffré le bundle avec la commande CLI encrypt, vous devriez les recevoir à la suite de la commande.| Accessoire | Tapez | Descriptif | Par défaut | Depuis | | ---------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----- | | url | string | L’URL du fichier zip du bundle (par exemple : dist.zip) à télécharger. (Il peut s’agir de n’importe quelle URL. Par exemple : Amazon S3, une balise GitHub, tout autre endroit où vous avez hébergé votre offre groupée.) | | | | version | string | Le code/nom de version 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 | La somme de contrôle pour la mise à jour, elle doit être en sha256 et chiffrée avec une clé privée si le bundle est chiffré | undefined | 4.0.0 | | manifest | ManifestEntry[] | Le manifeste pour les téléchargements multi-fichiers Delta (manifeste) | non défini | 6.1.0 |

###Entrée du manifeste

Accessoire	Tapez
`file_name`	`chaîne \| null`
`file_hash`	`chaîne \| null`
`download_url`	`chaîne \| null`

BundleId

Accessoire	Tapez
`id`	`string`

BundleListRésultat

Accessoire	Tapez
`bundles`	`BundleInfo[]`

Options de liste| Accessoire | Tapez | Descriptif | Par défaut | Depuis |

| --------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------ | | raw | booléen | S’il faut renvoyer la liste brute des bundles ou le manifeste. Si c’est 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

Accessoire	Tapez
`toLastSuccessful`	`booléen`

CurrentBundleResult

Accessoire	Tapez
`bundle`	`BundleInfo`
`native`	`string`

MultiDelayConditions

Accessoire	Tapez
`delayConditions`	`DelayCondition[]`

### Condition de délai

Accessoire	Tapez	Descriptif
`kind`	`DelayUntilNext`	Configurer les conditions de retard dans setMultiDelay
`value`	`string`

Dernière version| Accessoire | Tapez | Descriptif | Depuis |

| ---------------- | ---------------------------- | -------------------------- | ----- | | version | string | Résultat de la méthode getLatest | 4.0.0 | | checksum | string | | 6 | | major | booléen | | | | message | string | | | | sessionKey | string | | | | error | string | | | | old | string | | | | url | string | | | | manifest | ManifestEntry[] | | 6.1 |

Obtenir les dernières options

Accessoire	Tapez	Descriptif	Par défaut	Depuis
`channel`	`string`	La chaîne pour obtenir la dernière version pour La chaîne doit autoriser ‘self_assign’ pour que cela fonctionne	`undefined`	6.8.0

Résolution du canal

Accessoire	Tapez	Descriptif	Depuis
`status`	`string`	État actuel du canal défini	4.7.0
`error`	`string`
`message`	`string`

Définir les options de canal

Accessoire	Tapez
`channel`	`string`
`triggerAutoUpdate`	`booléen`

Désactiver les options de canal

Accessoire	Tapez
`triggerAutoUpdate`	`booléen`

GetChannelRes| Accessoire | Tapez | Descriptif | Depuis |

| ------------- | ------------------------------------------------- | ---------------------------------------------- | ----- | | percent | numéro | État actuel du téléchargement, entre 0 et 100. | 4.0.0 | | bundle | BundleInfo | | |

Aucun événement nécessaire

Accessoire	Tapez	Descriptif	Depuis
`bundle`	`BundleInfo`	État actuel du téléchargement, entre 0 et 100.	4.0.0

UpdateAvailableEvent

Accessoire	Tapez	Descriptif	Depuis
`bundle`	`BundleInfo`	État actuel du téléchargement, entre 0 et 100.	4.0.0

TéléchargerCompleteEvent

Accessoire	Tapez	Descriptif	Depuis
`bundle`	`BundleInfo`	Émettre lorsqu’une nouvelle mise à jour est disponible.	4.0.0

ÉvénementMajorAvailable

Accessoire	Tapez	Descriptif	Depuis
`version`	`string`	Émettez lorsqu’un nouveau bundle majeur est disponible.	4.0.0

UpdateFailedEvent

Accessoire	Tapez	Descriptif	Depuis
`bundle`	`BundleInfo`	Émettre lorsqu’une mise à jour n’a pas pu être installée.	4.0.0

###TéléchargementFailedEvent

Accessoire	Tapez	Descriptif	Depuis
`version`	`string`	Émettre lorsqu’un téléchargement échoue.	4.0.0

Fonctions et paramètres

Configuration du plugin de mise à jour

Méthodes

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

téléchargement(…)

suivant(…)

ensemble(…)

supprimer(…)

liste(…)

réinitialiser (…)

actuel()

setMultiDelay(…)

getLatest(…)

setChannel(…)

unsetChannel(…)

listChannels()

setCustomId(…)

isAutoUpdateEnabled()

RemoveAllListeners()

addListener(‘télécharger’, …)

addListener(‘noNeedUpdate’, …)

addListener(‘updateAvailable’, …)

addListener(‘downloadComplete’, …)

addListener(‘majorAvailable’, …)

addListener(‘updateFailed’, …)

addListener(‘downloadFailed’, …)

addListener(‘appReloaded’, …)

addListener(‘appReady’, …)

isAutoUpdateAvailable()

setShakeMenu(…)

isShakeMenuEnabled()

AppReadyRésultat

Informations groupées

Mettre à jour l’URL

StatsUrl

URL de la chaîne

Options de téléchargement

BundleId

BundleListRésultat

Options de liste| Accessoire | Tapez | Descriptif | Par défaut | Depuis |

Réinitialiser les options

CurrentBundleResult

MultiDelayConditions

Dernière version| Accessoire | Tapez | Descriptif | Depuis |

Obtenir les dernières options

Résolution du canal

Définir les options de canal

Désactiver les options de canal

GetChannelRes| Accessoire | Tapez | Descriptif | Depuis |

Aucun événement nécessaire

UpdateAvailableEvent

TéléchargerCompleteEvent

ÉvénementMajorAvailable

UpdateFailedEvent

AppReadyÉvénement