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 dans l'app store pour que les applications de production reçoivent ces modifications.

Remarque

Besoin de résidence des données de l'UE pour Capgo Cloud ? Définissez updateUrl sur https://plugin.eu.capgo.app/updates, statsUrl sur https://plugin.eu.capgo.app/statset channelUrl vers https://plugin.eu.capgo.app/channel_self. Voir Emplacement des données.

allowModifyUrl

Permettre au plugin de modifier l'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

Configurer l'ID de l'application pour 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 devrait attendre 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 doit 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 bundles 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

Gère automatiquement la suppression de l'écran de chargement lors de l'utilisation des modes d'application instantanée. Lorsque cette option est activée, le plugin supprimera automatiquement l'écran de chargement après les mises à jour ont été appliquées ou lorsque aucune mise à jour n'est nécessaire. Cela supprime la nécessité de s'abonner manuellement à des événements appReady et d'appeler SplashScreen.hide(). Seul fonctionne lorsque autoUpdate est défini sur "atInstall", "onLaunch", ou "always". Les valeurs directUpdate sont toujours prises en charge pour la compatibilité backward. 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, iOS et Electron.

Par défaut : false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

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ôle l'intervalle de cet horloge. Les valeurs booléennes sont toujours prises en charge pour la compatibilité backward : true est la même chose que "atBackground" et false est la même chose que "off". Les valeurs de chaîne fusionnent la configuration d'Auto Mise à Jour et de Mise à Jour Directe précédente.

Options :

• "off" ou false: Désactiver les vérifications automatiques de mise à jour
• "atBackground" ou true: Vérifier et télécharger automatiquement à chaque vérification en avant-plan, puis appliquer 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" comportement
• "onLaunch": 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, reculer vers "atBackground" comportement
• "always": Vérifiez à chaque transition de fond et appliquez immédiatement dès que des mises à jour sont disponibles
• "onlyDownload": Vérifiez et téléchargez automatiquement, émettez updateAvailable, et ne définissez jamais le prochain bundle ou appliquez une mise à jour automatiquement

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

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 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éprécié. Utilisez les modes de chaîne à la place : autoUpdate Deprecated. Use string modes instead: __CAPGO_KEEP_0__. "atInstall", "onLaunch"ou "always"Pour les applications existantes, cette option reste prise en charge.

Options :

• false: Ne faites jamais de mises à jour directes
• 'atInstall': Même chose que autoUpdate: "atInstall"
• 'onLaunch': Même chose que autoUpdate: "onLaunch"
• 'always': Même chose que autoUpdate: "always"
• true: (déprécié) Même chose que "always" pour la compatibilité avec les versions précédentes

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

disableJSLogging

Désactivez la journalisation JavaScript du plugin. Si vrai, le plugin ne journalira pas dans la console JavaScript. Seule la journalisation native sera effectuée.

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

keepUrlPathAfterReload

Configurez le plugin pour conserver l'URL de chemin après un rechargement.

Attention

Lorsqu'un rechargement est déclenché, ‘window.history’ sera effacé.

Disponible 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 le chiffrement de mise à jour en direct de bout en bout, 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 la mise en œuvre de l'ensemble chiffré si votre organisation exige que chaque upload soit chiffré. N'ayez pas confiance dans publicKey seul comme une politique côté serveur empêchant une mise à jour Delta non chiffrée d'être publiée.

resetWhenUpdate

Supprimer automatiquement les anciens ensembles téléchargés lorsqu'un nouveau bundle d'application native est installé 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 que le plugin natif devrait attendre avant de considérer API comme un temps d'attente.

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 pour des fins de 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 mises à jour des statistiques.

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

Désactiver statsUrl ne désactive pas tous les stockages de dispositif Capgo. Si updateUrl reste activé, /updates stocke toujours la ligne de facturation MAU, l'inventaire de dispositif et les données d'événement de décision de mise à jour nécessaires pour servir les mises à jour et compter le MAU. 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

Configurez l'URL / point de terminaison vers lequel sont envoyées les vérifications de mise à jour.

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 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 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 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 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 l'application web Capgo qui peuvent être configurés par canal sans nécessiter une mise à jour de l'application native.

Continuez depuis les paramètres

Si vous utilisez Paramètres pour planifier les opérations de tableau de bord et API Using @capgo/capacitor-updater En utilisant @capgo/capacitor-mises-à-jour-native API Résumé pour le détail d'implémentation dans API Résumé, 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.