Zum Hauptinhalt springen
@capgo/capacitor-iBeacon Ort Offene Quelle

iBeacon Capacitor Plugin

iBeacon-Plugin für Capacitor - Näherungsdetektion und Beacon-Region-Überwachung

Installieren

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

Anleitung

Verwenden Sie iBeacon in Capacitor

Testen Sie auf Gerät

Laden Sie die Capgo-App herunter, dann scannen Sie das QR-Code code.

QR-Code für die iBeacon-Plugin-Vorschau code

Verwendung von @capgo/capacitor-ibeacon

Capacitor iBeacon-Plugin - Näherungsdetektion und Überwachung von Beacon-Regionen.

Installieren

bun add @capgo/capacitor-ibeacon
bunx cap sync

bunx cap sync kopiert die native code-Bibliothek in Ihre native Projekte. Führen Sie es erneut aus, nachdem jede Plugin-Upgrade durchgeführt wurde.

Importieren

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

API im Überblick

Methode Beschreibung
startMonitoringForRegion Starten Sie die Überwachung eines Beacon-Bereichs. Auslöst Ereignisse, wenn der Bereich betreten/verlassen wird.
stopMonitoringForRegion Beenden Sie die Überwachung eines Beacon-Bereichs.
startRangingBeaconsInRegion Starten Sie die Rangierung von Beacons in einem Bereich. Bietet ständige Entfernungsaktualisierungen.
stopRangingBeaconsInRegion Beacon-Ranging in einer Region stoppen.
startAdvertising Starten Sie die Vermarktung des Geräts als iBeacon (nur iOS).
stopAdvertising Beenden Sie die Vermarktung des Geräts als iBeacon (nur iOS).
requestWhenInUseAuthorization Stellen Sie die Anfrage nach der "Verwendung"-Ortsermächtigung (erforderlich für Rangierung/Überwachung).
requestAlwaysAuthorization Stellen Sie die Anfrage nach der "Immer"-Ortsermächtigung (erforderlich für Hintergrund-Überwachung).
getAuthorizationStatus Erhalten Sie den aktuellen Ortsermächtigungsstatus.
isBluetoothEnabled Überprüfen Sie, ob Bluetooth auf dem Gerät aktiviert ist.
isRangingAvailable Überprüfen Sie, ob Rangierung auf dem Gerät verfügbar ist.
enableARMAFilter Entschuldigung ARMA-Filterung für Entfernungsrechnungen (nur Android).
enableBackgroundMode Aktivieren oder deaktivieren Sie den Hintergrund-Beacon-Scanningsmodus (nur Android). Dies aktiviert einen Vordergrunddienst für zuverlässige Hintergrundbeacon-Detektion. Muss nach der Anforderung der "Immer"-Ortserlaubnis aufgerufen werden.
setBackgroundScanPeriod Konfigurieren Sie die Hintergrund-Scanaufenthalte (nur Android). Steuert, wie oft und wie lange das Gerät nach Beacons sucht, wenn es im Hintergrund ist.

Beispiele

startMonitoringForRegion()

Starten Sie die Überwachung eines Beacon-Bereichs. Auslöst Ereignisse, wenn man den Bereich betritt oder verlässt.

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

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

stopMonitoringForRegion()

Beenden Sie die Überwachung eines Beacon-Bereichs.

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

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

startRangingBeaconsInRegion()

Starten Sie die Rangierung von Beacons in einem Bereich. Bietet ständige Entfernungsaktualisierungen.

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

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

stopRangingBeaconsInRegion()

Beacon-Ranging in einer Region stoppen.

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

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

startAdvertising()

Starten Sie die Vermarktung des Geräts als iBeacon (nur iOS).

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

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

stopAdvertising()

Beenden Sie die Vermarktung des Geräts als iBeacon (nur iOS).

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

await CapacitorIbeacon.stopAdvertising();

Die Tabelle oben listet die 14 Kernmethoden auf. Helfer für Listener und Versionen sowie die vollständige Vertragsvereinbarung jeder Methode sind im GitHub Repository.

Auf Ereignisse hören

addListener eine Verbindung zurückgibt. Ruf handle.remove() wenn das Bildschirm-Unmount-Event ausgelöst wird oder CapacitorIbeacon.removeAllListeners() um alle Listener zu löschen.

Vollständige Referenz

Weitermachen von Using @capgo/capacitor-ibeacon

Wenn Sie Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-ibeacon verwenden Verwendung von @capgo/capacitor-ibeacon um native Plugin-Arbeit zu planen, verbinden Sie es mit @capgo/capacitor-ibeacon für die Implementierungsdetails in @capgo/capacitor-ibeacon, Getting Started für die Implementierungsdetails in Einstieg Capgo Plugin Directory für den Produktworkflow im Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.

FAQ

Häufig gestellte Fragen

Wie installiere ich die iBeacon-Plugin in einer Capacitor-App?

Run "bun add @capgo/capacitor-ibeacon" (or "npm install @capgo/capacitor-ibeacon"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-ibeacon" in your app code.

Funktioniert @capgo/capacitor-ibeacon mit React, Vue und Angular?

Ja. iBeacon ist ein Capacitor-Paket, daher funktioniert es mit jedem Webframework, das innerhalb von Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und plain JavaScript.

Welche Capacitor-Version unterstützt @capgo/capacitor-ibeacon?

Capgo-Plugins folgen der Capacitor-Majorsversion: Wählen Sie die Plugin-Majorsversion, die Ihrem Capacitor-Majorsversion entspricht (z.B. Plugin v8 mit Capacitor 8). Die Kompatibilitätsübersicht im GitHub-README enthält die unterstützten Versionen.

Ist @capgo/capacitor-ibeacon kostenlos und Open-Source?

Ja. Der Quellcode von code ist öffentlich auf GitHub unter https://github.com/Cap-go/capacitor-ibeacon/ verfügbar und das Paket kann kostenlos installiert werden von npm. Bug-Reports und Pull-Requests sind willkommen.

Kann ich code mit iBeacon aktualisieren, ohne eine App-Store-Überprüfung?

Die Installation oder das Upgrade des Plugins ändert die native code, daher benötigt es eine neue Store-Build. Anschließend können JavaScript-, HTML- und CSS-Änderungen, die den Plugin aufrufen, sofort mit Capgo-Live-Updates verschickt werden.

Schiffe iBeacon-Änderungen ohne Wartezeit für die App-Überprüfung

Einmal der Plugin ist in Ihrem Store Build, Capgo leiten Live Updates Ihre JavaScript, HTML und CSS Änderungen in Minuten an die Benutzer weiter.

Starten Sie mit Capgo