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

allowModifyUrl

Autoriser le plugin à modifier l'URL d'actualisation, l'URL de statistiques et l'URL de canal 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 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 précédents 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 faire écouter manuellement les é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é 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 doit utiliser Mise à jour automatique via un serveur de mise à jour. Les valeurs booléennes sont toujours prises en charge pour la compatibilité backward : true est la même chose que "atBackground" ou false est la même chose que "off".

Options :

• "off" ou falseou
• "atBackground" : Désactiver Mise à jour automatique true: Vérifiez et téléchargez automatiquement, puis appliquez lorsque l'application passe en arrière-plan
• "atInstall": Appliquez immédiatement uniquement après une installation fraîche ou une mise à jour d'application native, sinon utilisez "atBackground"
• "onLaunch": Appliquez immédiatement à l'ouverture, sinon utilisez "atBackground" après la vérification de lancement
• "always": Appliquez immédiatement chaque fois que Auto Update s'exécute
• "onlyDownload": Vérifiez et téléchargez automatiquement, émettez updateAvailable, et n'acceptez 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.

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 surplombera le canal par défaut défini dans le cloud, mais respectera toujours les surdéfinitions effectuées 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 : "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é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 cryptage de mise à jour en direct 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

Configurez le nombre de millisecondes que le plugin natif devrait attendre avant de considérer API comme un temps d'attente.

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 mises à jour des statistiques.

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 mises à 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 valeur 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 native de 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 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'application web de __CAPGO_KEEP_0__ Capgo web app Page d'édition