Paramètres

Conseil

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 les reçoivent.

Remarque

Besoin de résidence des données dans l'UE pour Capgo Cloud ? Configurez 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.

allowModifyUrl

Permettre au plugin de modifier 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 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 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 bundles après une mise à jour réussie.

Déploié 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. autoUpdate Cela supprime la nécessité de s'abonner manuellement à l'événement appReady et d'appeler SplashScreen.hide(). "atInstall", "onLaunch"Cela ne fonctionne que lorsque "always"est défini sur 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.

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ô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 le même que "atBackground" et false 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.

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 de fond, 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 à l'avant-plan à partir d'un état tué (démarrage froid). Après la première vérification, tomber en arrière sur "atBackground" comportement
• "always": Vérifier à chaque transition de fond et appliquer immédiatement chaque fois qu'une mise à jour est disponible
• "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 mise en œuvre 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 plutôt 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 faites jamais de mises à jour directes
• 'atInstall': Même chose que 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 loguera 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 temps réel 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"
    }
  }
}

resetWhenUpdate

Supprimer automatiquement les archives téléchargées précédentes 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

Configurer 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 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

Configurer 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'explicitation des statistiques de mise à jour par /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 Compliance 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 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 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 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'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 planer le tableau de bord et les opérations API, connectez-le avec En utilisant @capgo/capacitor-mise-à-jour pour le 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.