# @capgo/capacitor-privacy-screen 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-privacy-screen/

版本：8\.3\.14
npm 元数据更新时间：2026-10-15T05:53:10.931Z
中文译文更新时间：2026-11-09T03:40:13.794Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-privacy-screen
原文对照：https://npmcn.com/package/%40capgo/capacitor-privacy-screen/?lang=original
项目主页：https://capgo.app/docs/plugins/privacy-screen/
源码仓库：https://github.com/Cap-go/capacitor-privacy-screen

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：77.1 kB，28 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-03-16T23:38:08.660Z
- 最新版本发布：2026-10-15T05:53:10.606Z
- 近 30 天下载量：44092（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 19 个）

## 中文简介

在Android截图中保护应用内容并遮蔽iOS应用开关快照.

## 安装

```sh
npm install @capgo/capacitor-privacy-screen
```

也可以使用：`pnpm add @capgo/capacitor-privacy-screen`、`yarn add @capgo/capacitor-privacy-screen`、`bun add @capgo/capacitor-privacy-screen`

## README

# @ capgo/ 电容器 -- privacy -- 屏幕

在您的 Capacitor app 中保留敏感屏幕: 屏蔽截图和屏幕记录在 Android 上, 并将您的内容隐藏在 iOS app 切换器中. 用于银行、保健和通讯应用程序.

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-privacy-screen)](https://capgo.app/?ref=plugin_privacy_screen)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_privacy_screen)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_privacy_screen) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-privacy-screen` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _加上@capgo/capor-privacy-screen到我的Capacitor应用上并把它接上_ [代理设置指南](https://capgo.app/agents/?ref=plugin_privacy_screen) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_privacy_screen)

![@capgo/capacitor-privacy-screen for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-privacy-screen/main/assets/github-social-preview.png)

## 主要特点

-   **启用和禁用**数字 : `enable()` 财务报告和审定财务报表 `disable()` 运行时打开和关闭保护.
-   **机器人**: 组 `FLAG_SECURE`,它屏蔽了截图和屏幕记录,在近期的应用中有一个可配置的覆盖.
-   **iOS系统**: 将应用软件内容从应用切换器快照中隐藏出光线或暗模糊,或您的发射屏幕.
-   **状态**数字 : `isEnabled()` 报告当前状况.
-   **平台**: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-22. 隐私控制端口ScreenPlugin. 网络只跟踪启用状态 .

保护敏感的应用内容不被出现在Android截图和iOS应用-switcher预览中.

Capgo 隐私屏幕插件是一个 Capacitor 端口: [隐私](https://github.com/martinkasa/PrivacyScreenPlugin) 与现代本土实施 Capacitor 8.

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/privacy-screen/ (中文(简体) )](https://capgo.app/docs/plugins/privacy-screen/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |

> **说明:** 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的电容安装的版本 。 只有最新的主要版本得到积极维护.

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-privacy-screen` plugin in my project.
```

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capgo/capacitor-privacy-screen
npx cap sync
```

## 配置

保护默认被禁用. 在本地启动时启用 Capacitor 配置 :

```ts
import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  appId: 'com.example.app',
  appName: 'Example',
  webDir: 'dist',
  plugins: {
    PrivacyScreen: {
      enabled: true,
      android: {
        dimBackground: true,
        privacyModeOnActivityHidden: 'splash',
      },
      ios: {
        blurEffect: 'dark',
      },
    },
  },
};

export default config;
```

## 使用量

```ts
import { PrivacyScreen } from '@capgo/capacitor-privacy-screen';

await PrivacyScreen.enable({
  android: {
    dimBackground: true,
    privacyModeOnActivityHidden: 'splash',
  },
  ios: {
    blurEffect: 'dark',
  },
});

const { enabled } = await PrivacyScreen.isEnabled();

await PrivacyScreen.disable();

await PrivacyScreen.enable();

// Perform a flow where screenshots or previews should be protected.

await PrivacyScreen.disable();
```

当保护只应用于特定的屏幕或流量时使用JavaScript调用.

## 行为

-   机器人用途 `WindowManager.LayoutParams.FLAG_SECURE`,它从截图中隐藏了应用的内容,屏幕录制,以及最近的应用预览.
-   Android可以显示近期应用和活性隐藏状态的暂时暗淡或喷出覆被.
-   iOS在启用时将应用程序内容放置在安全的渲染子树上并添加一个临时的覆盖,而应用程序则主动辞职,因此应用程序开关快照不会暴露出您的内容,带有可选的光线或暗模糊.
-   Web 为 API 等值保留了内嵌被启用的旗帜,但浏览器无法强制本地隐私-屏幕行为.

## API 密码

-   [`enable(...)`](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-enable)
-   [`disable()`](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-disable)
-   [`isEnabled()`](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-isenabled)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-interfaces)

Capacitor API用于保护app内容免受截图,屏幕录制,以及本地的app-switcher预览.

### 启用(...)

```typescript
enable(config?: PrivacyScreenConfig | undefined) => Promise<PrivacyScreenActionResult>
```

启用隐私屏幕保护 .

在Android上这个集 `FLAG_SECURE`,也可以阻断截图和屏幕记录. 在 iOS 上, 启用时将应用内容置于安全的渲染子树中 在应用程序背景化时添加一个覆盖, 因此应用程序内容不会 出现在应用程序开关快照中.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`config`** | `[PrivacyScreenConfig](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-privacyscreenconfig)` | 可选平台特定行为. |

**回返情况:** `Promise<[PrivacyScreenActionResult](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-privacyscreenactionresult)>`

* * *

### 禁用( c)

```typescript
disable() => Promise<PrivacyScreenActionResult>
```

禁用隐私屏幕保护 .

仅在明确希望当前屏幕在系统预览中保持可见时才使用此功能.

**回返情况:** `Promise<[PrivacyScreenActionResult](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-privacyscreenactionresult)>`

* * *

### 已启用

```typescript
isEnabled() => Promise<PrivacyScreenStatus>
```

返回当前启用状态 .

**回返情况:** `Promise<[PrivacyScreenStatus](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-privacyscreenstatus)>`

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<PluginVersionResult>
```

返回本地执行版本标记 .

**回返情况:** `Promise<[PluginVersionResult](https://npmcn.com/package/%40capgo/capacitor-privacy-screen/#readme-pluginversionresult)>`

* * *

### 接口

#### 隐私行动结果

当隐私保护被切换时返回结果 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`success`** | `boolean` | 本地操作是否完成 . |

#### 隐私

本地启动和运行时间配置用于隐私保护.

| Prop | 类型 | 说明 | 默认 |
| --- | --- | --- | --- |
| **`enabled`** | `boolean` | 当本地插件加载时自动启用隐私保护 。 此选项仅从 Capacitor 配置读取 . | `false` |
| **`android`** | `{ dimBackground?: boolean; preventScreenshots?: boolean; privacyModeOnActivityHidden?: 'none' | 'dim' | 'splash'; }` | 只有机器人的行为. |  |
| **`ios`** | `{ blurEffect?: 'none' | 'light' | 'dark'; }` | 只有iOS行为. |  |

#### 隐私状况

当前隐私屏幕状态 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`enabled`** | `boolean` | 目前是否启用隐私保护 . |

#### 插件变压器

插件版本有效载荷 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`version`** | `string` | 版本标识符由平台执行返回. |

## 常见问题

### @capgo/capacitor-privacy-screen 是什么？

在Android截图中保护应用内容并遮蔽iOS应用开关快照\.

### 如何安装 @capgo/capacitor-privacy-screen？

在项目目录运行 npm install @capgo/capacitor-privacy-screen，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-privacy-screen 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-privacy-screen 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-privacy-screen 可以商用吗？

@capgo/capacitor-privacy-screen 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-privacy-screen 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-privacy-screen 在 2026/10/09 – 2026/11/07 这 30 天内被下载 44,092 次，日均约 1,470 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-privacy-screen 还在维护吗？

最新版本 8\.3\.14 发布于 2026/10/15（25 天前）；至今共发布 19 个版本，其中过去 12 个月发布了 19 个；首次发布于 2026/03/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。