Langsung ke konten

@capgo/capacitor-health

Plugin Capacitor untuk berinteraksi dengan data dari Apple HealthKit dan Health Connect.

@capgo/capacitor-health membaca dan menulis data kesehatan pengguna melalui Apple HealthKit di iOS dan Health Connect di Android. Gunakan untuk hitungan langkah, workout, fase tidur, tanda vital, dan sampel nutrisi tanpa perlu mengelola dua integrasi native SDK yang terpisah di layer aplikasi Anda.

Fitness dashboard, aplikasi habit, produk wellness klinis, dan program wellness korporat biasanya dimulai dengan requestAuthorization, lalu readSamples atau saveSample untuk metrik yang mereka butuhkan.

PlatformDukunganCatatan
iOSYaOtorisasi dan sampel HealthKit
AndroidYaHealth Connect, izin riwayat opsional untuk pembacaan >30 hari
WebTerbatasisAvailable melaporkan native SDK yang tidak didukung

Helper khusus Android: openHealthConnectSettings, showPrivacyPolicy.

  • isAvailable - Mengembalikan status apakah platform saat ini mendukung native health SDK.
  • requestAuthorization - Meminta akses baca/tulis untuk tipe data yang ditentukan.
  • checkAuthorization - Mengecek status otorisasi tipe data tanpa memunculkan prompt ke user.
  • readSamples - Membaca sampel untuk tipe data tertentu dalam rentang waktu yang ditentukan.
MetodeDeskripsi
isAvailableMengembalikan status apakah platform saat ini mendukung native health SDK.
requestAuthorizationMeminta akses baca/tulis ke tipe data yang ditentukan.
checkAuthorizationMemeriksa status otorisasi tipe data tanpa perlu prompt ke user.
readSamplesMembaca sampel untuk tipe data tertentu dalam rentang waktu yang ditentukan.
saveSampleMenulis satu sampel ke native health store.
getPluginVersionDapatkan versi plugin native Capacitor.
openHealthConnectSettingsMembuka layar pengaturan Health Connect (hanya Android). Di iOS, metode ini tidak melakukan apa pun.
showPrivacyPolicyMenampilkan kebijakan privasi aplikasi untuk Health Connect (hanya Android). Di iOS, metode ini tidak melakukan apa pun.
queryWorkoutsMengambil data sesi workout dari native health store. Didukung di iOS (HealthKit) dan Android (Health Connect).
queryAggregatedMengambil data kesehatan teragregasi dari native health store. Data diagregasi ke dalam bucket waktu (jam, hari, minggu, bulan) dengan operasi seperti sum, average, min, atau max. Ini lebih efisien daripada mengambil sampel satu per satu untuk rentang tanggal yang besar.

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

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