Getting Started

Installazione

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo abilità al tuo strumento di AI utilizzando il seguente comando:

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

Usa poi 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 l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

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 di avvio rapido principale che copre sia l'installazione del plugin che Capgo l'integrazione cloud.

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

The Capacitor Aggiornatore plugin consente gli aggiornamenti in tempo reale (OTA) per le tue Capacitor applicazioni. Ciò ti consente di inviare aggiornamenti al tuo app senza dover passare attraverso le recensioni delle app store.

Come Funziona

1. Download Pacchetto: Il plugin scarica i pacchetti di aggiornamento (file ZIP contenenti i tuoi asset web)
2. Estrazione: I pacchetti vengono estratti nel storage del dispositivo
3. Hot Reload: L'app si sposta sul nuovo pacchetto 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)

Il modo 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 sul 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 subito.

Android

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

Utilizzo base API

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

Imposta 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 bundle

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

Elimina un bundle

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

Esegui il Bundle corrente

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

Ascolta gli 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 nel tuo 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'
    }
  }
}

Modelli 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 proprio 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 Migliorative

• Chiamare sempre notifyAppReady() When il tuo app carica con successo
• Testa attentamente le aggiornamenti prima di pubblicarli in produzione
• Implementa un corretto trattamento degli errori per le fallite di rete
• Utilizza numeri di versione coerenti
• Mantieni i pacchetti di bundle piccoli per download più veloci
• Monitora le tassi di successo degli aggiornamenti

Passaggi successivi

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

Sostegno

• Issue Noti - Problemi comuni e soluzioni
• GitHub Discussions - Supporto comunitario
• Discord - Chat in tempo reale

Continua da Getting Started

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