Iniziare

Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-proximity`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/proximity/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installazione

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

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

Poi utilizza 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 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';

API Panoramica

`enable`

Abilita la monitoraggio di prossimità.

Su iOS ciò abilita UIDevice.isProximityMonitoringEnabled. Su 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`

Disabilita il monitoraggio di prossimità.

Questo ripristina il comportamento di base della finestra dell'app e interrompe il monitoraggio del sensore.

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

await CapacitorProximity.disable();

`getStatus`

Ottieni lo stato di disponibilità 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. Riavvia la sincronizzazione quando le informazioni pubbliche API cambiano upstream.

Continua da Getting Started

Se stai utilizzando Avvio per pianificare il dashboard e le API operazioni, connettilo con Utilizzo di @capgo/capacitor-prossimità per la capacità nativa in Utilizzo di @capgo/capacitor-prossimità, Panoramica di API per la dettaglio di implementazione in Panoramica di API, Introduzione per il dettaglio di implementazione in Introduzione, Chiavi di API per il dettaglio di implementazione in Chiavi di API, e Dispositivi per il dettaglio di implementazione in Dispositivi.