@capgo/capacitor-updater

Disponibile anche per Cordova ed Electron

Gli aggiornamenti live di Capgo non sono limitati a Capacitor. Usa lo stesso backend e CLI con plugin client correlati:

Updater per Cordova OTA per Cordova iOS 7+ e Android 13+.

Updater per Electron Live update desktop con gli stessi API

Panoramica

@capgo/capacitor-updater che spedisce aggiornamenti del bundle JavaScript alle app Capacitor in produzione senza attendere la revisione degli store. Scarica bundle firmati in background, gestisci il rollout con i canali e le regole di delay, e fai il rollback se notifyAppReady() non viene chiamato entro il appReadyTimeout.

Casi d'uso tipici: hotfix per bug in produzione, beta graduali per canale, esperimenti UI A/B e rollback di emergenza al bundle predefinito.

Supporto piattaforme

Piattaforma	Supporto
iOS	Sì
Android	Sì
Web	I bundle si applicano al layer WebView nelle shell native, non ai siti statici ospitati

I client Cordova ed Electron utilizzano i plugin correlati sopra con lo stesso backend Capgo.

Funzionalità principali

• notifyAppReady - Notifica al layer nativo che l'inizializzazione di JavaScript è avvenuta con successo.
• setUpdateUrl - Imposta dinamicamente l'URL degli update dell'app a runtime.
• setStatsUrl - Imposta dinamicamente l'URL delle statistiche dell'app a runtime.
• setChannelUrl - Imposta dinamicamente l'URL del canale dell'app a runtime.

Pubblico API

