Getting Started

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.

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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 de l'application actuelle 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 du plugin 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 la 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 des informations du plugin. src/definitions.tsRe-run la synchronisation lorsque les données publiques API changent en amont.

Continuez de l'Accueil

Si vous utilisez Accueil pour planifier votre tableau de bord et les opérations API, connectez-l’avec Utilisez @capgo/capacitor-proximité pour la capacité native dans Utilisez @capgo/capacitor-proximité, Vue d'ensemble de API pour le détail d'implémentation dans Vue d'ensemble de API, Introduction pour le détail d'implémentation dans Introduction, Clés de API pour les détails d'implémentation dans les API clés, et Appareils pour les détails d'implémentation dans les Appareils.