开始入门

安装

您可以使用我们的 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上游发生变化时，请重新运行同步。

从开始

如果您正在使用 开始使用 为计划仪表板和API操作连接它 使用@capgo/capacitor-proximity 在使用@capgo/capacitor-proximity中 API概述 在API概述中了解实现细节 介绍 在介绍中了解实现细节 API密钥 在API密钥中了解实现细节,并 设备 __CAPGO_KEEP_0__