Prise en main

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil d'IA en utilisant la commande suivante :

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Ensuite, utilisez la prompt suivante :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-updater` plugin in my project.

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

npm

bun add @capgo/capacitor-updater
bunx cap sync

yarn

yarn add @capgo/capacitor-updater
bunx cap sync

pnpm

pnpm add @capgo/capacitor-updater
bunx cap sync

bun

bun add @capgo/capacitor-updater
bunx cap sync

Quick Start

Pour la plupart des utilisateurs, nous recommandons de suivre le guide de démarrage principal qui couvre à la fois l'installation du plugin et __CAPGO_KEEP_0__ l'intégration cloud. which covers both the plugin installation and Capgo cloud integration.

Aperçu

Section intitulée « Aperçu »

The Capacitor Updater plugin enables over-the-air (OTA) updates for your Capacitor applications. This allows you to push updates to your app without going through app store reviews.

Section intitulée « Comment ça marche »

1. Section intitulée « Download du Bundle »: Le plugin télécharge les lots d'actualisation (fichiers ZIP contenant vos actifs web)
2. Extraction: Les lots sont extraits sur le stockage du dispositif
3. Hot Reload: L'application passe au nouveau lot sans nécessiter un redémarrage
4. Fallback: Si une mise à jour échoue, l'application revient à la version fonctionnelle précédente

Modes d'utilisation

1. Mode d'actualisation automatique (Recommandé)

La méthode la plus simple pour utiliser le plugin avec une gestion automatique des mises à jour :

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Plugin handles everything automatically
// Configure in capacitor.config.ts

Ajouter à votre capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-update-server.com/api/updates'
    }
  }
}

2. Mode manuel

Pour un contrôl’avancé du processus d'actualisation :

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Download an update
const bundle = await CapacitorUpdater.download({
  url: 'https://your-server.com/updates/v1.0.1.zip',
  version: '1.0.1'
});

// Set the bundle (will be used on next app start)
await CapacitorUpdater.set({
  id: bundle.id
});

// Or reload immediately
await CapacitorUpdater.reload();

Configuration de la plateforme

iOS

Aucune configuration supplémentaire requise. Le plugin fonctionne directement.

Android

Aucune configuration supplémentaire requise. Le plugin fonctionne directement.

Utilisation de base API

Télécharger une mise à jour

import { CapacitorUpdater } from '@capgo/capacitor-updater';

const bundle = await CapacitorUpdater.download({
  url: 'https://example.com/update.zip',
  version: '1.0.1'
});

console.log('Downloaded bundle:', bundle.id);

Définir le bundle actif

// Set bundle to be used on next app start
await CapacitorUpdater.set({
  id: bundle.id
});

Recharger avec le nouveau bundle

// Reload app immediately with new bundle
await CapacitorUpdater.reload();

Lister les paquets

const { bundles } = await CapacitorUpdater.list();
console.log('Available bundles:', bundles);

Supprimer un paquet

await CapacitorUpdater.delete({
  id: 'bundle-id'
});

Obtenir le paquet actuel

const { bundle } = await CapacitorUpdater.current();
console.log('Current bundle:', bundle.version);

Listeurs d'événements

Écoutez les événements de mise à jour :

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Listen for download progress
CapacitorUpdater.addListener('download', (info) => {
  console.log('Download progress:', info.percent);
});

// Listen for download completion
CapacitorUpdater.addListener('downloadComplete', (bundle) => {
  console.log('Download complete:', bundle.version);
});

// Listen for update failures
CapacitorUpdater.addListener('updateFailed', (error) => {
  console.error('Update failed:', error);
});

// Listen for successful updates
CapacitorUpdater.addListener('updateAvailable', (info) => {
  console.log('Update available:', info.version);
});

Options de configuration

Configurez le plugin dans votre capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      // Auto-update settings
      autoUpdate: 'atBackground',
      updateUrl: 'https://api.example.com/updates',

      // Update behavior
      resetWhenUpdate: true,

      // Version settings
      version: '1.0.0',

      // Security
      allowModifyUrl: false,

      // Stats collection
      statsUrl: 'https://api.example.com/stats',

      // Channel (for Capgo cloud)
      defaultChannel: 'production'
    }
  }
}

Modèles d'intégration

Avec Capgo Cloud

La manière la plus simple de commencer :

// Install the Capgo CLI
bun add -g @capgo/cli

// Login to Capgo
npx @capgo/cli login

// Upload your first bundle
npx @capgo/cli bundle upload

// The plugin auto-updates from Capgo cloud

Voir le guide de démarrage rapide principal pour plus de détails.

Mises à jour auto-hébergées

Héberger votre propre serveur de mise à jour :

// Configure your update endpoint
{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-server.com/api/check-update'
    }
  }
}

Votre serveur doit retourner :

{
  "version": "1.0.1",
  "url": "https://your-server.com/updates/1.0.1.zip"
}

Voir Mode auto-hébergé pour plus de détails.

Flux de mise à jour manuelle

Contrôle complet sur les mises à jour :

import { CapacitorUpdater } from '@capgo/capacitor-updater';

async function checkAndUpdate() {
  // Check for updates from your server
  const response = await fetch('https://api.example.com/check-update');
  const { version, url } = await response.json();

  // Download the update
  const bundle = await CapacitorUpdater.download({
    url,
    version
  });

  // Notify bundle is ready
  await CapacitorUpdater.notifyAppReady();

  // Set as next version
  await CapacitorUpdater.set({ id: bundle.id });

  // Reload when ready
  await CapacitorUpdater.reload();
}

Meilleures pratiques

• Appeler toujours notifyAppReady() lorsque votre application se charge avec succès
• Tester les mises à jour soigneusement avant de les déployer en production
• Implémenter un traitement d'erreur approprié pour les échecs de réseau
• Utiliser des numéros de version de manière cohérente
• Conservez les tailles des bundles pour des téléchargements plus rapides
• Surveillez les taux de réussite des mises à jour

Étapes suivantes

• Plugin API Reference Référence du plugin API
• - Documentation complète du __CAPGO_KEEP_0__ Paramètres du plugin
• - Toutes les options de configuration Événements
• - Événements de mise à jour disponibles Mode auto-hébergé (Self-Hosted Mode) - Exécutez votre propre serveur de mise à jour
• Développement local - Tester les mises à jour localement
• Débogage - Guide de dépannage

Aide

• Section intitulée « Aide » Problèmes connus
• GitHub Discussions __CAPGO_KEEP_0__ Discussions
• - Support communautaire Discord (French translation of Discord, not translated as per your request to preserve brand names and literal tokens.) - Chat en temps réel

Continuez de l'interface d'accueil

Si vous utilisez Interface d'accueil pour planifier le travail de plugin natif, connectez-l’à Utilisation de @capgo/capacitor-mises-à-jour pour la capacité native dans Utilisation de @capgo/capacitor-mises-à-jours Répertoire de plugins Capgo pour le flux de travail du produit dans Répertoire de plugins Capgo Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans l'ajout ou la mise à jour des plugins, et Alternatives de plugins Ionic Enterprise pour le flux de travail du produit dans Alternatives de plugins Ionic Enterprise.