Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-proximity
bunx cap sync

Importer

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

Démarrage rapide

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

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

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

Exemple : lecture d'un mémo vocal

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

Erreurs courantes

• Toujours désactiver: appelez disable() dans finally empêche que la luminosité soit rétablie après une erreur.
• Appareils sans capteur: vérifier getStatus() avant d’afficher l’interface de proximité des écouteurs.
• Le Web: les API proximity ne sont pas exposées, limitez les appels au natif uniquement.

Aperçu de API

enable

Activer la surveillance de proximité.

Sur iOS, cela active UIDevice.isProximityMonitoringEnabled. Sur Android, cela démarre l’écoute de TYPE_PROXIMITY et atténue la fenêtre de l’app en cours pendant que le capteur est obstrué.

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

await CapacitorProximity.enable();

disable

Désactiver la surveillance de proximité.

Cela restaure le comportement par défaut de la fenêtre de l’application et arrête la surveillance des capteurs.

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

await CapacitorProximity.disable();

getStatus

Récupérer la disponibilité actuelle du capteur et l'état d'activation du plugin.

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

const status = await CapacitorProximity.getStatus();

Référence de type

ProximityStatusResult

Résultat renvoyé 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 renvoyé 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 src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utilisation de @capgo/capacitor-proximity pour la fonctionnalité native dans « Utiliser @capgo/capacitor-proximity », Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.