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 la mettre à jour dans l'app store pour que les applications de production les reçoivent.

Remarque

Besoin de résidence des données de l'UE pour Capgo Cloud ? Définissez updateUrl à https://plugin.eu.capgo.app/updates, statsUrl à https://plugin.eu.capgo.app/statsà channelUrl . Consultez https://plugin.eu.capgo.app/channel_selfEmplacement des données Section intitulée « allowModifyUrl ».

allowModifyUrl

Déploié sur Android, iOS et Electron.

Par défaut :

__CAPGO_KEEP_0__.config.json false

capacitor.config.json

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

appId

Configurez l'identifiant 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 lesquelles 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 versions échouées.

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 versions précédentes 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érer automatiquement la suppression de l'écran de splash lors de l'utilisation des modes d'application instantanée. 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 à l'événement appReady et d'appeler SplashScreen.hide(). Seul fonctionne lorsque autoUpdate est défini sur "atInstall", "onLaunch", ou "always". Les valeurs de compatibilité arriérée sont toujours prises en charge. Exige l'installation et la configuration du plugin @__CAPGO_KEEP_0__/splash-screen avec launchAutoHide : false. Exige que l'actualisation automatique soit activée. directUpdate values are still supported for backward compatibility. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires Auto Update to be enabled.

Par défaut :

__CAPGO_KEEP_0__.config.json 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étitif tout en restant ouverte. periodCheckDelay Contrôlez 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"et Les valeurs de chaîne fusionnent les configurations de mise à jour automatique et de mise à jour directe précédentes.

Options :

• "off" ou falseou
• "atBackground" : Désactivez les vérifications automatiques de mise à jour trueou
• "atInstall": Appliquer immédiatement uniquement après une installation fraîche ou une mise à jour de l'application native ; sinon utilisez "atBackground" le comportement
• "onLaunch": Appliquer immédiatement uniquement lorsque l'application est ramenée à l'avant-plan à partir d'un état tué (démarrage froid). Après cette première vérification, tombez en arrière sur "atBackground" le comportement
• "always": Vérifiez à chaque transition en avant-plan et appliquez immédiatement chaque fois qu'une mise à jour est disponible
• "onlyDownload": Vérifiez et téléchargez automatiquement, émettez updateAvailable, et n'installez 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

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éprécié. Utilisez autoUpdate les modes de chaîne au lieu de : "atInstall", "onLaunch", ou "always". Cette option reste prise en charge pour les applications existantes.

Options :

• false: Ne jamais effectuer des mises à jour directes
• 'atInstall': Identique à autoUpdate: "atInstall"
• 'onLaunch': Identique à autoUpdate: "onLaunch"
• 'always': Identique à autoUpdate: "always"
• true: (déprécié) Identique à "always" pour la compatibilité backward

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

disableJSLogging

Désactiver 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

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

Attention

Lorsqu'une mise à jour est déclenchée, ‘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 des mises à jour périodiques. 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 en direct à la fin de l'actualisation en direct 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 la partial encryption activée, et activez l'encodage sécurisé-bundle 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 fichiers de bundle téléchargés lorsque l'un plus récent 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 pendant lesquelles le plugin natif devrait attendre avant de considérer API comme une erreur de temps limite.

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 secouement pour afficher le menu de mise à jour aux 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 statistiques de mise à jour.

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

Désactiver statsUrl ne désactive pas tous les stockages de dispositif Capgo. 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 Compliancy 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 les vérifications de mise à jour sont envoyées.

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 à partir de la 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

Configurer 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

Configurer 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 l'application web de 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 le tableau de bord et les API opérations, connectez-l’avec En utilisant @capgo/capacitor-mises-à-jour pour la capacité native dans En utilisant @capgo/capacitor-mises-à-jour, 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 le détail d'implémentation dans Appareils.