@capgo/capacitor-updater

Tersedia juga untuk Cordova dan Electron

Capgo live updates tidak terbatas pada Capacitor. Gunakan backend dan CLI yang sama dengan plugin klien pendamping:

Updater Cordova OTA untuk Cordova iOS 7+ dan Android 13+.

Updater Electron Live update desktop dengan API yang sama.

Ikhtisar

@capgo/capacitor-updater merilis Update bundle JavaScript ke aplikasi produksi Capacitor tanpa menunggu review store. Download bundle yang ditandatangani di background, atur rollout dengan channel dan aturan delay, serta rollback jika notifyAppReady() tidak dipanggil dalam waktu yang dikonfigurasi appReadyTimeout.

Penggunaan umum: hotfix bug produksi, beta bertahap per channel, eksperimen UI A/B, dan rollback darurat ke bundle bawaan.

Dukungan platform

Platform	Dukungan
iOS	Ya
Android	Ya
Web	Bundle berlaku pada layer WebView di shell native, bukan pada situs statis yang di-host

Client Cordova dan Electron memakai plugin sejenis yang ditautkan di atas dengan backend Capgo yang sama.

Kemampuan Utama

• notifyAppReady - Beri tahu native layer bahwa JavaScript berhasil diinisialisasi.
• setUpdateUrl - Atur URL update aplikasi secara dinamis saat runtime.
• setStatsUrl - Atur URL statistik aplikasi secara dinamis saat runtime.
• setChannelUrl - Atur URL channel aplikasi secara dinamis saat runtime.

API Publik

