Getting Started

Install

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten Ihrem AI-Tool mit der folgenden Befehlszeile hinzu:

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

Beinhaltet Installieren, Synchronisieren und die Quellmarkierungen-Leitfaden.

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

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-proximity
bunx cap sync

Importieren

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

Schnellstart

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

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

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

Beispiel: Wiedergabe von Sprachnachrichten

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

Häufige Falle

• Stellen Sie immer sicher, dass: Aufrufen disable() in finally Blöcke so hellherrigkeit wird nach Fehlern wiederhergestellt.
• Geräte ohne Sensor: Überprüfen getStatus() bevor Sie die Nähe-UX anzeigt.
• Website: Proximität-APIs werden nicht freigegeben, führen Sie nur native Aufrufe durch.

API Übersicht

enable

Proximitätsüberwachung aktivieren.

Auf iOS aktiviert dies UIDevice.isProximityMonitoringEnabledAuf Android startet dies das Abhören von TYPE_PROXIMITY und dimmt die aktuelle Anwendungsansicht, während der Sensor abgedeckt ist.

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

await CapacitorProximity.enable();

disable

Proximitätsüberwachung deaktivieren.

Dies setzt die Standardanwendungsansicht wieder her und beendet die Sensorüberwachung.

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

await CapacitorProximity.disable();

getStatus

Erhalten Sie die aktuelle Sensorverfügbarkeit und die Plugin-Einstellung.

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

const status = await CapacitorProximity.getStatus();

Typenreferenz

ProximityStatusResult

Ergebnis, das durch 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

Ergebnis, das bei der Anfrage der Pluginversion zurückgegeben wird.

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

Hauptquelle

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API sich im Hintergrund ändert.

Weitergehen von Getting Started

Wenn Sie das verwenden Getting Started um das Dashboard und API-Betrieb zu planen, verbinden Sie es mit Mit @capgo/capacitor-Proximity für die native Fähigkeit in Mit @capgo/capacitor-Proximity, API Übersicht für die Implementierungsdetails in API Übersicht Einführung Für die Implementierungsdetails in Einführung, API Schlüssel Für die Implementierungsdetails in API Schlüssel und Geräte für die Implementierungsdetails in Geräten.