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 le magasin pour que les applications de production les reçoivent.

Remarque

Besoin de résidence de données dans 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. Consultez 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

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 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 aux é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 l'installation et la configuration du plugin @capacitor/splash-screen avec launchAutoHide : false. Exige que 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 doit utiliser la mise à jour automatique via un serveur de mise à jour. true Les valeurs booléennes sont toujours prises en charge pour la compatibilité backward : "atBackground" est la même chose que false et "off".

est la même chose que

• "off" Options : falseou
• "atBackground" : Désactiver la mise à jour automatique trueou
• "atInstall": Vérifier et télécharger automatiquement, puis appliquer lorsque l'application passe en arrière-plan "atBackground"
• "onLaunch": Appliquer immédiatement uniquement après une installation fraîche ou une mise à jour d'application native, sinon utiliser : « __CAPGO_KEEP_0__ »  "atBackground" vérifiez après le lancement
• "always": Appliquez immédiatement chaque fois que Mise à jour automatique s'exécute
• "onlyDownload" : Vérifiez et téléchargez automatiquement, émettez updateAvailable , et ne définissez jamais le prochain bundle 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.

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

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Désuète. Utilisez autoUpdate 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 “toujours” pour la compatibilité backward

Disponible sur Android, iOS et Electron.

Par défaut : false

capacitor.config.json

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

disableJSLogging

Désactivez les journaux JavaScript du plugin. Si vrai, le plugin ne loguera pas dans la console JavaScript. Seuls les journaux natifs seront effectués.

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 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 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 à deux extrémités, 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 versions 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

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

Disponible sur Android, iOS et Electron. Définissez sur "" pour désactiver l'envoi de statistiques.

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

Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code.

Si elle n'est pas définie, le plugin récupérera la version à partir de la native __CAPGO_KEEP_0__.

Disponible sur Android, iOS et Electron. undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Copier dans le presse-papier

localApi

Configure the CLI to use a local api for testing.

Configurez le __CAPGO_KEEP_0__ pour utiliser un __CAPGO_KEEP_1__ local pour les tests. 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 le tableau de bord et les opérations de API , connectez-le avec En utilisant @capgo/capacitor-mise-à-jour pour la capacité native 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.