Inicio

Copiar 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 la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo 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`

Activar el seguimiento de proximidad.

On iOS esto habilita UIDevice.isProximityMonitoringEnabled. En 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 seguimiento de proximidad.

Copiar a portapapeles

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

await CapacitorProximity.disable();

`getStatus`

Título de la sección “obtenerEstado”

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

const status = await CapacitorProximity.getStatus();

Referencia de tipo

`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 de la configuración del plugin. src/definitions.ts. Re-rerun la sincronización cuando los cambios públicos API cambien en la fuente.

Seguir adelante desde Inicio

Si estás utilizando Inicio para planificar la consola y las operaciones API, conecta con Usando @capgo/capacitor-proximidad para la capacidad nativa en Usando @capgo/capacitor-proximidad, Resumen de API para el detalle de implementación en Resumen de API, Introducción para el detalle de implementación en Introducción, Claves de API para los detalles de implementación en API Claves, y Dispositivos para los detalles de implementación en Dispositivos.