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 ? 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 d'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 paquets é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 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

Requis lors de l'utilisation des modes d'application instantanée ("atInstall", "onLaunch", ou "always"), y compris la valeur dépréciée directUpdate Installez @capacitor/splash-screen et définissez launchAutoHide: false. Lorsqu'il est activé, le plugin masque l'écran de démarrage après les mises à jour sont appliquées ou lorsque aucune mise à jour n'est nécessaire. Cela supprime la nécessité de faire appel à des é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 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 arrière-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é avec les versions précédentes : true est la même chose que "atBackground" et false est la même chose que "off"et

Options :

• "off" ou falseou
• "atBackground" ou true: 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
• "atInstall": Appliquez immédiatement uniquement après une installation fraîche ou une mise à jour de l'application native ; sinon utilisez "atBackground" comportement
• "onLaunch": Appliquez 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, revenez à "atBackground" comportement
• "always": Vérifiez à chaque transition en avant-plan et appliquez immédiatement dès que la mise à jour est disponible
• "onlyDownload": Vérifiez et téléchargez automatiquement, émettez updateAvailable, et ne définissez jamais le prochain bundle ou appliquez une mise à jour automatiquement

Modes d'application instantanée ("atInstall", "onLaunch", "always") s'appliquent pendant que l'utilisateur attend. Téléchargez uniquement les fichiers modifiés avec npx @capgo/cli@latest bundle upload --delta afin que la téléchargement ne ralentisse pas l'expérience 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éfinissez 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 les modes de chaîne au lieu de cela : "atInstall", "onLaunch", ou . Cette option reste prise en charge pour les applications existantes. L'application instantanée doit être téléchargée avec "always"afin d'éviter que la mise à jour ralentisse l'expérience utilisateur. Ces modes nécessitent --delta Remarque : Cette option est déconseillée. Utilisez les modes de chaîne au lieu de cela. autoSplashscreen: true et @capacitor/splash-screen avec launchAutoHide: false.

Options :

• falseMise à jour directe : Jamais
• 'atInstall'Mise à jour identique à autoUpdate: "atInstall"
• 'onLaunch'Mise à jour identique à autoUpdate: "onLaunch"
• 'always'Mise à jour identique à autoUpdate: "always"
• trueMise à jour identique à (déprécié) Mise à jour identique à "always" pour la compatibilité de l'arrière

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

disableJSLogging

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

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

Attention

Lorsqu'un rechargement 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 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 la cryptage en temps réel de mise à jour Version 2.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

capacitor.config.json

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

Attention

publicKey configure la cryptage V2 et doit correspondre à la clé privée utilisée lors de l'upload. Pour les mises à jour Delta, utilisez la cryptage V2 avec la partial encryption activée, et activez l'encodage sécurisé du bundle si votre organisation exige que chaque upload soit crypté. N'ayez pas confiance dans publicKey seul comme une politique côté serveur empêchant une mise à jour non cryptée d'être publiée.

resetWhenUpdate

Supprimer automatiquement les versions précédemment téléchargées des bundles lorsque l'une plus récente de l'application native 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 lesquelles le plugin natif devrait attendre avant de considérer API comme dépassé.

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

Disponible sur Android, iOS et Electron. Défini sur "" pour désactiver les rapports explicites de statistiques. /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 par 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 d'entrée 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.

Default : 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é.

Default : 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é.

Default : 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 Capgo web app Continuez depuis les Paramètres

Sous-titre « Continuez depuis les Paramètres »

Paramètres pour planifier les opérations de tableau de bord et to plan dashboard and API operations, connect it with Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, API Présentation pour les détails d'implémentation dans API Présentation Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.