开始

复制一个带有安装步骤和此插件的完整 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`

当请求近距离状态时返回的结果 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 上游发生变化时，请重新运行同步。

从开始就继续

If you are using __CAPGO_KEEP_0__ in Simplified Chinese, Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-proximity for the native capability in Using @capgo/capacitor-proximity, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices __CAPGO_KEEP_0__