Settings

Pour avoir un contrôle plus précis sur le système de mise à jour, vous pouvez le configurer avec ces paramètres :

`allowModifyUrl`

Autorisez le plugin à modifier dynamiquement updateUrl, statsUrl et channelUrl du côté JavaScript.

Disponible sur Android, iOS et Electron.

Par défaut : false

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

`appId`

Configurez l’identifiant de l’application dans la configuration.

Disponible sur Android, iOS et Electron.

Par défaut : undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

`appReadyTimeout`

Configurez le nombre de millisecondes que le plugin natif doit attendre avant de considérer une mise à jour comme « échouée ».

Disponible sur Android, iOS et Electron.

Par défaut : 10000 (10 secondes)

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

`autoDeleteFailed`

Configurez si le plugin doit automatiquement supprimer les bundles défaillants.

Disponible sur Android, iOS et Electron.

Par défaut : true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

`autoDeletePrevious`

Configurez si le plugin doit automatiquement supprimer les bundles précédents après une mise à jour réussie.

Disponible sur Android, iOS et Electron.

Par défaut : true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

`autoSplashscreen`

Gérez automatiquement le masquage de l’écran de démarrage lors de l’utilisation de directUpdate. Lorsqu’il est activé, le plugin masquera automatiquement l’écran de démarrage une fois les mises à jour appliquées ou lorsqu’aucune mise à jour n’est nécessaire. Cela supprime le besoin d’écouter manuellement les événements appReady et d’appeler SplashScreen.hide(). Fonctionne uniquement lorsque directUpdate est défini sur “atInstall”, “always” ou true. Nécessite que le plugin @capacitor/splash-screen soit installé et configuré avec launchAutoHide : false. Nécessite l’activation d’autoUpdate et de directUpdate.

Disponible sur Android, iOS et Electron.

Par défaut : false

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

`autoUpdate`

Configurez si le plugin doit utiliser la mise à jour automatique via un serveur de mise à jour.

Disponible sur Android, iOS et Electron.

Par défaut : true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

`channelUrl`

Configurez l’URL/le point de terminaison pour les opérations de canal.

Disponible sur Android, iOS et Electron.

Par défaut : https://plugin.capgo.app/channel_self

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

`defaultChannel`

Définissez le canal par défaut pour l’application dans la configuration. Sensible aux majuscules et minuscules. Ce paramètre 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

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

`directUpdate`

Configurez quand le plugin doit diriger l’installation des mises à jour. Uniquement pour le mode autoUpdate. Fonctionne bien pour les applications de moins de 10 Mo et avec les téléchargements effectués à l’aide de l’indicateur —delta. Les fichiers Zip ou applications de plus de 10 Mo seront relativement lents à mettre à jour pour les utilisateurs.> Configurez le CLI pour utiliser une API locale pour les tests.

Par défaut : undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

`localApiFiles`

Configurez le CLI pour utiliser une API de fichier local pour les tests.

Par défaut : undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

`localHost`

Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.

Par défaut : undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

`localSupa`

Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.

Par défaut : undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

`localSupaAnon`

Configurez le CLI pour utiliser un serveur local pour les tests.

Par défaut : undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

`localWebHost`

Configurez le CLI pour utiliser un serveur local pour les tests ou un serveur de mise à jour auto-hébergé.

Par défaut : undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}