Electron Updater API Referenz

Diese Seite dokumentiert alle verfügbaren Methoden, Ereignisse und Konfigurationsoptionen für den Electron Updater.

Kernmethoden

notifyAppReady()

Bei jedem App-Start aufzurufen. Bestätigt, dass die Bundle erfolgreich geladen wurden und verhindert automatische Rückschritte.

await updater.notifyAppReady();

Vorsicht

Wenn nicht innerhalb von appReadyTimeout (Standard 10 Sekunden), wird die Aktualisierung als fehlgeschlagen betrachtet und die App wird auf die vorherige Version zurückgerollt.

download(options)

Ein Bundle von einer URL herunterladen.

const bundle = await updater.download({
  url: 'https://example.com/bundle.zip',
  version: '1.0.1',
  checksum: 'sha256-hash', // Optional but recommended
  sessionKey: '...', // For encrypted bundles
});

Parameter:

Option	Typ	Erforderlich	Beschreibung
url	string	Ja	URL, von der das Bundle heruntergeladen werden soll
version	string	Ja	Versionen-Bezeichner für das Bundle
checksum	string	Nein	SHA256-Prüfsumme zur Verifizierung
sessionKey	string	Nein	Sitzungschlüssel für verschlüsselte Bundle

Rückgabewert: BundleInfo Objekt mit id, version, status

next(options)

Eine Bundle-Queue wird auf das nächste App-Neustart geladen.

await updater.next({ id: 'bundle-id' });

Parameter:

Option	Typ	Erforderlich	Beschreibung
id	string	Ja	Bundle-ID zur Queue

set(options)

Schnell zu einem Bundle wechseln und die App neu laden.

await updater.set({ id: 'bundle-id' });

Parameter:

Option	Typ	Erforderlich	Beschreibung
id	string	Ja	Bundle-ID zum Aktivieren

reload()

Manuell die App mit der aktuellen Bundle neu laden.

await updater.reload();

delete(options)

Ein Bundle aus dem Speicher löschen.

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

Parameter:

Option	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Bundle-ID zum Löschen

reset(options)

Zurücksetzen auf die Standardversion oder die letzte erfolgreiche Bundle.

// Reset to builtin
await updater.reset({ toLastSuccessful: false });

// Reset to last successful bundle
await updater.reset({ toLastSuccessful: true });

Parameter:

Option	Typ	Erforderlich	Beschreibung
toLastSuccessful	boolean	Nein	Wenn wahr, zurücksetzen Sie auf die letzte erfolgreiche Bundle anstatt auf das Builtin

Bundle Informationen

aktuell()

Ermitteln Sie Informationen über das aktuelle Bundle und die native Version.

const info = await updater.current();
// { bundle: { id, version, status }, native: '1.0.0' }

list(options)

Listen Sie alle heruntergeladenen Bundles auf.

const bundles = await updater.list();
// [{ id, version, status, downloaded, checksum }, ...]

getNextBundle()

Holen Sie sich die für das nächste Neustart-Queue bereitgestellte Bundle.

const next = await updater.getNextBundle();
// { id, version, status } or null

getFailedUpdate()

Holen Sie sich Informationen über die letzte fehlgeschlagene Aktualisierung (wirksam für Debugging von Rollover).

const failed = await updater.getFailedUpdate();
// { id, version, reason } or null

getBuiltinVersion()

Holen Sie sich die mit der App-Binary gelieferte Version.

const version = await updater.getBuiltinVersion();
// '1.0.0'

Aktualisierungsprüfung

getLatest(options)

Überprüfe den Server auf die neueste verfügbare Version.

const latest = await updater.getLatest();

if (latest.url && !latest.error) {
  // Update available
  console.log('New version:', latest.version);
  console.log('Download URL:', latest.url);
} else if (latest.error) {
  console.error('Error checking updates:', latest.error);
}

Rückgabewert:

