Paramètres

Pour avoir un contrôle plus fin sur le système d'actualisation, vous pouvez le configurer avec ces paramètres :

Conseil

Toute modification de ces paramètres dans le fichier capacitor.config nécessite de synchroniser la plateforme et de publier l'application pour que les versions de production puissent les recevoir.

Remarque

Besoin de résidence de données UE pour Capgo Cloud ? Définissez updateUrl à https://plugin.eu.capgo.app/updates, statsUrl à https://plugin.eu.capgo.app/stats, et channelUrl à https://plugin.eu.capgo.app/channel_self. Consultez Emplacement des données.

Pour utiliser votre propre nom de domaine pour updateUrl, statsUrl, et channelUrl, voir Configuration de domaine personnalisé.

allowModifyUrl

Permettez au plugin de modifier les valeurs de updateUrl, statsUrl et channelUrl dynamiquement 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'ID 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 pendant lequel le plugin natif attend avant de considérer une mise à jour comme « échouée ».

Disponible sur Android, iOS et Electron.

Par défaut : 10000 (10 secondes)

capacitor.config.json

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

autoDeleteFailed

Configurez si le plugin devrait supprimer automatiquement les bundles échoués.

Disponible sur Android, iOS et Electron.

Par défaut : true

capacitor.config.json

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

autoDeletePrevious

Configurez si le plugin doit supprimer automatiquement les précédents paquets 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

Lorsque vous utilisez les modes d'application instantanée."atInstall", "onLaunch"ou "always"), y compris les anciens directUpdate valeurs. Installez @capacitor/splash-screen et configurez launchAutoHide: false. Lorsque l'option est activée, le plugin masque l'écran de démarrage après les mises à jour sont appliquées ou lorsqu'aucune mise à jour n'est nécessaire. Cela supprime la nécessité de faire appel manuellement à l'événement 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 comment le plugin vérifie, télécharge et applique les mises à jour en temps réel. Le plugin vérifie les mises à jour lorsque l'application passe en avant-plan et sur un horloge répétitive tout en restant ouverte. periodCheckDelay contrôlez cette intervalle. Les valeurs booléennes sont toujours prises en charge pour la compatibilité backward : true est la même que "atBackground" et false est la même que "off". Les valeurs de chaînes de caractères fusionnent les configurations d'Auto Update et Direct Update précédentes.

Options :

• "off" ou false: Disable automatic update checks
• "atBackground" ou trueVérifiez et téléchargez automatiquement à chaque vérification de fond, puis appliquez la mise à jour la prochaine fois que l'application passe en arrière-plan.
• "atInstall": Appliquer immédiatement uniquement après une installation fraîche ou une mise à jour de l'application native ; sinon utiliser "atBackground" behavior
• "onLaunch"comportement : : Appliquer immédiatement uniquement lorsque l'application est ramenée en avant-plan à partir d'un état tué (démarrage froid). Après la première vérification, revenir au "atBackground" Comportement
• "always": Vérifiez à chaque transition en avant-plan et appliquez immédiatement lorsque une mise à jour est disponible
• "onlyDownload": Vérifiez et téléchargez automatiquement, émettez updateAvailable, et ne fixez jamais le prochain bundle ou appliquez une mise à jour automatiquement

Modes d'application instantanée ("atInstall", "onLaunch", "always") s'applique pendant l'attente de l'utilisateur. Télécharger avec npx @capgo/cli@latest bundle upload --delta afin que la téléchargement d'un zip complet ne ralentisse pas l'expérience de l'utilisateur. Sur Android et iOS, ces modes nécessitent autoSplashscreen: true et @capacitor/splash-screen avec launchAutoHide: false.

Disponible sur Android, iOS et Electron.

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

capacitor.config.json

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

channelUrl

Configurez l'URL / 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éfinir 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 remplacements effectués dans le cloud.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

capacitor.config.json

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

directUpdate