Metode	Deskripsi
notifyAppReady	Beri tahu native layer bahwa JavaScript berhasil diinisialisasi.
setUpdateUrl	Atur URL update aplikasi secara dinamis saat runtime.
setStatsUrl	Atur URL statistik aplikasi secara dinamis saat runtime.
setChannelUrl	Atur URL channel aplikasi secara dinamis saat runtime.
download	Download bundle baru dari URL yang diberikan untuk diinstal nanti.
next	Atur bundle berikutnya agar diaktifkan saat app masuk background atau restart.
set	Atur bundle saat ini dan langsung reload app.
delete	Hapus bundle dari penyimpanan lokal untuk membebaskan ruang disk.
setBundleError	Tandai bundle sebagai gagal/error secara manual dalam mode update manual.
list	Ambil semua bundle yang di-download secara lokal dan tersimpan di app.
reset	Reset app ke bundle yang diketahui berfungsi baik.
current	Dapatkan info tentang bundle yang sedang aktif.
reload	Reload app secara manual untuk menerapkan update yang tertunda.
setMultiDelay	Konfigurasi kondisi yang harus terpenuhi sebelum update yang tertunda diterapkan.
cancelDelay	Batalkan semua kondisi delay dan segera terapkan update yang tertunda.
getLatest	Cek server update untuk versi bundle terbaru yang tersedia.
setChannel	Atur channel update runtime lokal untuk perangkat ini. Ini tidak membuat device override di dashboard/API.
unsetChannel	Hapus penetapan channel perangkat ini dan kembali ke channel default.
getChannel	Dapatkan channel yang saat ini ditetapkan untuk perangkat ini.
listChannels	Dapatkan daftar semua channel yang tersedia untuk di-assign sendiri oleh perangkat ini.
setCustomId	Atur custom identifier untuk perangkat ini.
getBuiltinVersion	Dapatkan versi bundle bawaan (versi asli yang disertakan dengan aplikasi native Anda).
getDeviceId	Dapatkan identifier unik yang ramah privasi untuk perangkat ini.
getPluginVersion	Dapatkan versi plugin Capacitor Updater yang terinstal di aplikasi Anda.
isAutoUpdateEnabled	Periksa apakah update otomatis saat ini aktif.
removeAllListeners	Hapus semua event listener yang terdaftar untuk plugin ini.
addListener	Pantau event download bundle di aplikasi. Terpicu saat download dimulai, selama proses download, dan saat selesai. Ini akan mengembalikan persentase download selama proses berlangsung.
addListener	Pantau event 'no need to update', berguna jika Anda ingin melakukan force check setiap kali aplikasi diluncurkan.
addListener	Pantau event update yang tersedia, berguna jika Anda ingin memaksa pengecekan setiap kali aplikasi dijalankan.
addListener	Dengarkan event downloadComplete.
addListener	Pantau event update yang breaking saat backend menandai update tidak kompatibel dengan aplikasi saat ini. Mengirimkan payload yang sama dengan versi legacy majorAvailable listener lama.
addListener	Pantau event update Major di dalam App, untuk memberi tahu Anda saat update major terblokir karena pengaturan disableAutoUpdateBreaking.
addListener	Pantau event kegagalan update di dalam App, untuk memberi tahu Anda saat update gagal diinstal pada saat aplikasi dijalankan berikutnya.
addListener	Dengarkan event set di aplikasi, memberi tahu saat bundle berhasil diterapkan. Event ini disimpan secara native hingga JavaScript mengonsumsinya, jadi jika aplikasi di-reload sebelum listener terpasang, event terakhir yang tertunda set akan dikirim setelah listener subscribe.
addListener	Pantau event set next di dalam App untuk mengetahui kapan sebuah bundle masuk antrean sebagai bundle berikutnya yang akan diinstal.
addListener	Pantau event kegagalan download di dalam App, untuk memberi tahu Anda saat download bundle gagal.
addListener	Pantau event reload di dalam App untuk mengetahui kapan reload telah terjadi.
addListener	Dengarkan event app ready di aplikasi, memberi tahu saat aplikasi siap digunakan. Event ini disimpan secara native hingga JavaScript mengonsumsinya, sehingga tetap bisa dikirim setelah reload meskipun listener baru terpasang saat startup aplikasi.
addListener	Dengarkan event private channel, yang dipicu saat mencoba mengatur channel yang tidak mengizinkan self-assignment perangkat.
addListener	Dengarkan perubahan status flexible update di Android.
isAutoUpdateAvailable	Periksa apakah fitur auto-update tersedia (tidak dinonaktifkan oleh konfigurasi server kustom).
getNextBundle	Dapatkan informasi tentang bundle yang antre untuk diaktifkan pada reload berikutnya.
getFailedUpdate	Ambil informasi tentang bundle terbaru yang gagal dimuat.
setShakeMenu	Aktifkan atau nonaktifkan menu gestur shake untuk debugging dan pengujian.
isShakeMenuEnabled	Periksa apakah menu debug gestur shake saat ini aktif.
setShakeChannelSelector	Aktifkan atau nonaktifkan pemilih channel gestur shake saat runtime.
isShakeChannelSelectorEnabled	Periksa apakah pemilih channel gestur shake saat ini aktif.
getAppId	Dapatkan App ID yang saat ini dikonfigurasi untuk komunikasi dengan server update.
setAppId	Ubah App ID yang dipakai untuk komunikasi dengan server update secara dinamis.
getAppUpdateInfo	Dapatkan info ketersediaan aplikasi di App Store atau Play Store.
openAppStore	Buka halaman aplikasi di App Store atau Play Store.
performImmediateUpdate	Lakukan update in-app langsung di Android.
startFlexibleUpdate	Mulai update in-app secara fleksibel di Android.
completeFlexibleUpdate	Selesaikan update in-app secara fleksibel di Android.

Sumber Kebenaran

Referensi ini disinkronkan dari src/definitions.ts di capacitor-updater.

Lanjutkan dari @capgo/capacitor-updater

Jika Anda menggunakan @capgo/capacitor-updater untuk merencanakan pekerjaan plugin native, hubungkan dengan Menggunakan @capgo/capacitor-updater untuk fitur native di bagian Menggunakan @capgo/capacitor-updater, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi pada Capacitor Plugins oleh Capgo Menambahkan atau Memperbarui Plugin untuk detail implementasi di Menambahkan atau Memperbarui Plugin, dan Alternatif Plugin Ionic Enterprise untuk alur kerja produk dalam Alternatif Plugin Ionic Enterprise.