Getting Started

Installation

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihre AI-Werkzeug hinzufügen, indem Sie den folgenden Befehl ausführen:

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

Verwenden Sie dann den folgenden Prompt:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

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

Schnellstart

Für die meisten Benutzer empfehlen wir, sich anhand des Haupt-Schnellstart-Guides zu orientieren der sowohl die Plugin-Installation als auch die Capgo-Cloud-Integration abdeckt.

Diese Anleitung für das Ersteinsatz konzentriert sich auf die technischen Plugin-Details für fortgeschrittene Benutzer, die die zugrunde liegenden Mechanismen verstehen möchten oder selbst gehostete Updates implementieren möchten.

Übersicht

Das Capacitor-Updater-Plugin ermöglicht über das Internet (OTA) Updates für Ihre Capacitor-Anwendungen. Dies ermöglicht es Ihnen, Updates an Ihre App zu pushen, ohne durch App-Store-Überprüfungen gehen zu müssen.

Wie es funktioniert

1. Bundle-DownloadDas Plugin lädt Update-Bundles (ZIP-Dateien, die Ihre Web-Assets enthalten) herunter.
2. ExtraktionBundles werden auf das Gerätespeicher extrahiert.
3. Hot ReloadDie App switcht auf das neue Bundle, ohne dass ein Neustart erforderlich ist.
4. FallbackWenn ein Update fehlschlägt, kehrt die App zur vorherigen funktionierenden Version zurück

Verwendungsmöglichkeiten

1. Automatischer Update-Modus (Empfohlen)

Der einfachste Weg, den Plugin mit automatischer Update-Verwaltung zu verwenden:

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

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

Fügen Sie Ihrem capacitor.config.ts:

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

2. Manueller Modus

Für eine erweiterte Kontrolle über den Updateprozess:

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

Plattform-Konfiguration

iOS

Keine weitere Konfiguration erforderlich. Der Plugin funktioniert direkt aus der Box.

Android

Keine weitere Konfiguration erforderlich. Der Plugin funktioniert direkt aus der Box.

Grundlegende API Verwendung

Download eine Aktualisierung

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

Aktives Bundle setzen

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

Mit neuem Bundle neu laden

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

Bundles auflisten

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

Ein Bundle löschen

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

Aktuelles Bundle abrufen

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

Ereignis-Listener

Bei Update-Ereignissen zuhören:

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

Konfigurationsoptionen

Konfigurieren Sie das Plugin in Ihrem 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'
    }
  }
}

Integration Muster

Mit Capgo Cloud

Der einfachste Weg, loszulegen:

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

Siehe das Haupt Quickstart-Leitfaden für Details.

Selbst gehostete Updates

Ihre eigenen Update-Server hosten:

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

Ihr Server sollte folgendes zurückgeben:

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

Ansehen Eigenständiger Modus für weitere Details.

Manueller Update-Flow

Vollständige Kontrolle über Updates:

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

Best Practices

• Rufen Sie immer auf notifyAppReady() wenn Ihre App erfolgreich geladen wird
• Testen Sie Updates gründlich, bevor Sie sie in die Produktion pusht
• Implementieren Sie eine ordnungsgemäße Fehlerbehandlung für Netzwerkfehler
• Verwenden Sie Versionsnummern konsistent
• Halten Sie die Größe der Pakete klein, um die Herunterladegeschwindigkeit zu erhöhen
• Überwachen Sie die Erfolgsraten von Updates

Next Steps

• Plugin API Referenz - Vollständige API Dokumentation
• Plugin-Einstellungen - Alle Konfigurationsoptionen
• Events - Verfügbare Update-Ereignisse
• Selbstgeführter Modus - Führen Sie Ihren eigenen Update-Server aus
• Lokale Entwicklung - Testen Sie Updates lokal
• Fehlersuche - Fehlersuchleitfaden

Support

• Bekannte Probleme - Gemeinsame Probleme und Lösungen
• GitHub Diskussionen - Gemeinschaftsunterstützung
• Discord - Echtzeit-Chat

Weitermachen von Getting Started

Wenn Sie native Plugin-Arbeit planen, verbinden Sie es mit Getting Started zur Planung von native Plugin-Arbeit Mit @capgo/capacitor-Updater für die native Fähigkeit in Mit @capgo/capacitor-Updater, Capgo-Plugin-Verzeichnis für den Produktworkflow in Capgo-Plugin-Verzeichnis, Capacitor-Plugins von Capgo für die Implementierungsdetail in Capacitor-Plugins von Capgo, Plugins hinzufügen oder aktualisieren für die Implementierungsdetail in Plugins hinzufügen oder aktualisieren, und Ionic Enterprise-Plugin-Alternativen für den Produktworkflow in Ionic Enterprise-Plugin-Alternativen.