Paramètres

Pour un contrôle plus précis du système de mise à jour, vous pouvez le configurer avec ces paramètres :

Astuce

Toute modification de ces paramètres dans le fichier capacitor.config nécessite une synchronisation de la plateforme et une publication sur les stores pour que les apps en production les reçoivent.

Remarque

Need EU data residency for Capgo Cloud? Set updateUrl vers https://plugin.eu.capgo.app/updates, statsUrl vers https://plugin.eu.capgo.app/stats, et channelUrl vers https://plugin.eu.capgo.app/channel_self. Voir Localisation des données.

Pour utiliser votre propre nom d'hôte pour updateUrl, statsUrl, et channelUrl, see configuration du domaine personnalisé.

allowModifyUrl

Autorise le plugin à modifier dynamiquement l'updateUrl, la statsUrl et la channelUrl depuis le côté JavaScript.

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Configurez l'appId de l'application dans la configuration.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Configurez le nombre de millisecondes que le plugin natif doit attendre avant de considérer qu'une mise à jour a échoué.

Disponible sur Android, iOS et Electron.

Par défaut : 10000 (10 secondes)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Configure si le plugin doit supprimer automatiquement les bundles ayant échoué.

Disponible sur Android, iOS et Electron.

Par défaut : true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

Configure si le plugin doit supprimer automatiquement les bundles précédents après une mise à jour réussie.

Disponible sur Android, iOS et Electron.

Par défaut : true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Requis avec les modes instant apply ("atInstall", "onLaunch", ou "always"), y compris les valeurs directUpdate obsolètes. Installez @capacitor/splash-screen et configurez launchAutoHide: false. Lorsqu'il est activé, le plugin masque le splashscreen une fois les mises à jour appliquées ou lorsqu'aucune mise à jour n'est nécessaire. Cela évite d'écouter manuellement les événements appReady et d'appeler SplashScreen.hide().

Disponible sur Android et iOS.

Par défaut : false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

autoUpdate

Configurez la manière dont le plugin recherche, télécharge et applique les live update(s). Le plugin recherche des mises à jour lorsque l'application passe au premier plan et via un timer périodique tant que l'application reste ouverte. periodCheckDelay contrôle l'intervalle de ce timer. Les valeurs booléennes sont toujours supportées pour la rétrocompatibilité : true est équivalent à "atBackground" et false est équivalent à "off". Les valeurs de type string fusionnent les configurations Auto Update et Direct Update précédentes.

Options :

• "off" ou false: Disable automatic update checks
• "atBackground" ou true: Rechercher et télécharger automatiquement à chaque passage au premier plan, puis appliquer la mise à jour au prochain passage en arrière-plan
• "atInstall": Appliquer immédiatement uniquement après une nouvelle installation ou une mise à jour native sur les stores ; sinon, utiliser "atBackground" comportement
• "onLaunch": S'applique immédiatement uniquement lorsque l'app revient au premier plan après avoir été tuée (cold start). Après ce premier contrôle, revenez à "atBackground" comportement
• "always": Vérifie à chaque passage au premier plan et applique immédiatement dès qu'une mise à jour est disponible
• "onlyDownload": Vérifie et télécharge automatiquement, émet updateAvailable, et ne définit jamais le prochain bundle ni n'applique automatiquement de mise à jour

Modes d'application instantanée ("atInstall", "onLaunch", "always") s'appliquent pendant que l'utilisateur attend. Envoyez avec npx @capgo/cli@latest bundle upload --delta pour ne télécharger que les fichiers modifiés. Un upload de zip complet ralentit l'expérience utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen: true et @capacitor/splash-screen par launchAutoHide: false.

Disponible sur Android, iOS et Electron.

Par défaut : "atBackground" (true est toujours acceptée)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

Configurez l'URL / le point de terminaison pour les opérations de canal.

Disponible sur Android, iOS et Electron.

Par défaut : https://plugin.capgo.app/channel_self

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

defaultChannel

