快速入门

复制包含安装步骤和该插件完整 Markdown 指南的配置 prompt。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-privacy-screen`
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/privacy-screen/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 skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

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

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

安装插件
终端窗口
```
bun add @capgo/capacitor-privacy-screen
```
同步原生平台
终端窗口
```
bunx cap sync
```
查看平台行为
- 阅读 iOS 注意事项关于 App Switcher 的行为。
- 阅读 Android 注意事项关于截屏和录屏行为。

默认行为

当原生实现加载时，该插件会自动启用隐私保护。

在 Android 上，安全模式会阻止截屏、屏幕录制以及最近任务预览。
在 iOS 上，插件会在生成 App 切换器快照时隐藏你的应用。
在 Web 端，插件仅在内存中保留启用标志，只为与 API 保持一致。

基础用法

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

await PrivacyScreen.disable();

// Run a flow where screenshots or previews are temporarily allowed.

await PrivacyScreen.enable();

const { enabled } = await PrivacyScreen.isEnabled();
console.log('Privacy screen enabled:', enabled);

常见坑点

临时禁用：在需要截图进行支持或支付流程后立即重新启用。
Android 覆盖层：变暗覆盖层行为可配置，更改默认设置前请阅读 Android 文档页面。
Web 端一致性: isEnabled() 在 Web 端仅反映内存中的标志位，不具备操作系统级别的保护。

何时需要临时禁用它

使用 disable() 仅当当前屏幕应在系统预览中可见，或允许用户截屏时使用，例如：

需要截图以进行技术支持的账户验证步骤
需要显示应用切换器预览的支付或身份验证流程
在受信任设备上进行的受控调试会话

随后使用以下方式立即恢复保护 enable().

从入门指南继续

如果你正在使用 快速入门 来规划安全与合规，请结合使用 @capgo/capacitor-privacy-screen 用于“使用 @capgo/capacitor-privacy-screen”中的原生能力，加密了解 Encryption 的实现细节，合规性了解合规部分的实现细节， Capgo 安全扫描器用于 Capgo Security Scanner 中的产品工作流，以及 Capgo 安全用于 Capgo Security 中的产品工作流。