Getting Started

Copie un prompt de configuración con los pasos de instalación y la guía de markdown completa para este 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.

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-proximity
bunx cap sync

Importar

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

API Resumen

`enable`

Habilitar el seguimiento de proximidad.

En iOS, esto lo habilita UIDevice.isProximityMonitoringEnabledOn Android esto comienza a escuchar a TYPE_PROXIMITY y desvanece la ventana de la aplicación actual mientras el sensor está cubierto.

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

await CapacitorProximity.enable();

`disable`

Desactivar el monitoreo de proximidad.

Esto restaura el comportamiento de ventana de aplicación por defecto y detiene el monitoreo del sensor.

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

await CapacitorProximity.disable();

`getStatus`

Obtener el estado actual de disponibilidad del sensor y el plugin habilitado.

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

const status = await CapacitorProximity.getStatus();

Referencia de tipos

`ProximityStatusResult`

Resultado devuelto por 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`

Resultado devuelto cuando se solicita la versión del plugin.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s. src/definitions.tsRe-ejecutar la sincronización cuando los cambios públicos API cambien en la fuente.

Sigue adelante desde Getting Started

If you are using Getting Started para planificar la consola y las operaciones de API, conecte con Using @capgo/capacitor-proximity para la capacidad nativa en Using @capgo/capacitor-proximity, API Overview para el detalle de implementación en API Overview, Introducción para el detalle de implementación en Introducción, API Keys para el detalle de implementación en API Keys, y Dispositivos para los detalles de implementación en dispositivos.