Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze dann diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-proximity` plugin in my project.

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

bun add @capgo/capacitor-proximity
bunx cap sync

Importieren

import { CapacitorProximity } from '@capgo/capacitor-proximity';

Quickstart

import { CapacitorProximity } from '@capgo/capacitor-proximity';

const { available } = await CapacitorProximity.getStatus();
if (!available) return;

await CapacitorProximity.enable();
// start VoIP or voice playback UI

Beispiel: Sprachnachricht abspielen

await CapacitorProximity.enable();
await playVoiceNote();
await CapacitorProximity.disable();

Häufige Stolperfallen

• Immer deaktivieren: aufrufen disable() in einem finally blocks so brightness restores after errors.
• Geräte ohne Sensor: prüfen getStatus() bevor die Ear-Proximity-UX angezeigt wird.
• Web: Proximity-APIs sind nicht verfügbar; Aufrufe nur nativ durchführen.

API Übersicht

enable

Proximity-Monitoring aktivieren.

Auf iOS aktiviert dies UIDevice.isProximityMonitoringEnabled. Auf Android beginnt damit das Lauschen auf TYPE_PROXIMITY und dimmt das aktuelle App-Fenster, während der Sensor abgedeckt ist.

import { CapacitorProximity } from '@capgo/capacitor-proximity';

await CapacitorProximity.enable();

disable

Proximity-Monitoring deaktivieren.

Damit wird das Standardverhalten des App-Fensters wiederhergestellt und die Sensorüberwachung gestoppt.

import { CapacitorProximity } from '@capgo/capacitor-proximity';

await CapacitorProximity.disable();

getStatus

Ermittle die aktuelle Sensorverfügbarkeit und den Aktivierungsstatus des Plugins.

import { CapacitorProximity } from '@capgo/capacitor-proximity';

const status = await CapacitorProximity.getStatus();

Typreferenz

ProximityStatusResult

Rückgabewert von getStatus().

export interface ProximityStatusResult {
  /**
   * Whether the current device exposes a usable proximity sensor.
   *
   * @since 0.0.1
   */
  available: boolean;

  /**
   * Whether proximity monitoring is currently enabled by the plugin.
   *
   * @since 0.0.1
   */
  enabled: boolean;

  /**
   * Platform label returned by the native or web implementation.
   *
   * @since 0.0.1
   */
  platform: 'ios' | 'android' | 'web';
}

PluginVersionResult

Rückgabewert bei der Abfrage der Plugin-Version.

export interface PluginVersionResult {
  /**
   * Native plugin version string.
   *
   * @since 0.0.1
   */
  version: string;
}

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit Verwendung von @capgo/capacitor-proximity für die native Funktion in Using @capgo/capacitor-proximity, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.