Metodo	Descrizione
notifyAppReady	Notifica al layer nativo che l'inizializzazione di JavaScript è avvenuta con successo.
setUpdateUrl	Imposta dinamicamente l'URL degli update dell'app a runtime.
setStatsUrl	Imposta dinamicamente l'URL delle statistiche dell'app a runtime.
setChannelUrl	Imposta dinamicamente l'URL del canale dell'app a runtime.
download	Scarica un nuovo bundle dall'URL fornito per l'installazione successiva.
next	Imposta il prossimo bundle da attivare al background o al riavvio dell'app.
set	Imposta il bundle corrente e ricarica immediatamente l'app.
delete	Elimina un bundle dallo storage locale per liberare spazio su disco.
setBundleError	Segna manualmente un bundle come fallito/errato in modalità update manuale.
list	Recupera tutti i bundle scaricati localmente nella tua app.
reset	Ripristina l'app a un bundle noto e funzionante.
current	Ottieni informazioni sul bundle attualmente attivo.
reload	Ricarica manualmente l'app per applicare un update in sospeso.
setMultiDelay	Configura le condizioni da soddisfare prima di applicare un update in sospeso.
cancelDelay	Annulla tutte le condizioni di ritardo e applica subito l'update in sospeso.
getLatest	Controlla sul server di update l'ultima versione del bundle disponibile.
setChannel	Imposta un canale di aggiornamento locale per questo dispositivo. Non crea un override su dashboard o API.
unsetChannel	Rimuove l'assegnazione del canale al dispositivo e torna al canale predefinito.
getChannel	Ottieni il canale attualmente assegnato a questo dispositivo.
listChannels	Ottieni l'elenco di tutti i canali disponibili per l'auto-assegnazione su questo dispositivo.
setCustomId	Set a custom identifier for this device.
getBuiltinVersion	Ottieni la versione del bundle integrata (la versione originale inclusa nel tuo Native Build).
getDeviceId	Ottieni l'identificativo univoco e privacy-friendly per questo dispositivo.
getPluginVersion	Ottieni la versione del plugin Capacitor Updater installata nella tua app.
isAutoUpdateEnabled	Controlla se gli aggiornamenti automatici sono attualmente abilitati.
removeAllListeners	Rimuove tutti gli event listener registrati per questo plugin.
addListener	Ascolta l'evento di download del bundle nell'App. Si attiva all'inizio, durante e al termine del download, restituendo la percentuale di avanzamento.
addListener	Ascolta l'evento 'no need to update', utile se vuoi forzare il controllo ad ogni avvio dell'app.
addListener	Ascolta l'evento di aggiornamento disponibile, utile se vuoi forzare un controllo ogni volta che l'app viene avviata.
addListener	Ascolta gli eventi downloadComplete.
addListener	Ascolta gli eventi breaking update quando il backend segnala un aggiornamento incompatibile con l'app attuale. Emette lo stesso payload del vecchio majorAvailable listener.
addListener	Ascolta l'evento di Major update nell'app per sapere quando un aggiornamento importante viene bloccato impostando disableAutoUpdateBreaking.
addListener	Ascolta l'evento di errore dell'aggiornamento nell'App per sapere se l'installazione è fallita al prossimo avvio.
addListener	Ascolta l'evento set nell'app: ti avvisa quando un bundle è stato applicato con successo. L'evento è mantenuto nativamente finché JavaScript non lo consuma, quindi se l'app si ricarica prima che il listener sia collegato, l'ultimo set evento viene consegnato non appena il listener si iscrive.
addListener	Ascolta l'evento set next nell'app per sapere quando un bundle è in coda per l'installazione successiva.
addListener	Ascolta l'evento download fail nell'app: ti avvisa quando il download di un bundle è fallito.
addListener	Ascolta l'evento di reload nell'App per sapere quando è avvenuto il ricaricamento.
addListener	Ascolta l'evento app ready nell'app: ti avvisa quando l'app è pronta all'uso. L'evento è mantenuto nativamente finché JavaScript non lo consuma, quindi può ancora essere consegnato dopo un reload, anche se il listener viene collegato più tardi durante l'avvio.
addListener	Ascolta l'evento privato del canale, emesso quando si tenta di impostare un canale che non consente l'auto-assegnazione del dispositivo.
addListener	Ascolta i cambiamenti di stato degli aggiornamenti flessibili su Android.
isAutoUpdateAvailable	Verifica se la funzione di auto-update è disponibile (non disabilitata da una configurazione server personalizzata).
getNextBundle	Ottieni informazioni sul bundle in coda per l'attivazione al prossimo reload.
getFailedUpdate	Recupera informazioni sul bundle più recente che non è riuscito a caricarsi.
setShakeMenu	Abilita o disabilita il menu del gesto shake per il debug e i test.
isShakeMenuEnabled	Verifica se il menu di debug tramite gesto shake è attualmente abilitato.
setShakeChannelSelector	Abilita o disabilita a runtime il selettore di canale tramite gesto shake.
isShakeChannelSelectorEnabled	Verifica se il selettore di canale tramite gesto shake è attualmente abilitato.
getAppId	Ottieni l'App ID attualmente configurato per la comunicazione con il server di aggiornamento.
setAppId	Cambia dinamicamente l'App ID usato per la comunicazione con il server di aggiornamento.
getAppUpdateInfo	Ottieni informazioni sulla disponibilità dell'app su App Store o Play Store.
openAppStore	Apri la pagina dell'app su App Store o Play Store.
performImmediateUpdate	Esegui un aggiornamento in-app immediato su Android.
startFlexibleUpdate	Avvia un aggiornamento in-app flessibile su Android.
completeFlexibleUpdate	Completa un aggiornamento in-app flessibile su Android.

Fonte di verità

Questo riferimento è sincronizzato da src/definitions.ts nella capacitor-updater.

Continua da @capgo/capacitor-updater

Se stai usando @capgo/capacitor-updater per pianificare il lavoro sui plugin nativi, collegalo a Usando @capgo/capacitor-updater per la funzionalità nativa in Usando @capgo/capacitor-updater, Directory dei plugin di Capgo per il workflow del prodotto nella Capgo Plugin Directory, Plugin Capacitor di Capgo per i dettagli di implementazione in Capacitor Plugins di Capgo, Aggiunta o aggiornamento dei plugin per i dettagli su come aggiungere o aggiornare i plugin, e Alternative ai plugin Ionic Enterprise per il workflow del prodotto in Alternative ai plugin Ionic Enterprise.