Getting Started

复制安装提示并包含该插件的完整Markdown指南。

        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辅助安装来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

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.

如果您更喜欢手动设置，请按照以下命令安装插件并遵循以下平台特定的说明:

bun add @capgo/capacitor-proximity
bunx cap sync

导入

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

API概述

`enable`

启用近距离监控。

在 iOS 上，这会启用 UIDevice.isProximityMonitoringEnabled。在 Android 上，这会开始监听 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`

Section titled “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`

Section titled “Source Of Truth”

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

This page is generated from the plugin’s

Source Of Truth src/definitions.ts. Re-run the sync when the public API changes upstream.

继续从开始使用

如果您正在使用 开始使用 to plan dashboard and API operations, connect it with 使用@capgo/capacitor-proximity 为native能力在使用@capgo/capacitor-proximity API概述为API概述中的实现细节介绍为介绍中的实现细节 API密钥 Capgo API Keys, 和设备 Capgo __CAPGO_KEEP_0__ Devices.