Désuète. Utilisez autoUpdate modes de chaîne au lieu : "atInstall", "onLaunch", ou "always". Cette option reste prise en charge pour les applications existantes. Appliquer instantanément doit être téléchargé avec --delta afin que l'update ne ralentisse pas l'expérience utilisateur. Ces modes nécessitent autoSplashscreen: true et @capacitor/splash-screen avec launchAutoHide: false.

Options :

• false : Ne jamais faire d'updates directs
• 'atInstall': Identique à autoUpdate: "atInstall"
• 'onLaunch': Identique à autoUpdate: "onLaunch"
• 'always': Identique à autoUpdate: "always"
• true: (déprécié) Identique à "always" pour la compatibilité avec les anciens systèmes

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

disableJSLogging

Désactivez l'affichage des logs JavaScript du plugin. Si vrai, le plugin ne loguera pas dans la console JavaScript. Seuls les logs natifs seront effectués.

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

keepUrlPathAfterReload

Configurez le plug-in pour conserver l'URL de chemin après un rechargement.

Attention !

Lorsqu'un rechargement est déclenché, « window.history » sera effacé.

Déploié sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

periodCheckDelay

Configurez la période de retard pour la vérification de mise à jour périodique. L'unité est en secondes. 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 une encryption à bout de chaîne 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 Configurez l'Encryption V2 et assurez-vous qu'elle correspond à la clé privée utilisée lors de l'importation. Pour les mises à jour Delta, utilisez l'encryption V2 avec l'encryption partiel activé, et activez la mise en œuvre de l'enregistrement chiffré si votre organisation exige que chaque importation soit chiffrée. N'ayez pas confiance dans publicKey seul comme une politique côté serveur empêchant une Delta non chiffrée d'être publiée.

resetWhenUpdate

Supprimer automatiquement les anciens bundles téléchargés lorsque l'application native mise à jour est installée sur le dispositif.

Disponible sur Android, iOS et Electron.

Par défaut : true

capacitor.config.json

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

responseTimeout

Configurez le nombre de millisecondes pendant lequel le plugin natif doit attendre avant de considérer API comme une défaillance.

Disponible sur Android, iOS et Electron.

Par défaut : 20 20 secondes

capacitor.config.json

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

shakeMenu

Activer le geste de secousses pour afficher le menu de mise à jour lors de la débogage/test.

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

statsUrl

Configurez l'URL/point de terminaison vers lequel sont envoyées les statistiques d'actualisation.

Disponible sur Android, iOS et Electron. Défini sur "" pour désactiver les statistiques explicites de rapport à travers /stats.

Désactiver statsUrl ne désactive pas tous les stockages de Capgo de l'appareil. Si updateUrl reste activé, /updates les données de facturation de la ligne MAU, l'inventaire du dispositif et les données d'événement de décision d'actualisation sont toujours stockées. Voir Conformité pour le détail au niveau du 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. 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 du native code.

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 le CLI pour utiliser un api local pour les tests.

Par défaut : undefined

capacitor.config.json

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

localApiFiles

Configurez le CLI pour utiliser un fichier local api pour les tests.

Par défaut : undefined

capacitor.config.json

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

localHost

Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation auto-hébergé.

Par défaut : undefined

capacitor.config.json

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

localSupa

Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur d'actualisation 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 pour les 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 les tests ou un serveur d'actualisation auto-hébergé.

Par défaut : undefined

capacitor.config.json

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

Conseil

Il existe d'autres paramètres disponibles dans le Capgo application web qui peut être configuré par canal sans nécessiter une mise à jour native de l'application.

Continuez de la page Paramètres.

Si vous utilisez Paramètres pour planifier les opérations de tableau de bord et API, connectez-l’à En utilisant @capgo/capacitor-mises-à-jour pour la capacité native dans En utilisant @capgo/capacitor-mises-à-jours 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 les détails d'implémentation sur les appareils.