시작하기

설치

bun add @capgo/capacitor-proximity
bunx cap sync

수입

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

API 개요

enable

근접 모니터링 활성화

iOS에서 이 기능을 활성화하면 UIDevice.isProximityMonitoringEnabledAndroid에서 이 기능을 활성화하면 TYPE_PROXIMITY __CAPGO_KEEP_0__ 센서가 가려질 때 현재 앱 창을 어둡게 합니다.

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

await CapacitorProximity.enable();

disable

__CAPGO_KEEP_0__ 근접 센서 모니터링을 중지합니다.

__CAPGO_KEEP_0__ 기본 앱 창 동작을 복원하고 센서 모니터링을 중지합니다.

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

await CapacitorProximity.disable();

getStatus

__CAPGO_KEEP_0__ 현재 센서 사용 가능 상태와 플러그인 활성화 상태를 가져옵니다.

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

const status = await CapacitorProximity.getStatus();

__CAPGO_KEEP_0__ 타입 참조

ProximityStatusResult

__CAPGO_KEEP_0__ 반환 결과 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

플러그인 버전을 요청할 때 반환되는 결과.

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

진실의 근원

이 페이지는 플러그인의 src/definitions.tsAPI이 업스트림에서 변경될 때 다시 동기화할 수 있습니다.