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 la synchronisation de la plateforme et la mise à jour de l'application dans le magasin 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, et channelUrl à https://plugin.eu.capgo.app/channel_self. Voir Emplacement des données.

allowModifyUrl

Permettre au plugin de modifier dynamiquement updateUrl, statsUrl et 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'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 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 anciens 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érer automatiquement la suppression de l'écran de splash lorsque vous utilisez les 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 à des événements appReady et d'appeler SplashScreen.hide(). Cela ne fonctionne que lorsque autoUpdate est défini sur "atInstall", "onLaunch", ou "always". Les valeurs directUpdate sont toujours prises en charge pour la compatibilité avec les versions précédentes. 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. periodCheckDelay Le plugin vérifie les mises à jour lorsque l'application passe en avant-plan et sur un timer répétitif tout en restant ouverte. true Contrôlez cette intervalle de timer. "atBackground" Les valeurs booléennes sont toujours prises en charge pour la compatibilité backward : false est le même que "off"et

est le même que

• "off" . Les valeurs de chaîne fusionnent les configurations précédentes de Mise à jour automatique et de Mise à jour directe. falseOptions :
• "atBackground" ou true: Désactivez les vérifications automatiques de mise à jour
• "atInstall"ou : Vérifiez et téléchargez automatiquement à chaque vérification en avant-plan, puis appliquez la mise à jour la prochaine fois que l'application passe en arrière-plan "atBackground" behavior
• "onLaunch"Se mettre en œuvre immédiatement uniquement lorsque l'application est ramenée à l'avant-plan à partir d'un état arrêté (démarrage froid). Après cette première vérification, revenir à "atBackground" behavior
• "always"Vérifier à chaque transition vers l'avant-plan et s'appliquer immédiatement dès que des mises à jour sont disponibles
• "onlyDownload"Vérifier et télécharger automatiquement, émettre updateAvailable, et ne jamais définir le prochain bundle ou appliquer 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ésuétude. Utilisez autoUpdate les modes de chaîne à la place : "atInstall", "onLaunch", ou "always". Cette option reste prise en charge pour les applications existantes.

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 antérieures

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

disableJSLogging

Désactiver la mise en page JavaScript du plugin. Si vrai, le plugin ne loguera pas dans la console JavaScript. Seule la mise en page 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'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 la mise à jour en temps réel de bout en bout chiffrée Version 2.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

capacitor.config.json

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

Attention

publicKey configure l'encryption V2 et doit correspondre à la clé privée utilisée lors de l'upload. Pour les mises à jour Delta, utilisez l'encryption V2 avec l'encryption partiel activé, et activez l'enforcement du paquet 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 archives téléchargées précédentes lorsque l'une nouvelle archive native d'application est installée sur le dispositif.

Déployable sur Android, iOS et Electron.

Par défaut : true

capacitor.config.json

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

responseTimeout

Configurer le nombre de millisecondes que le plugin natif devrait attendre avant de considérer API comme une erreur de temps limite.

Déployable 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 statistiques de mise à jour.

Disponible sur Android, iOS et Electron. Définir sur "" pour désactiver explicitement le rapport de statistiques à travers /stats.

La désactivation statsUrl ne désactive pas tous les stockages de dispositif Capgo. Si updateUrl reste activé, /updates encore stocke la ligne de facturation MAU, l'inventaire des appareils 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 la 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 à partir 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 le 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' Capgo application web 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 opérations de API , connectez-le avec En utilisant @capgo/capacitor-mise à jour pour la capacité native dans En utilisant @capgo/capacitor-mise à 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.