Primeros pasos

Instalar

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa 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 estos comandos y sigue las instrucciones de cada plataforma:

bun add @capgo/capacitor-proximity
bunx cap sync

Importar

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

Inicio rápido

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

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

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

Ejemplo: reproducción de nota de voz

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

Errores comunes

• Desactivar siempre: llama a disable() en finally bloques para que el brillo se restablezca tras errores.
• Dispositivos sin sensores: verificar getStatus() antes de mostrar la UX de proximidad.
• Web: las APIs de proximidad no están expuestas, mantén las llamadas solo nativas.

Resumen de API

enable

Habilita la monitorización de proximidad.

En iOS esto habilita UIDevice.isProximityMonitoringEnabled. En Android esto inicia la escucha de TYPE_PROXIMITY y atenúa la ventana actual de la app mientras el sensor está cubierto.

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

await CapacitorProximity.enable();

disable

Desactiva la monitorización de proximidad.

Esto restaura el comportamiento predeterminado de la ventana de la app y detiene el monitoreo de sensores.

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

await CapacitorProximity.disable();

getStatus

Obtén la disponibilidad actual del sensor y el estado de activación del plugin.

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 al solicitar 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 src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en upstream.

Continúa desde Getting Started

Si estás usando Primeros pasos para planificar las operaciones del dashboard y de API, conéctalo con Usando @capgo/capacitor-proximity para la capacidad nativa en Uso de @capgo/capacitor-proximity, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en la Introducción, Claves de API para los detalles de implementación en las claves de API, y Dispositivos para el detalle de implementación en Devices.