ガイド
Capacitor で iBeacon を使用する方法
@capgo/capacitor-ibeacon の使用方法
Capacitor iBeacon Plugin - 近接検知とビーコン領域のモニタリング
インストール
bun add @capgo/capacitor-ibeacon
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
API の概要
| メソッド | 説明 |
|---|---|
startMonitoringForRegion |
ビーコンリージョンのモニタリングを開始します。リージョンへの進入・退出時にイベントをトリガーします。 |
stopMonitoringForRegion |
ビーコンリージョンのモニタリングを停止します。 |
startRangingBeaconsInRegion |
リージョン内のビーコンのレンジングを開始します。距離を継続的に更新します。 |
stopRangingBeaconsInRegion |
- リージョン内のビーコンのレンジングを停止します。 |
startAdvertising |
デバイスをiBeaconとしてアドバタイズを開始します (iOSのみ)。 |
stopAdvertising |
デバイスのiBeaconアドバタイズを停止します (iOSのみ)。 |
requestWhenInUseAuthorization |
"When In Use"（使用中のみ）のロケーション権限をリクエストします（ranging/monitoring に必要）。 |
requestAlwaysAuthorization |
"Always"のロケーション権限をリクエストします（バックグラウンド監視に必要です）。 |
getAuthorizationStatus |
現在のロケーション権限のステータスを取得します。 |
isBluetoothEnabled |
デバイスのBluetoothが有効かどうかを確認します。 |
isRangingAvailable |
デバイスでrangingが利用可能か確認します。 |
enableARMAFilter |
距離計算用のARMAフィルタリングを有効にします（Androidのみ）。 |
enableBackgroundMode |
バックグラウンドでのビーコンスキャンモードを有効/無効にします（Androidのみ）。これにより、バックグラウンドでの確実な検知のためにフォアグラウンドサービスが有効になります。「Always」のロケーション権限をリクエストした後に呼び出す必要があります。 |
setBackgroundScanPeriod |
バックグラウンドスキャンの間隔を設定します（Androidのみ）。バックグラウンド時にデバイスがどの程度の頻度・時間でビーコンをスキャンするかを制御します。 |
例
startMonitoringForRegion()
ビーコンリージョンのモニタリングを開始します。リージョンへの進入・退出時にイベントをトリガーします。
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startMonitoringForRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
stopMonitoringForRegion()
ビーコンリージョンのモニタリングを停止します。
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopMonitoringForRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
startRangingBeaconsInRegion()
リージョン内のビーコンのレンジングを開始します。距離を継続的に更新します。
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
stopRangingBeaconsInRegion()
- リージョン内のビーコンのレンジングを停止します。
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
startAdvertising()
デバイスをiBeaconとしてアドバタイズを開始します (iOSのみ)。
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startAdvertising({
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
major: 1,
minor: 2,
identifier: 'MyBeacon'
});
stopAdvertising()
デバイスのiBeaconアドバタイズを停止します (iOSのみ)。
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopAdvertising();
上記の表は14個のコアメソッドをまとめたものです。リスナーとバージョンのヘルパー、および各メソッドの完全な仕様については、以下で説明しています。 GitHub リポジトリ.
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または CapacitorIbeacon.removeAllListeners() すべてのリスナーを解除します。
完全なリファレンス
@capgo/capacitor-ibeacon の使用方法から続ける
使用している場合 @capgo/capacitor-ibeacon を使用する ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-ibeacon @capgo/capacitor-ibeacon の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。