跳到主要内容
版本:v7

@capacitor/privacy-screen

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

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

安装

npm install @capacitor/privacy-screen
npx cap sync

平台说明

Android

Android 上的隐私屏幕行为因使用的导航方式而异:

  • 使用手势导航或最近应用按钮时,隐私屏幕将按配置显示
  • 使用主页按钮退出应用时,系统必须回退到使用 FLAG_SECURE,因为这是在此场景下防止内容可见的唯一方法

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'; }