Eigenschaft	Typ	Beschreibung
url	string	Herunterladungs-URL (leer, wenn keine Aktualisierung)
version	ZielSprache	Verfügbare Version
checksum	__CAPGO_KEEP_0__	SHA256-Prüfsumme
sessionKey	__CAPGO_KEEP_0__	Verschlüsselungssitzungsschlüssel
error	__CAPGO_KEEP_0__	Fehlermeldung bei fehlgeschlagener Überprüfung
message	Servernachricht	Kanalverwaltung

Abschnitt "Kanalverwaltung"

setChannel(options)

Zuweisen Sie das Gerät einer bestimmten Kanal.

await updater.setChannel({ channel: 'beta' });

unsetChannel(options)

Kanalzuweisung aufheben und Standard verwenden.

await updater.unsetChannel();

getChannel()

Ermitteln Sie die aktuelle Kanalzuweisung.

const channel = await updater.getChannel();
// { channel: 'production', status: 'set' }

listChannels()

Liste aller verfügbaren Kanäle für diese App.

const channels = await updater.listChannels();
// ['production', 'beta', 'staging']

Zögerungsbedingungen

Bestimmen Sie, wann heruntergeladene Updates angewendet werden.

setMultiDelay(options)

Legen Sie Bedingungen fest, die erfüllt sein müssen, bevor ein Update angewendet wird.

// Wait for app to be backgrounded
await updater.setMultiDelay({
  delayConditions: [{ kind: 'background' }]
});

// Wait until specific date
await updater.setMultiDelay({
  delayConditions: [{ kind: 'date', value: '2024-12-25T00:00:00Z' }]
});

// Wait for app to be killed and restarted
await updater.setMultiDelay({
  delayConditions: [{ kind: 'kill' }]
});

// Multiple conditions (all must be met)
await updater.setMultiDelay({
  delayConditions: [
    { kind: 'background' },
    { kind: 'date', value: '2024-12-25T00:00:00Z' }
  ]
});

Zögerungsbedingungstypen:

Art	Wert	Beschreibung
background	Optional Dauer (ms)	Warten, bis die App in den Hintergrund geschoben wird
kill	-	Warten, bis die App beendet und neu gestartet wird
date	ISO-Datumszeichenfolge	Warten, bis eine bestimmte Uhrzeit erreicht ist
nativeVersion	Versionszeichenfolge	Warten, bis eine native App aktualisiert wird

__CAPGO_KEEP_0__

Alle Verzögerungsbedingungen löschen und Update sofort auf nächsten Check anwenden.

await updater.cancelDelay();

Geräteidentifikation

getDeviceId()

Ermitteln Sie die eindeutige Geräteidentifikation.

const deviceId = await updater.getDeviceId();
// 'uuid-xxxx-xxxx-xxxx'

setCustomId(options)

Setzen Sie einen benutzerdefinierten Identifikator für das Gerät (nützlich für Analysen).

await updater.setCustomId({ customId: 'user-123' });

Konfiguration

setUpdateUrl(options)

Die Update-Server-URL ändern Sie während der Ausführung.

await updater.setUpdateUrl({ url: 'https://my-server.com/updates' });

Hinweis

Erforderlich allowModifyUrl: true in den Konstruktor-Optionen.

setStatsUrl(options)

Ändern Sie die URL für die Statistikberichterstattung.

await updater.setStatsUrl({ url: 'https://my-server.com/stats' });

setChannelUrl(options)

Ändern Sie die URL für den Kanalmanagement.

await updater.setChannelUrl({ url: 'https://my-server.com/channel' });

setAppId(options)

Ändern Sie den App-ID während der Ausführung.

await updater.setAppId({ appId: 'com.example.newapp' });

Hinweis

Benötigt allowModifyAppId: true in den Konstruktoroptionen.

getAppId()

Aktuellen App-Id abrufen.

const appId = await updater.getAppId();

