Langsung ke konten

@capgo/capacitor-live-activities

Kelola layout iOS Live Activities dan Dynamic Island dari Capacitor dengan template berbasis JSON

@capgo/capacitor-live-activities mengelola ActivityKit Live Activities dari Capacitor menggunakan JSON layout DSL (lock screen, Dynamic Island, timer, gambar dalam shared App Group). Plugin ini tidak mengimplementasikan Apple App Intents, frasa Siri, aplikasi Shortcuts, pengindeksan Spotlight, atau antrean App Intent yang tertunda.

Untuk tampilan widget Home Screen, template SVG, atau LiveActivityIntent tombol yang terhubung ke log event template, gunakan @capgo/capacitor-widget-kit sebagai pengganti atau pendamping plugin ini. Untuk frasa Siri, Spotlight, dan antrean App Intent dalam JavaScript, gunakan @capgo/capacitor-app-intents.

Lihat Siri, Shortcuts, dan widget tentang bagaimana plugin Capgo memetakan fitur integrasi sistem.

Mulai dengan areActivitiesSupported() dan metode inti lainnya yang tercantum di bawah ini.

PlatformDukunganCatatan
iOSYaNative
AndroidYaNative
WebTidakLindungi dengan Capacitor.getPlatform()
Demo Live Activities animasi yang menampilkan update lock screen dan Dynamic Island dari Capacitor
Update Live Activity dan Dynamic Island
  • areActivitiesSupported - Cek apakah Live Activities didukung di perangkat ini. Membutuhkan iOS 16.1+ dan dukungan perangkat.
  • startActivity - Mulai Live Activity baru dengan layout dan data yang ditentukan.
  • updateActivity - Update Live Activity yang sudah ada dengan data baru.
  • endActivity - Akhiri Live Activity.
MetodeDeskripsi
areActivitiesSupportedCek apakah Live Activities didukung di perangkat ini. Membutuhkan iOS 16.1+ dan dukungan perangkat.
startActivityMulai Live Activity baru dengan layout dan data yang ditentukan.
updateActivityUpdate Live Activity yang sudah ada dengan data baru.
endActivityAkhiri Live Activity.
getAllActivitiesDapatkan semua Live Activities yang sedang aktif.
saveImageSimpan gambar ke container App Group bersama untuk digunakan di Live Activities. Gambar harus disimpan di container bersama agar bisa diakses dari widget extension.
removeImageHapus gambar yang tersimpan dari container bersama.
listImagesTampilkan daftar semua gambar yang tersimpan di container bersama.
cleanupImagesHapus semua gambar yang tersimpan dari container bersama.
getPluginVersionDapatkan versi plugin native Capacitor.
startTimerSequenceMulai urutan timer untuk workout/olahraga. Di iOS: Muncul di Live Activity dan Dynamic Island. Di Android: Muncul sebagai notifikasi foreground dengan timer.
pauseTimerSequenceJeda urutan timer.
resumeTimerSequenceLanjutkan urutan timer yang dijeda.
stopTimerSequenceHentikan dan tutup urutan timer.
skipTimerStepLewati ke langkah berikutnya dalam urutan.
previousTimerStepKembali ke langkah sebelumnya dalam urutan.
getTimerStateDapatkan status terkini dari urutan timer.
addListenerTambahkan listener untuk event urutan timer. Event meliputi: stepChange, complete, tick, paused, resumed, stopped, loopComplete.

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

Lanjutkan dari @capgo/capacitor-live-activities

Bagian berjudul “Lanjutkan dari @capgo/capacitor-live-activities”

Jika Anda menggunakan @capgo/capacitor-live-activities untuk merencanakan perilaku media dan antarmuka native, hubungkan dengan Menggunakan @capgo/capacitor-live-activities untuk kemampuan native di Menggunakan @capgo/capacitor-live-activities, Menggunakan @capgo/capacitor-video-player untuk kapabilitas native saat menggunakan @capgo/capacitor-video-player, @capgo/capacitor-video-player untuk detail implementasi di @capgo/capacitor-video-player, Menggunakan @capgo/capacitor-native-navigation untuk kapabilitas native di Menggunakan @capgo/capacitor-native-navigation, dan @capgo/capacitor-native-navigation untuk detail implementasi di @capgo/capacitor-native-navigation.