Définissez le canal par défaut de l'application dans la config. Sensible à la casse. Ce paramètre remplacera le canal par défaut défini dans le cloud, tout en respectant les overrides effectués dans le cloud.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Obsolète. Utilisez autoUpdate les modes string à la place : "atInstall", "onLaunch", ou "always". Cette option reste supportée pour les applications existantes. L'application instantanée doit être envoyée avec --delta pour que la mise à jour ne ralentisse pas l'expérience utilisateur. Ces modes nécessitent autoSplashscreen: true et @capacitor/splash-screen par launchAutoHide: false.

Options :

• false: Ne faites jamais de mises à jour directes
• 'atInstall': Idem pour autoUpdate: "atInstall"
• 'onLaunch': Idem pour autoUpdate: "onLaunch"
• 'always': Idem pour autoUpdate: "always"
• true: (déprécié) Idem pour "always" pour la rétrocompatibilité

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

Désactive les logs JavaScript du plugin. Si activé, le plugin ne loguera pas dans la console JavaScript. Seuls les logs natifs seront conservés.

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

Configure le plugin pour conserver le chemin de l'URL après un reload.

Attention

Lorsqu'un reload est déclenché, « window.history » sera vidé.

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

Configurez le délai de vérification périodique des mises à jour. L'unité est la seconde. Ne peut pas être inférieur à 600 secondes (10 minutes).

Disponible sur Android, iOS et Electron.

Par défaut : 600 (10 minutes)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Configurez la clé publique pour le chiffrement de bout en bout live update version 2.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

Attention

publicKey configure le chiffrement V2 et doit correspondre à la clé privée utilisée lors de l'upload. Pour les mises à jour Delta, utilisez le chiffrement V2 avec le chiffrement partiel activé, et activez l'obligation de bundle chiffré si votre organisation exige que chaque upload soit chiffré. Ne vous reposez pas uniquement sur publicKey comme politique côté serveur pour empêcher la publication d'un Delta non chiffré.

resetWhenUpdate

Supprimer automatiquement les bundles téléchargés précédemment lorsqu'un nouveau bundle d'application natif est installé sur l'appareil.

Disponible sur Android, iOS et Electron.

Par défaut : true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Configurez le nombre de millisecondes que le plugin natif doit attendre avant de considérer un timeout API.

Disponible sur Android, iOS et Electron.

Par défaut : 20 (20 secondes)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

Activez le geste de secousse pour afficher le menu de mise à jour à des fins de débogage ou de test.

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

Configurez l'URL / l'endpoint vers lequel les statistiques de mise à jour sont envoyées.

Disponible sur Android, iOS et Electron. Définissez sur "" pour désactiver l'envoi explicite de statistiques via /stats.

La désactivation statsUrl ne désactive pas tout le stockage de l'appareil Capgo. Si updateUrl reste activé, /updates still stores the billing MAU row, device inventory, and update-decision event data needed to serve updates and count MAU. See Conformité pour le détail par champ.

Par défaut : https://plugin.capgo.app/stats

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

updateUrl

Configure the URL / endpoint to which update checks are sent.

Disponible sur Android, iOS et Electron.

Par défaut : https://plugin.capgo.app/updates

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

version

Configurez la version actuelle de l'application. Elle sera utilisée pour la première requête de mise à jour. Si elle n'est pas définie, le plugin récupérera la version depuis le code natif.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Paramètres de développement

localApi

Configurez CLI afin de tester avec un api local.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Configurez CLI afin de tester avec un fichier api local.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Configurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

Configurez CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Configurez le CLI pour utiliser un serveur local lors de vos tests.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Configurez le CLI pour utiliser un serveur local pour vos tests ou un serveur de mise à jour auto-hébergé.

Par défaut : undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Astuce

D'autres paramètres sont disponibles dans l' application web Capgo qui peuvent être configurés par canal sans nécessiter de nouvelle release native.

Continuer depuis les paramètres

Si vous utilisez Paramètres pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-updater pour la capacité native dans « Utiliser @capgo/capacitor-updater », Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.