Getting Started

Installazione

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo competenze al tuo strumento AI utilizzando il seguente comando:

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

Poi utilizza la seguente richiesta:

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

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

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 di un messaggio vocale

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

Difficoltà comuni

• Disabilitare sempre: chiamata disable() in finally blocco affinché la luminosità si ripristini dopo gli errori.
• Dispositivi senza sensori: controllare getStatus() prima di mostrare l'interfaccia utente di vicinanza all'orecchio.
• Web: le API di vicinanza non sono esposte, mantenere le chiamate native solo.

API Panoramica

enable

Abilita il monitoraggio di vicinanza.

On iOS ciò abilita UIDevice.isProximityMonitoringEnabledOn Android ciò inizia ad ascoltare TYPE_PROXIMITY e riduce la finestra dell'app corrente mentre il sensore è coperto.

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

await CapacitorProximity.enable();

disable

Sezione intitolata “disabilitare”

Riprista il comportamento di finestra dell'app di default e interrompe la monitorizzazione dei sensori.

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

await CapacitorProximity.disable();

getStatus

Ottieni la disponibilità attuale del sensore e lo stato abilitato del plugin.

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

const status = await CapacitorProximity.getStatus();

Riferimento di tipo

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 plugin's src/definitions.ts. Re-run the sync when the public API changes upstream.

Continua da Getting Started

Se stai utilizzando Getting Started per pianificare dashboard e API operazioni, connettilo con Utilizza @capgo/capacitor-proximity per la capacità nativa in Utilizza @capgo/capacitor-proximity API Overview per i dettagli di implementazione in API Overview Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione nei dispositivi.