Guide
Comment utiliser iBeacon dans Capacitor
Utiliser @capgo/capacitor-ibeacon
Plugin Capacitor iBeacon - Détection de proximité et surveillance de régions beacon.
Installer
bun add @capgo/capacitor-ibeacon
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
Aperçu de API
| Méthode | Description |
|---|---|
startMonitoringForRegion |
Commencez à surveiller une région de beacons. Déclenche des événements lors de l'entrée ou de la sortie de la région. |
stopMonitoringForRegion |
Arrêtez la surveillance d'une région de beacons. |
startRangingBeaconsInRegion |
Commencez à détecter les beacons dans une zone. Fournit des mises à jour de distance en continu. |
stopRangingBeaconsInRegion |
Arrête le ranging de beacons dans une région. |
startAdvertising |
Démarre la diffusion de l'appareil en tant qu'iBeacon (iOS uniquement). |
stopAdvertising |
Arrête la diffusion de l'appareil en tant qu'iBeacon (iOS uniquement). |
requestWhenInUseAuthorization |
Demander l'autorisation de localisation « Lorsque l'app est utilisée » (requise pour le ranging/monitoring). |
requestAlwaysAuthorization |
Demander l'autorisation de localisation « Toujours » (requise pour la surveillance en arrière-plan). |
getAuthorizationStatus |
Obtenir le statut actuel de l'autorisation de localisation. |
isBluetoothEnabled |
Vérifier si le Bluetooth est activé sur l'appareil. |
isRangingAvailable |
Vérifier si le ranging est disponible sur l'appareil. |
enableARMAFilter |
Activer le filtrage ARMA pour les calculs de distance (Android uniquement). |
enableBackgroundMode |
Activer ou désactiver le mode de scan de beacons en arrière-plan (Android uniquement). Cela active un service de premier plan pour une détection fiable des beacons en arrière-plan. Doit être appelé après avoir demandé l'autorisation de localisation « Toujours ». |
setBackgroundScanPeriod |
Configurer les périodes de scan en arrière-plan (Android uniquement). Contrôle la fréquence et la durée des scans de beacons en arrière-plan. |
Exemples
startMonitoringForRegion()
Démarrer la surveillance d'une région de beacons. Déclenche des événements à l'entrée et à la sortie de la région.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startMonitoringForRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
stopMonitoringForRegion()
Arrêter la surveillance d'une région de beacons.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopMonitoringForRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
startRangingBeaconsInRegion()
Commencez à détecter les beacons dans une zone. Fournit des mises à jour de distance en continu.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
stopRangingBeaconsInRegion()
Arrête le ranging de beacons dans une région.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
startAdvertising()
Démarre la diffusion de l'appareil en tant qu'iBeacon (iOS uniquement).
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startAdvertising({
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
major: 1,
minor: 2,
identifier: 'MyBeacon'
});
stopAdvertising()
Arrête la diffusion de l'appareil en tant qu'iBeacon (iOS uniquement).
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopAdvertising();
Le tableau ci-dessus liste les 14 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.
Écouter les événements
addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou CapacitorIbeacon.removeAllListeners() pour supprimer tous les listeners.
Référence complète
Continuer depuis « Utiliser @capgo/capacitor-ibeacon »
Si vous utilisez Utiliser @capgo/capacitor-ibeacon pour planifier le travail sur les plugins natifs, connectez-l’à @capgo/capacitor-ibeacon pour les détails d'implémentation dans @capgo/capacitor-ibeacon, Prise en main pour les détails d'implémentation dans Getting Started Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.