@capgo/capacitor-ibeacon

概要

Capacitor 用の iBeacon プラグイン - 近接検出とビーコンリージョンの監視

まずはこちらから startMonitoringForRegion() および以下に示すその他のコアメソッド。

プラットフォーム対応

プラットフォーム	サポート	備考
iOSと	はい	ネイティブ
Android	はい	ネイティブ
Web	いいえ	Capacitor.getPlatform() でガード

コア機能

• startMonitoringForRegion - ビーコン領域のモニタリングを開始します。領域への進入・退出時にイベントをトリガーします。
• stopMonitoringForRegion - ビーコン領域のモニタリングを停止します。
• startRangingBeaconsInRegion - 領域内のビーコンのレンジングを開始します。継続的な距離の更新を提供します。
• stopRangingBeaconsInRegion - リージョン内のビーコンのレンジングを停止します。

公開 API

メソッド	説明
startMonitoringForRegion	ビーコンリージョンのモニタリングを開始します。リージョンへの進入・退出時にイベントをトリガーします。
stopMonitoringForRegion	ビーコンリージョンのモニタリングを停止します。
startRangingBeaconsInRegion	リージョン内のビーコンのレンジングを開始します。距離を継続的に更新します。
stopRangingBeaconsInRegion	- リージョン内のビーコンのレンジングを停止します。
startAdvertising	デバイスをiBeaconとしてアドバタイズを開始します (iOSのみ)。
stopAdvertising	デバイスのiBeaconアドバタイズを停止します (iOSのみ)。
requestWhenInUseAuthorization	「使用中のみ」の位置情報権限をリクエストします (レンジング/モニタリングに必要)。
requestAlwaysAuthorization	「常に許可」のロケーション権限をリクエストします（バックグラウンド監視に必要です）。
getAuthorizationStatus	現在のロケーション権限のステータスを取得します。
isBluetoothEnabled	デバイスのBluetoothが有効かどうかを確認します。
isRangingAvailable	デバイスでrangingが利用可能か確認します。
enableARMAFilter	距離計算にARMAフィルタリングを有効にします（Androidのみ）。
getPluginVersion	ネイティブの Capacitor プラグインのバージョンを取得します。
enableBackgroundMode	バックグラウンドでのビーコンスキャンモードを有効または無効にします（Androidのみ）。これにより、バックグラウンドでのビーコン検知を確実にするためのフォアグラウンドサービスが有効になります。「常に許可」のロケーション権限をリクエストした後に呼び出す必要があります。
setBackgroundScanPeriod	バックグラウンドスキャンの間隔を設定します（Androidのみ）。バックグラウンド時にデバイスがどの程度の頻度で、どのくらいの時間ビーコンをスキャンするかを制御します。
addListener	ビーコンのレンジングイベントをリッスンします。
addListener	リージョンへの進入イベントをリッスンします。
addListener	リージョンからの退出イベントをリッスンします。
addListener	リージョンの状態判定イベントをリッスンします。
addListener	モニタリングの失敗イベントをリッスンします。
removeAllListeners	このプラグインのすべてのリスナーを削除します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-ibeacon.

@capgo/capacitor-ibeacon からのステップアップ

使用している場合 @capgo/capacitor-ibeacon ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-ibeacon の使用方法 @capgo/capacitor-ibeacon を使用してネイティブ機能を利用する場合、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。