跳到主要内容
版本：v8

@capacitor/privacy-screen

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

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

安装​

npm install @capacitor/privacy-screen
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; }>

启用隐私屏幕保护

ParamTypeDescription
config
PrivacyScreenConfig
平台特定行为的可选配置

Returns: Promise<{ success: boolean; }>

disable()​

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

禁用隐私屏幕保护

Returns: Promise<{ success: boolean; }>

isEnabled()​

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

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

Returns: Promise<{ enabled: boolean; }>

Interfaces​

PrivacyScreenConfig​

PropType
android{ dimBackground?: boolean; preventScreenshots?: boolean; privacyModeOnActivityHidden?: 'none' | 'dim' | 'splash'; }
ios{ blurEffect?: 'none' | 'light' | 'dark'; }

Contents

编辑此页