Getting Started

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 지시를 복사할 수 있습니다.

        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.

설치

AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요:

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

다음 명령어를 사용하세요:

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

만약 Manual Setup을 선호한다면, 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요.

bun add @capgo/capacitor-proximity
bunx cap sync

Import

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

API 개요

`enable`

근접 모니터링을 활성화하세요.

iOS에서 이 옵션을 활성화하면 UIDevice.isProximityMonitoringEnabled. 안드로이드에서 이 기능은 센서가 가려질 때까지 감지 시작합니다. TYPE_PROXIMITY 밝은 현재 앱 창을 어둡게 합니다.

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

await CapacitorProximity.enable();

`disable`

근접 센서 모니터링을 끕니다.

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

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

await CapacitorProximity.disable();

`getStatus`

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

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

const status = await CapacitorProximity.getStatus();

타입 참조

`ProximityStatusResult`

프로시니티 스테이터스 결과 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.ts공개 API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

시작부터 계속하기

Capgo를 사용 중이라면 Getting Started 대시보드와 API 연산을 계획하고 싶다면 Capgo를 사용하여 @capgo/capacitor-proximity Capgo를 사용하여 @capgo/capacitor-proximity API 개요 API 개요 소개 소개 API 키 API 키 장치 장치의 구현 세부 정보.