Référence de l'actualisation d'Electron API

Cette page documente toutes les méthodes, les événements et les options de configuration disponibles pour l'actualiseur Electron.

Méthodes de base

notifyAppReady()

Doit être appelée à chaque lancement de l'application. Confirme que le bundle a été chargé avec succès et empêche le roulback automatique.

await updater.notifyAppReady();

Attention

Si ce n'est pas appelé dans appReadyTimeout (par défaut 10 secondes), la mise à jour est considérée comme échouée et l'application revient à la version précédente.

télécharger(options)

Télécharger un bundle à partir d'une URL.

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

Paramètres :

Option	Type	Requis	Description
url	chaîne de caractères	Oui	URL pour télécharger le bundle
version	chaîne de caractères	Oui	Identifiant de version pour le bundle
checksum	chaîne de caractères	Non	Checksum SHA256 pour la vérification
sessionKey	chaîne de caractères	Non	Clé de session pour les ensembles chiffrés

Retourne : BundleInfo objet avec id, version, status

next(options)

File d'attente un bundle pour qu'il soit chargé à la prochaine redémarrage de l'application.

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

Paramètres :

Option	Type	Obligatoire	Description
id	chaîne	Oui	ID de l'application à ajouter à la file d'attente

set(options)

Passer immédiatement à une application et recharger l'application.

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

Paramètres :

Option	Type	Obligatoire	Description
id	chaîne	Oui	ID de l'application pour l'activation

__CAPGO_KEEP_0__

Recharger manuellement l'application avec le bundle actuel.

await updater.reload();

__CAPGO_KEEP_0__(options)

Supprimer un bundle du stockage.

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

Paramètres :

Option	Type	Obligatoire	Description
id	chaîne	Oui	Identifiant de bundle à supprimer

reset(options)

Réinitialiser à la version par défaut ou la dernière bundle réussie.

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

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

Paramètres :

Option	Type	Obligatoire	Description
toLastSuccessful	boolean	Non	Si vrai, réinitialisez à la dernière bundle réussie au lieu de la valeur par défaut

Informations sur le Bundle

current()

Obtenez des informations sur le bundle actuel et la version native.

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

list(options)

Listez tous les bundles téléchargés.

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

getNextBundle()

Obtenez le bundle programmé pour la prochaine redémarrage.

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

getFailedUpdate()

Obtenez des informations sur la dernière mise à jour échouée (utile pour le débogage des retours en arrière).

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

getBuiltinVersion()

Obtenez la version embarquée avec le fichier binaire de l'application.

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

Vérification des mises à jour

getLatest(options)

Vérifiez le serveur pour la dernière version disponible.

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

Renvoie :

Propriété	Type	Description
url	chaîne	URL de téléchargement (vide si aucune mise à jour)
version	chaîne	Version disponible
checksum	chaîne	Checksum SHA256
sessionKey	chaîne	Clé de session de cryptage
error	string	Message d'erreur si la vérification a échoué
message	string	Message du serveur

Gestion des canaux

setChannel(options)

Attribuer le dispositif à un canal spécifique.

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

unsetChannel(options)

Supprimer l'affectation de canal et utiliser la valeur par défaut.

await updater.unsetChannel();

getChannel()

Obtenir la mise en page actuelle du canal.

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

listChannels()

Lister tous les canaux disponibles pour cette application.

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

Conditions de retard

Contrôle quand les mises à jour téléchargées sont appliquées.

setMultiDelay(options)

Définir les conditions qui doivent être remplies avant que l'une mise à jour soit appliquée.

// 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' }
  ]
});

Types de conditions de retard :

Type	Valeur	Description
background	Durée facultative (ms)	Attendre que l'application soit mis en arrière-plan
kill	-	Attendre que l'application soit tuée et redémarrée
date	Chaîne de date ISO	Attendez jusqu'à une date/heure spécifique
nativeVersion	Chaîne de version	Attendez la mise à jour de l'application native

__CAPGO_KEEP_0__

Supprimez toutes les conditions de retard et appliquez la mise à jour immédiatement lors du prochain contrôle.

await updater.cancelDelay();

Identification du dispositif

getDeviceId()

Obtenez l'identifiant unique du dispositif.

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

setCustomId(options)

Définir un identifiant personnalisé pour le dispositif (utile pour les analyses).

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

Configuration

setUpdateUrl(options)

Changer l'URL du serveur de mise à jour en temps réel.

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

Remarque

Exige allowModifyUrl: true dans les options du constructeur.

setStatsUrl(options)

Changer l'URL de rapport de statistiques.

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

setChannelUrl(options)

Changer l'URL de gestion de canal.

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

setAppId(options)

Changer l'ID d'application en temps de cours.

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

Remarque

Requis allowModifyAppId: true dans les options du constructeur.

getAppId()

Obtenir l'ID d'application actuel.

const appId = await updater.getAppId();

Débogage

setDebugMenu(options)

Activer ou désactiver le menu de débogage.

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

isDebugMenuEnabled()

Vérifier si le menu de débogage est activé.

const enabled = await updater.isDebugMenuEnabled();

Événements

Écoutez les événements de mise à jour en utilisant addListener:

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

Événements disponibles

Événement	Payload	Description
download	{ percent, status }	Mise à jour des progrès de téléchargement
updateAvailable	{ bundle }	Nouvelle mise à jour disponible
noNeedUpdate	{ message }	Déjà à jour
downloadComplete	{ bundle }	Téléchargement terminé avec succès
downloadFailed	{ bundle, error }	Téléchargement échoué
breakingAvailable	{ bundle }	Une mise à jour incompatibilité est disponible (exige une mise à jour native)
updateFailed	{ bundle, reason }	L'installation de la mise à jour a échoué
appReloaded	{}	L'application a été rechargée
appReady	{}	notifyAppReady() a été appelé

Exemple : Traitement complet des événements

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

Options de constructeur

Options de configuration complète pour 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)
});

Continuez depuis Electron Updater API Reference

Si vous utilisez L'actualiseur Electron API Reference pour planifier le tableau de bord et les opérations API, connectez-le à En utilisant @capgo/electron-updater pour la capacité native dans En utilisant @capgo/electron-updater, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour le détail d'implémentation dans Introduction, API Clés pour le détail d'implémentation dans API Clés, Appareils pour le détail d'implémentation dans Appareils.