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 and dims the current 앱 창을 어둡게 합니다.

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

await CapacitorProximity.enable();

`disable`

가까운 거리 감지 모니터링을 끕니다.

Copy to clipboard

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

await CapacitorProximity.disable();

`getStatus`

Copy to clipboard

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

const status = await CapacitorProximity.getStatus();

Section titled “Type Reference”

`ProximityStatusResult`

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`

PluginVersionResult

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

원본

이 페이지는 플러그인의 src/definitions.ts API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속

__CAPGO_KEEP_0__을 사용 중이라면 Getting Started API 대시보드와 API 연산을 계획하고 싶다면 Using @capgo/capacitor-proximity for the native capability in Using @capgo/capacitor-proximity, Using @API/__CAPGO_KEEP_1__-proximity API 개요 __CAPGO_KEEP_0__의 구현 세부 사항에 대해 Introduction API의 구현 세부 사항에 대해 API 키 __CAPGO_KEEP_0__ 키의 구현 세부 사항에 대해 및 장치 __CAPGO_KEEP_0__ 구현 세부 사항.