Panduan
Cara menggunakan iBeacon di Capacitor
Menggunakan @capgo/capacitor-ibeacon
Plugin Capacitor iBeacon - Deteksi proximity dan monitoring region beacon.
Instal
bun add @capgo/capacitor-ibeacon
bunx cap sync
bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.
Impor
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
Sekilas tentang API
| Metode | Deskripsi |
|---|---|
startMonitoringForRegion |
Mulai monitoring region beacon. Memicu event saat masuk/keluar region. |
stopMonitoringForRegion |
Stop monitoring region beacon. |
startRangingBeaconsInRegion |
Mulai ranging beacon di sebuah region. Memberikan update jarak secara kontinu. |
stopRangingBeaconsInRegion |
Stop ranging beacon di sebuah region. |
startAdvertising |
Mulai advertising perangkat sebagai iBeacon (khusus iOS). |
stopAdvertising |
Stop advertising perangkat sebagai iBeacon (khusus iOS). |
requestWhenInUseAuthorization |
Minta otorisasi lokasi "When In Use" (wajib untuk ranging/monitoring). |
requestAlwaysAuthorization |
Minta otorisasi lokasi "Always" (diperlukan untuk monitoring background). |
getAuthorizationStatus |
Dapatkan status otorisasi lokasi saat ini. |
isBluetoothEnabled |
Cek apakah Bluetooth aktif di perangkat. |
isRangingAvailable |
Cek apakah fitur ranging tersedia di perangkat. |
enableARMAFilter |
Aktifkan filtering ARMA untuk kalkulasi jarak (khusus Android). |
enableBackgroundMode |
Aktifkan atau nonaktifkan mode background beacon scanning (khusus Android). Ini menjalankan foreground service agar deteksi beacon di background tetap reliabel. Harus dipanggil setelah meminta otorisasi lokasi "Always". |
setBackgroundScanPeriod |
Konfigurasi periode background scan (khusus Android). Mengatur seberapa sering dan berapa lama perangkat melakukan scan beacon saat di background. |
Contoh
startMonitoringForRegion()
Mulai monitoring untuk suatu beacon region. Memicu event saat masuk/keluar dari region tersebut.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startMonitoringForRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
stopMonitoringForRegion()
Stop monitoring untuk suatu beacon region.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopMonitoringForRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
startRangingBeaconsInRegion()
Mulai ranging beacon di suatu region. Memberikan update jarak secara kontinu.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
stopRangingBeaconsInRegion()
Stop ranging beacon di suatu region.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
startAdvertising()
Mulai memancarkan perangkat sebagai iBeacon (khusus iOS).
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startAdvertising({
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
major: 1,
minor: 2,
identifier: 'MyBeacon'
});
stopAdvertising()
Berhenti memancarkan perangkat sebagai iBeacon (khusus iOS).
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopAdvertising();
Tabel di atas mencantumkan 14 metode inti. Helper listener, versi, dan kontrak lengkap setiap metode didokumentasikan di repositori GitHub.
Mendengarkan event
addListener mengembalikan sebuah handle. Panggil handle.remove() saat layar di-unmount, atau CapacitorIbeacon.removeAllListeners() untuk menghapus semua listener.
Referensi lengkap
Lanjutkan dari Menggunakan @capgo/capacitor-ibeacon
Jika Anda menggunakan Menggunakan @capgo/capacitor-ibeacon untuk merencanakan pekerjaan plugin native, hubungkan dengan @capgo/capacitor-ibeacon untuk detail implementasi di @capgo/capacitor-ibeacon, Panduan Memulai untuk detail implementasi di Getting Started, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin Capacitor oleh Capgo, dan Menambahkan atau Memperbarui Plugin untuk detail implementasi di bagian Menambahkan atau Memperbarui Plugin.