跳到主要内容
版本：v7

@capacitor/privacy-screen

隐私屏幕（Privacy Screen）插件提供防止敏感信息在应用切换器和离开应用时可见的功能。

注意： 此插件仅支持 Android 和 iOS 平台，不适用于 Web 平台。

安装​

npm install @capacitor/privacy-screen@latest-7
npx cap sync

平台说明​

Android​

FLAG_SECURE 行为​

启用隐私屏幕后，插件会自动向窗口应用 Android 的 FLAG_SECURE 标志。这提供了全面的内容保护：

  • 截图防护：防止用户对您的应用进行截图或屏幕录制
  • 应用切换器/最近任务：当应用出现在最近任务视图中时，FLAG_SECURE 会导致系统显示黑屏或应用 FLAG_SECURE 之前捕获的最后一帧（通常为空白）
  • 非安全显示保护：防止窗口内容显示在非安全显示屏上，例如电视、投影仪或镜像到不受信任的设备
  • 实时视图保护：在 FLAG_SECURE 无法完全保护内容的情况下（例如使用手势导航或可持续数分钟的实时视图片段），插件会显示一个临时的隐私屏幕覆盖层。此覆盖层可通过 dimBackground（显示变暗覆盖层）进行配置，或默认显示启动画面。
导航方式差异​

隐私屏幕的行为根据用户离开应用的方式而有所不同：

  • 最近任务按钮/手势：查看应用切换器时，隐私对话框会按配置显示
  • 主页按钮：FLAG_SECURE 确保应用切换器快照中的内容保护
  • Activity 后台事件：通过 privacyModeOnActivityHidden 单独控制，适用于生物识别提示等场景

使用方法​

基本使用​

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

// 使用默认设置启用隐私屏幕
await PrivacyScreen.enable();

// 使用平台特定配置启用
await PrivacyScreen.enable({
  android: {
    dimBackground: true,
    privacyModeOnActivityHidden: 'splash'
  },
  ios: {
    blurEffect: 'dark'
  }
});

// 禁用隐私屏幕
await PrivacyScreen.disable();

// 检查隐私屏幕是否已启用
const { enabled } = await PrivacyScreen.isEnabled();

按屏幕保护​

您可以在特定屏幕上通过进入屏幕时调用 enable() 和离开屏幕时调用 disable() 来启用和禁用隐私屏幕。注意：确保在屏幕之间导航时（包括使用返回导航时）调用适当的方法。

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

// 导航到安全屏幕时启用隐私屏幕
async function navigateToSecureScreen() {
  await PrivacyScreen.enable({
    android: { dimBackground: true },
    ios: { blurEffect: 'dark' }
  });
  // 导航到您的安全屏幕
}

// 导航到非安全屏幕时禁用
async function navigateToPublicScreen() {
  await PrivacyScreen.disable();
  // 导航到您的公共屏幕
}

API​

enable(...)​

enable(config?: PrivacyScreenConfig | undefined) => Promise<{ success: boolean; }>

启用隐私屏幕保护功能

参数类型描述
config
PrivacyScreenConfig
可选配置，用于平台特定行为

返回值： Promise<{ success: boolean; }>

disable()​

disable() => Promise<{ success: boolean; }>

禁用隐私屏幕保护功能

返回值： Promise<{ success: boolean; }>

isEnabled()​

isEnabled() => Promise<{ enabled: boolean; }>

检查隐私屏幕当前是否已启用

返回值： Promise<{ enabled: boolean; }>

Interfaces​

PrivacyScreenConfig​

属性类型
android{ dimBackground?: boolean; preventScreenshots?: boolean; privacyModeOnActivityHidden?: 'none' | 'dim' | 'splash'; }
ios{ blurEffect?: 'none' | 'light' | 'dark'; }

Contents

编辑此页