Debug

setDebugMenu(options)

Festlegen oder deaktivieren Sie das Debug-Menü.

await updater.setDebugMenu({ enabled: true });

isDebugMenuEnabled()

Überprüfen Sie, ob das Debug-Menü aktiviert ist.

const enabled = await updater.isDebugMenuEnabled();

Events

Hören Sie mit dem Update-Ereignis über addListener:

updater.addListener('eventName', (event) => {
  // Handle event
});

Verfügbare Events

Ereignis	Payload	Beschreibung
download	{ percent, status }	Download-Fortschritzanzeige
updateAvailable	{ bundle }	Neue Aktualisierung verfügbar
noNeedUpdate	{ message }	Aktuell auf dem neuesten Stand
downloadComplete	{ bundle }	Herunterladen erfolgreich abgeschlossen
downloadFailed	{ bundle, error }	Herunterladen fehlgeschlagen
breakingAvailable	{ bundle }	Inkompatible Aktualisierung verfügbar (erfordert native Aktualisierung)
updateFailed	{ bundle, reason }	Aktualisierungsinstallation fehlgeschlagen
appReloaded	{}	App wurde neu geladen
appReady	{}	notifyAppReady() wurde aufgerufen

Beispiel: Vollständige Ereignisbearbeitung

// Progress tracking
updater.addListener('download', (event) => {
  updateProgressBar(event.percent);
});

// Update available notification
updater.addListener('updateAvailable', (event) => {
  showNotification(`Update ${event.bundle.version} available!`);
});

// Handle completion
updater.addListener('downloadComplete', async (event) => {
  // Queue for next restart
  await updater.next({ id: event.bundle.id });
  showNotification('Update will apply on next restart');
});

// Handle failures
updater.addListener('updateFailed', (event) => {
  console.error('Update failed:', event.reason);
  reportError(event);
});

Konstruktor-Optionen

Vollständige Konfigurationsmöglichkeiten für ElectronUpdater:

const updater = new ElectronUpdater({
  // Required
  appId: 'com.example.app',

  // Version override
  version: '1.0.0', // Override builtin version detection

  // Server URLs
  updateUrl: 'https://plugin.capgo.app/updates',
  channelUrl: 'https://plugin.capgo.app/channel_self',
  statsUrl: 'https://plugin.capgo.app/stats',

  // Behavior
  autoUpdate: true,           // Enable automatic update checks
  appReadyTimeout: 10000,     // Milliseconds before rollback (default: 10000)
  autoDeleteFailed: true,     // Auto-delete failed bundles
  autoDeletePrevious: true,   // Auto-delete old bundles
  resetWhenUpdate: true,      // Reset to builtin on native update

  // Channels
  defaultChannel: 'production',

  // Direct Update Mode
  directUpdate: false,        // 'atInstall' | 'onLaunch' | 'always' | false

  // Security
  publicKey: '...',           // RSA public key for E2E encryption

  // Dynamic Configuration
  allowModifyUrl: false,      // Allow runtime URL changes
  allowModifyAppId: false,    // Allow runtime App ID changes
  persistCustomId: false,     // Persist custom ID across updates
  persistModifyUrl: false,    // Persist URL changes

  // Debug
  debugMenu: false,           // Enable debug menu (Ctrl+Shift+D)
  disableJSLogging: false,    // Disable console logs

  // Periodic Updates
  periodCheckDelay: 0,        // Seconds between auto-checks (0 = disabled, min 600)
});

Weitermachen von Electron Updater API Referenz

Wenn Sie Electron Updater __CAPGO_KEEP_0__ Referenz zum Planen von Dashboard und API-Operationen verwenden, verbinden Sie es mit Mit @API/electron-updater für die native Fähigkeit in Mit @capgo/electron-updater, for the native capability in Using @capgo/electron-updater, API Übersicht für die Implementierungsdetails in API Übersicht Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.