Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

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

Poi usa il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-proximity
bunx cap sync

Importa

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

Avvio rapido

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

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

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

Esempio: riproduzione nota vocale

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

Errori comuni

• Disabilita sempre: chiamata disable() nella finally blocchi per ripristinare la luminosità dopo gli errori.
• Dispositivi senza sensore: controlla getStatus() prima di mostrare la UX di prossimità all'orecchio.
• Web: le API di prossimità non sono esposte, usa solo chiamate native.

Panoramica API

enable

Abilita il monitoraggio della prossimità.

Su iOS questo abilita UIDevice.isProximityMonitoringEnabled. Su Android questo avvia l'ascolto di TYPE_PROXIMITY e oscura la finestra dell'app corrente mentre il sensore è coperto.

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

await CapacitorProximity.enable();

disable

Disabilita il monitoraggio della prossimità.

Ripristina il comportamento predefinito della finestra dell'app e interrompe il monitoraggio dei sensori.

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

await CapacitorProximity.disable();

getStatus

Ottieni lo stato del sensore e se il plugin è attivo.

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

const status = await CapacitorProximity.getStatus();

Riferimento ai tipi

ProximityStatusResult

Risultato restituito da 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

Risultato restituito quando si richiede la versione del plugin.

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

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-proximity per la funzionalità nativa in Usare @capgo/capacitor-proximity, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.