开始

安装

您可以使用我们的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 为native能力在使用@capgo/capacitor-proximity API概述 为API概述的实现细节 介绍 为介绍的实现细节 API密钥 Capgo API Keys, 和 设备 Capgo __CAPGO_KEEP_0__ Devices.