Avvio

Installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo sistema operativo qui sotto:

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

Avvio Rapido

Per la maggior parte degli utenti, consigliamo di seguire il guida principale Avvio Rapido che copre sia l'installazione del plugin che l'integrazione con il cloud Capgo.

questa guida di avvio si concentra sui dettagli tecnici del plugin per gli utenti avanzati che desiderano comprendere i meccanismi sottostanti o implementare aggiornamenti self-hosted.

Panoramica

L'aggiornamento Capacitor plugin consente gli aggiornamenti over-the-air (OTA) per le tue applicazioni Capacitor.

questo ti consente di inviare aggiornamenti al tuo app senza dover passare dalle recensioni delle store app.

1. Sezione intitolata “Come Funziona”: Il plugin scarica gli aggiornamenti dei bundle (file ZIP che contengono i tuoi asset web)
2. Estrazione: I bundle vengono estratti nel storage del dispositivo
3. Hot Reload: L'app si aggiorna al nuovo bundle senza richiedere un riavvio
4. Fallback: Se un aggiornamento fallisce, l'app si ripristina alla versione precedente funzionante

Modalità di utilizzo

1. Modalità di aggiornamento automatico (Consigliata)

La modalità più semplice per utilizzare il plugin con la gestione automatica degli aggiornamenti:

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

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

Aggiungi al tuo capacitor.config.ts:

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

2. Modalità manuale

Per un controllo avanzato del processo di aggiornamento:

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();

Configurazione della piattaforma

iOS

Non è richiesta alcuna configurazione aggiuntiva. Il plugin funziona senza bisogno di ulteriori impostazioni.

Android

Non è richiesta alcuna configurazione aggiuntiva. Il plugin funziona subito.

Utilizzo base API

Scarica un aggiornamento

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);

Seleziona bundle attivo

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

Carica nuovamente con bundle nuovo

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

Elenco Pacchetti

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

Elimina un Pacchetto

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

Ottieni Pacchetto Corrente

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

Ascoltatori di Eventi

Ascolta gli eventi di aggiornamento:

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);
});

Opzioni di configurazione

Configura il plugin nei tuoi 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'
    }
  }
}

Pattini di integrazione

Con Capgo Cloud

La via più facile per iniziare:

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

Vedi il guida di avvio rapido principale per i dettagli.

Aggiornamenti Auto-Hosted

Ospita il tuo server di aggiornamento:

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

Il tuo server dovrebbe restituire:

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

Vedi Modalità Auto-Hosted per ulteriori dettagli.

Flusso di Aggiornamento Manuale

Controllo completo sugli aggiornamenti:

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();
}

Pratiche Consigliate

• Chiamare sempre notifyAppReady() quando il tuo'app si carica con successo
• Testare gli aggiornamenti attentamente prima di pubblicarli in produzione
• Implementare un corretto gestione degli errori per le fallite di rete
• Utilizzare i numeri di versione in modo coerente
• Tenere piccole dimensioni i pacchetti per scaricamenti più veloci
• Monitorare i tassi di successo degli aggiornamenti

Passaggi successivi

• Riferimento al plugin API - Documentazione completa del API
• Impostazioni del plugin - Tutte le opzioni di configurazione
• Eventi - Aggiornamenti disponibili
• Modalità Auto-Hosted - Esegui il tuo server di aggiornamento
• Developamento Locale - Testare aggiornamenti localmente
• Debugging - Guida di risoluzione dei problemi

Sostegno

• Sostegno Sostegno
• GitHub Discussions - Problemi comuni e soluzioni
• __CAPGO_KEEP_0__ Discussioni - Supporto della community

Continua da Inizia

Se stai utilizzando Inizia per pianificare il lavoro di plugin nativo, connettilo con Utilizzando @capgo/capacitor-aggiornatore per la capacità nativa in Utilizzando @capgo/capacitor-aggiornatore, Capgo Directory dei Plugin per il flusso di lavoro del prodotto in Capgo Directory dei Plugin, Capacitor Plugin da Capgo per la dettaglio di implementazione in Capacitor Plugin da Capgo, Aggiungere o Aggiornare i Plugin per i dettagli di implementazione in Aggiungere o Aggiornare Plugin, e Alternative per Plugin Enterprise Ionic per il flusso di lavoro del prodotto in Alternative per Plugin Enterprise Ionic.