Erste Schritte mit Cordova Updater

Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/cordova-updater`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/cordova-updater/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Diese Anleitung zeigt dir, wie du @capgo/cordova-updater in eine Cordova-App einbindest, um Capgo Live Updates auf iOS und Android zu erhalten.

Voraussetzungen

Cordova CLI 12+
Cordova Android 13+ und/oder Cordova iOS 7+
Ein Capgo-Konto (capgo.app/register)

Installation

Installiere das Plugin von npm und übergib deine Capgo-App-ID:

cordova plugin add @capgo/cordova-updater --variable APP_ID=YOUR_CAPGO_APP_ID

Optional: Standardwerte bei der Installation überschreiben (gleiche Variablen wie beim Capacitor-Updater):

cordova plugin add @capgo/cordova-updater \
  --variable APP_ID=YOUR_CAPGO_APP_ID \
  --variable DEFAULT_CHANNEL=production \
  --variable UPDATE_URL=https://plugin.capgo.app/updates \
  --variable AUTO_UPDATE=atBackground

Native Projekte nach dem Ändern der Plugin-Variablen vorbereiten:
Terminalfenster
```
cordova prepare android ios
```

Quickstart

document.addEventListener('deviceready', async () => {
  await cordova.plugins.Updater.notifyAppReady();
});

Häufige Stolperfallen

Verwenden Sie cordova-plugin-ionic-webview nicht mit diesem Plugin.
Rufe notifyAppReady() sobald Ihr Bundle geladen ist – bevor aufwendige UI-Arbeiten das Rollback-Zeitfenster verzögern.
Halten Sie die Cordova-Scheme-Einstellungen korrekt.

JavaScript-Nutzung

Danach deviceready, das Plugin ist verfügbar als cordova.plugins.Updater:

document.addEventListener('deviceready', async () => {
  const { Updater } = cordova.plugins;

  await Updater.notifyAppReady();

  const latest = await Updater.getLatest();
  if (latest.url && !latest.error) {
    const bundle = await Updater.download({
      url: latest.url,
      version: latest.version,
      checksum: latest.checksum,
    });

    await Updater.next({ id: bundle.id });
  }
});

TypeScript-Typen sind im npm-Paket enthalten:

import type { UpdaterPlugin } from '@capgo/cordova-updater';

declare const cordova: { plugins: { Updater: UpdaterPlugin } };

Erfordert Cordova Android 13+, damit die WebView aus dem Standard-... https://localhost/ Scheme.
Das Plugin registriert eine CordovaPluginPathHandler um heruntergeladene Bundle-Assets bereitzustellen.

Erfordert Cordova iOS 7+ mit dem Standard- app://localhost/ Scheme.
Das Plugin implementiert CDVPluginSchemeHandler um Bundle-Anfragen abzufangen.

Lade dein erstes Bundle hoch

Erstelle deine Web-Assets und lade sie dann mit dem Capgo CLI hoch (gleicher Workflow wie bei Capacitor):

bun run build
npx @capgo/cli@latest bundle upload --channel=production

Nächste Schritte

Vergleiche die Einstellungen mit Capacitor Updater-Konfiguration — die meisten Optionen entsprechen plugin.xml Variablen.
Lies Live update-Kompatibilität bevor du Änderungen an nativen Plugins auslieferst.
Willst du später auf Capacitor migrieren? Behalte dieselbe Capgo App-ID und dieselben Channels; nur das Client-Plugin-Package ändert sich.