Skip ke konten

@capgo/capacitor-pembaruan

Live update untuk capacitor aplikasi.

Juga tersedia untuk Cordova dan Electron

Bab berjudul “Juga tersedia untuk Cordova dan Electron”

Capgo pembaruan hidup tidak terbatas pada Capacitor. Gunakan backend yang sama dan CLI dengan plugin klien saudara:

Live update untuk aplikasi capacitor.

  • notifyAppReady - Perluas lapisan native bahwa JavaScript telah berjalan dengan sukses.
  • setUpdateUrl - Atur URL pembaruan untuk aplikasi secara dinamis pada waktu runtime.
  • setStatsUrl - Atur URL statistik untuk aplikasi secara dinamis pada waktu runtime.
  • setChannelUrl - Atur URL saluran untuk aplikasi secara dinamis pada waktu runtime.
MetodeDeskripsi
notifyAppReadyPerluas lapisan native bahwa JavaScript telah berjalan dengan sukses.
setUpdateUrlAtur URL pembaruan untuk aplikasi secara dinamis pada waktu runtime.
setStatsUrlAtur URL statistik untuk aplikasi secara dinamis pada waktu runtime.
setChannelUrlSet URL kanal aplikasi secara dinamis pada saat runtime.
downloadUnduh bundle baru dari URL yang disediakan untuk instalasi nanti.
nextSetel bundle berikutnya yang akan diaktifkan ketika aplikasi berlatar belakang atau restart.
setSetel bundle saat ini dan muat ulang aplikasi secara langsung.
deleteHapus bundle dari penyimpanan lokal untuk menghemat ruang disk.
setBundleErrorMark bundle secara manual sebagai gagal/terjadi kesalahan dalam mode update manual.
listDapatkan semua bundle yang diunduh secara lokal yang disimpan di aplikasi Anda.
resetReset aplikasi ke bundle yang diketahui baik.
currentDapatkan informasi tentang bundle yang aktif saat ini.
reloadMuat ulang aplikasi secara manual untuk menerapkan update yang tertunda.
setMultiDelayKonfigurasi kondisi yang harus dipenuhi sebelum update yang tertunda diterapkan.
cancelDelayBatalkan semua kondisi delay dan terapkan update yang tertunda secara langsung.
getLatestPeriksa server pembaruan untuk versi bundle terbaru yang tersedia.
setChannelSetel saluran pembaruan runtime lokal untuk perangkat ini. Ini tidak membuat override dashboard/API perangkat.
unsetChannelHapus pengaturan saluran perangkat dan kembali ke saluran default.
getChannelAmbil saluran yang saat ini ditetapkan untuk perangkat ini.
listChannelsDapatkan daftar semua saluran yang tersedia untuk perangkat ini agar dapat menetapkan sendiri.
setCustomIdSetel identifikasi khusus untuk perangkat ini.
getBuiltinVersionDapatkan versi bundle bawaan (versi asli yang dikirimkan dengan aplikasi native Anda).
getDeviceIdDapatkan identifikasi unik dan ramah privasi untuk perangkat ini.
getPluginVersionDapatkan versi dari Capacitor Plugin Pembaruan yang terinstal di aplikasi Anda.
isAutoUpdateEnabledPeriksa apakah pembaruan otomatis saat ini diaktifkan.
removeAllListenersHapus semua pendengar acara yang terdaftar untuk plugin ini.
addListenerDengarkan acara download bundle di Aplikasi. Melempar sekali ketika download dimulai, selama download dan ketika selesai. Ini akan kembali persentase download selama download.
addListenerDengarkan tidak perlu update event, berguna ketika Anda ingin memeriksa setiap kali aplikasi diluncurkan.
addListenerDengarkan event update yang tersedia, berguna ketika Anda ingin memeriksa update setiap kali aplikasi diluncurkan.
addListenerDengarkan event download selesai.
addListenerDengarkan event update breaking ketika backend menandai update sebagai tidak kompatibel dengan aplikasi saat ini. Mengeluarkan payload yang sama seperti listener legacy. majorAvailable listener.
addListenerDengarkan event update gagal dalam Aplikasi, biarkan Anda tahu ketika update gagal terpasang di aplikasi selanjutnya.
addListenerDengarkan event gagal update di Aplikasi, memberitahu Anda ketika update gagal terpasang di aplikasi selanjutnya.
addListenerListen for set event in the App, let you know when a bundle has been applied successfully. This event is retained natively until JavaScript consumes it, so if the app reloads before your listener is attached, the last pending set event akan dikirimkan setelah pengguna berlangganan.
addListenerDengarkan untuk setiap event berikutnya di Aplikasi, dan informasikan Anda ketika sebuah paket telah ditetapkan sebagai paket berikutnya untuk diinstal.
addListenerDengarkan event gagal download di Aplikasi, memberitahu Anda ketika bundle download gagal.
addListenerDengarkan event reload di Aplikasi, biarkan Anda tahu ketika reload telah terjadi.
addListenerMenunggu event siap aplikasi di App, memungkinkan Anda mengetahui ketika aplikasi siap digunakan. Event ini disimpan secara native hingga JavaScript mengonsumsinya, sehingga masih dapat dikirimkan setelah reload bahkan jika pendengar terpasang lebih awal dalam proses startup aplikasi.
addListenerMenunggu event privat channel, diluncurkan ketika mencoba mengatur channel yang tidak memungkinkan perangkat pengasasan sendiri.
addListenerMenunggu perubahan status update fleksibel pada Android.
isAutoUpdateAvailablePeriksa jika fitur auto-update tersedia (tidak dinonaktifkan oleh konfigurasi server kustom).
getNextBundlePilih informasi tentang paket yang diantre untuk diaktifkan pada reload berikutnya.
getFailedUpdatePilih informasi tentang paket terbaru yang gagal dimuat.
setShakeMenuAktifkan atau nonaktifkan menu guncangan untuk debugging dan testing.
isShakeMenuEnabledPeriksa jika menu guncangan debug saat ini aktif.
setShakeChannelSelectorAktifkan atau nonaktifkan pilihan channel guncangan pada runtime.
isShakeChannelSelectorEnabledPeriksa jika pilihan channel guncangan saat ini aktif.
getAppIdPilih ID Aplikasi yang saat ini dikonfigurasi untuk komunikasi server update.
setAppIdGanti ID Aplikasi secara dinamis yang digunakan untuk komunikasi server update.
getAppUpdateInfoPeroleh informasi tentang ketersediaan aplikasi di App Store atau Play Store.
openAppStoreTerbuka halaman aplikasi di App Store atau Play Store.
performImmediateUpdatePerbarui aplikasi secara langsung di Android.
startFlexibleUpdateMulai perbarui aplikasi fleksibel di Android.
completeFlexibleUpdateSelesaikan perbarui aplikasi fleksibel di Android.

Referensi ini disinkronkan dari src/definitions.ts in capacitor-perbarui.

Jika Anda menggunakan @capgo/capacitor-updater Untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-pembarui Untuk kemampuan asli di Using @capgo/capacitor-updater, Direktori Plugin Capgo untuk alur kerja produk di direktori plugin Capgo. Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo Mengaktifkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Ionic Enterprise untuk alur kerja produk di Ionic Enterprise Plugin Alternatives.