Guide
Comment utiliser iBeacon dans Capacitor
Utilisation de @capgo/capacitor-ibeacon
Capacitor Plugin iBeacon - Détection de proximité et suivi de la région du beacon.
Installer
bun add @capgo/capacitor-ibeacon
bunx cap sync
bunx cap sync copie le code natif du plugin code dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.
Importer
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
API en un coup d'œil
| Méthode | Description |
|---|---|
startMonitoringForRegion |
Commencez à surveiller une région de beacon. Déclenche des événements lors de l'entrée/sortie de la région. |
stopMonitoringForRegion |
Arrêtez de surveiller une région de beacon. |
startRangingBeaconsInRegion |
Commencez à détecter les beacons dans une zone. fournit des mises à jour continues de distance. |
stopRangingBeaconsInRegion |
Arrêtez la recherche de beacons dans une région. |
startAdvertising |
Commencez à faire de ce dispositif un iBeacon (disponible uniquement sur iOS). |
stopAdvertising |
Arrêtez d'annoncer le dispositif en tant que beacon iBeacon (iOS uniquement). |
requestWhenInUseAuthorization |
Demandez une autorisation de localisation « Lorsque en utilisation » (nécessaire pour le balayage/la surveillance). |
requestAlwaysAuthorization |
Demandez une autorisation de localisation « Toujours » (nécessaire pour la surveillance de fond). |
getAuthorizationStatus |
Obtenez l'état actuel de l'autorisation de localisation. |
isBluetoothEnabled |
Vérifiez si le Bluetooth est activé sur le dispositif. |
isRangingAvailable |
Vérifiez si le balayage est disponible sur le dispositif. |
enableARMAFilter |
Activer le filtrage ARMA pour les calculs de distance (seulement Android). |
enableBackgroundMode |
Activer ou désactiver le mode de balayage de fond des beacons (seulement Android). Cela active un service de fond pour une détection de beacons fiable en arrière-plan. Doit être appelé après avoir demandé l'autorisation de localisation « Toujours ». |
setBackgroundScanPeriod |
Configurer les périodes de balayage de fond (seulement Android). Contrôle la fréquence et la durée pendant lesquelles le dispositif scanne les beacons en arrière-plan. |
Exemples
startMonitoringForRegion()
Démarrer la surveillance d'une région de beacon. Déclenche des événements lors de l'entrée/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 beacon.
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 continues de la distance.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
stopRangingBeaconsInRegion()
Arrêtez la balayage des beacons dans une région.
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopRangingBeaconsInRegion({
identifier: 'MyBeaconRegion',
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});
startAdvertising()
Démarrer la publicité du dispositif en tant qu'iBeacon (seulement iOS).
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.startAdvertising({
uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
major: 1,
minor: 2,
identifier: 'MyBeacon'
});
stopAdvertising()
Arrêter la publicité du dispositif en tant qu'iBeacon (seulement iOS).
import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';
await CapacitorIbeacon.stopAdvertising();
La table ci-dessus liste les 14 méthodes de base. Les aides aux écouteurs et aux versions, ainsi que le contrat complet de chaque méthode, sont documentés dans le le dépôt GitHub.
Écoutez les événements
addListener renvoie un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou CapacitorIbeacon.removeAllListeners() pour supprimer tous les écouteurs.
Référence complète
Continuez à partir de l'utilisation de @capgo/capacitor-ibeacon
Si vous utilisez L'utilisation de @capgo/capacitor-ibeacon pour planifier le travail de plugin natif, connectez-l’avec @capgo/capacitor-ibeacon pour les détails d'implémentation dans @capgo/capacitor-ibeacon Getting Started pour les détails d'implémentation dans Démarrage Répertoire des plugins Capgo pour le flux de travail du produit dans Répertoire des plugins Capgo Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, et Ajout ou mise à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour des plugins.