Pindah ke konten utama
@capgo/capacitor-ibeacon Lokasi Terbuka sumber

iBeacon Plugin Capacitor

Plugin iBeacon untuk Capacitor - deteksi keberadaan dan pemantauan wilayah beacon

Pasang

bun add @capgo/capacitor-ibeacon bunx cap sync
npm, pnpm atau yarn
  • npm install @capgo/capacitor-ibeacon
  • pnpm add @capgo/capacitor-ibeacon
  • yarn add @capgo/capacitor-ibeacon

Panduan

Cara menggunakan iBeacon di Capacitor

Menggunakan @capgo/capacitor-ibeacon

Plugin iBeacon Capacitor - Deteksi keberadaan dan pengawasan wilayah beacon.

Install

bun add @capgo/capacitor-ibeacon
bunx cap sync

bunx cap sync mengcopy plugin code native ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.

Import

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

API secara singkat

Metode Pengenalan
startMonitoringForRegion Mulai memantau wilayah beacon. Mengaktifkan event ketika memasuki/mengundurkan diri dari wilayah.
stopMonitoringForRegion Berhenti memantau wilayah beacon.
startRangingBeaconsInRegion Mulai menentukan jarak beacon di wilayah. Memberikan pembaruan jarak terus-menerus.
stopRangingBeaconsInRegion Berhenti menentukan jarak beacon di wilayah.
startAdvertising Mulai mempromosikan perangkat sebagai iBeacon (hanya iOS).
stopAdvertising Berhenti mempromosikan perangkat sebagai iBeacon (hanya iOS).
requestWhenInUseAuthorization Minta izin lokasi "Saat Digunakan" (diperlukan untuk menentukan jarak/memantau).
requestAlwaysAuthorization Minta izin lokasi "Selalu" (diperlukan untuk memantau di latar belakang).
getAuthorizationStatus Periksa status otorisasi lokasi saat ini.
isBluetoothEnabled Periksa apakah Bluetooth diaktifkan di perangkat.
isRangingAvailable Periksa apakah pengukuran jarak tersedia di perangkat.
enableARMAFilter Aktifkan filtering ARMA untuk penghitungan jarak (hanya Android).
enableBackgroundMode Nonaktifkan atau aktifkan mode pemindaian latar belakang (hanya Android). Ini mengaktifkan layanan depan untuk pemindaian latar belakang yang dapat diandalkan. Harus dipanggil setelah meminta otorisasi lokasi "Sekali Saja".
setBackgroundScanPeriod Konfigurasi periode pemindaian latar belakang (hanya Android). Mengontrol seberapa sering dan berapa lama perangkat memindai beacon saat di latar belakang.

Contoh

startMonitoringForRegion()

Mulai memantau wilayah beacon. Mengaktifkan event ketika memasuki/menghilang dari wilayah.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startMonitoringForRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

stopMonitoringForRegion()

Hentikan memantau wilayah beacon.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopMonitoringForRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

startRangingBeaconsInRegion()

Mulai mengukur jarak beacon di wilayah. Memberikan update jarak yang terus-menerus.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startRangingBeaconsInRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

stopRangingBeaconsInRegion()

Hentikan mengukur jarak beacon di wilayah.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopRangingBeaconsInRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

startAdvertising()

Mulai mengiklankan perangkat sebagai iBeacon (hanya iOS).

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startAdvertising({
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
  major: 1,
  minor: 2,
  identifier: 'MyBeacon'
});

stopAdvertising()

Berhenti mempromosikan perangkat sebagai iBeacon (hanya iOS).

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopAdvertising();

Daftar di atas menampilkan 14 metode inti. Bantuan listener dan versi, serta kontrak lengkap dari setiap metode, dapat ditemukan di repository GitHub.

Dengarkan kejadian

addListener kembali sebuah handle. Panggil handle.remove() ketika layar dihapus, atau CapacitorIbeacon.removeAllListeners() untuk membersihkan setiap pemangku jawab.

Referensi penuh

Teruskan dari Menggunakan @capgo/capacitor-ibeacon

Jika Anda menggunakan Menggunakan @capgo/capacitor-ibeacon untuk merencanakan pekerjaan plugin native, hubungkannya dengan @capgo/capacitor-ibeacon untuk detail implementasi di @capgo/capacitor-ibeacon, Mulai Menggunakan untuk detail implementasi di Getting Started, Capgo Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, dan Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin.

FAQ

FAQ Plugin iBeacon

Bagaimana cara menginstal plugin iBeacon di sebuah aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-ibeacon" (atau "npm install @capgo/capacitor-ibeacon"), kemudian jalankan "bunx cap sync" agar proyek iOS dan Android dapat menangkap native code. Import dari "@capgo/capacitor-ibeacon" di aplikasi code.

Apakah @capgo/capacitor-ibeacon dapat digunakan dengan React, Vue dan Angular?

Ya. Plugin iBeacon adalah sebuah paket Capacitor, sehingga dapat digunakan dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte dan JavaScript biasa.

Versi Capacitor mana yang didukung oleh @capgo/capacitor-ibeacon?

Capgo plugin mengikuti versi utama Capacitor: gunakan versi plugin utama yang sesuai dengan versi utama Capacitor (misalnya plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub menyebutkan versi yang dipelihara.

Apakah @capgo/capacitor-ibeacon gratis dan terbuka sumber?

Ya. Sumber code tersedia secara publik di GitHub di https://github.com/Cap-go/capacitor-ibeacon/ dan paketnya dapat diinstal secara gratis dari npm. Laporan bug dan permintaan pull diterima.

Dapatkah saya memperbarui code yang menggunakan iBeacon tanpa melalui tinjauan App Store?

Menginstal atau mengupgrade plugin mengubah native code, sehingga memerlukan pembuatan aplikasi baru. Setelah itu, perubahan JavaScript, HTML dan CSS yang memanggil plugin dapat dikirimkan secara langsung dengan Capgo live updates.

Kirim perubahan iBeacon tanpa menunggu tinjauan aplikasi

Setelah plugin masuk ke dalam toko aplikasi Anda, Capgo pembaruan hidup akan meneruskan perubahan JavaScript, HTML, dan CSS Anda ke pengguna dalam menit.

Mulai dengan Capgo