Démarrage

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce 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.

Copiez pour l'IA

bun add @capgo/capacitor-proximity
bunx cap sync

Importer

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

API Vue d'ensemble

`enable`

Activer la surveillance de proximité.

Sur iOS, cela active UIDevice.isProximityMonitoringEnabled. Sur Android, cela commence à écouter TYPE_PROXIMITY et diminue la fenêtre actuelle de l'application pendant que le capteur est recouvert.

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

await CapacitorProximity.enable();

`disable`

Désactiver la surveillance de proximité.

Cela restaure le comportement de fenêtre d'application par défaut et arrête la surveillance du capteur.

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

await CapacitorProximity.disable();

`getStatus`

Obtenir la disponibilité actuelle du capteur et l'état de la mise en œuvre activé.

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

const status = await CapacitorProximity.getStatus();

Référence de type

`ProximityStatusResult`

Résultat retourné par 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`

Résultat retourné lors de la demande de version du plugin.

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

Source de Vérité

Cette page est générée à partir de la version du plugin. src/definitions.tsRe-run la synchronisation lorsque les modifications publiques API sont mises à jour en amont.