@capacitor-community/privacy-screen

Privacy Screen

@capacitor-community/privacy-screen

Capacitor Privacy Screen Plugin

Introduction

⚡️ Capacitor plugin that protects your app from displaying a screenshot in Recents screen/App Switcher.

On Android, this plugin sets the FLAG_SECURE flag to treat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.
On iOS, this plugin hides the webview window when the app is no longer active and loses focus (UIApplicationWillResignActiveNotification) so that a gray screen is shown instead.

Maintainers

Maintainer	GitHub	Social
Robin Genz	robingenz	@robin_genz

Installation

Capacitor 3.x

npm install @capacitor-community/privacy-screen@next
npx cap sync

Capacitor 2.x

npm install @capacitor-community/privacy-screen
npx cap sync

On iOS, no further steps are needed.

On Android, register the plugin in your main activity:

import com.getcapacitor.plugin.privacyscreen.PrivacyScreen;

public class MainActivity extends BridgeActivity {

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Initializes the Bridge
    this.init(
        savedInstanceState,
        new ArrayList<Class<? extends Plugin>>() {
          {
            // Additional plugins you've installed go here
            // Ex: add(TotallyAwesomePlugin.class);
            add(PrivacyScreen.class);
          }
        }
      );
  }
}

Configuration

No configuration required for this plugin.

Usage

The plugin only needs to be installed. The protection is enabled by default. However, you have the option to enable/disable the protection:

import { Plugins } from '@capacitor/core';
import '@capacitor-community/privacy-screen';

const enable = async () => {
  await Plugins.PrivacyScreen.enable();
};

const disable = async () => {
  await Plugins.PrivacyScreen.disable();
};

API

• enable()
• disable()

enable()

enable() => Promise<void>

Enables the privacy screen protection.

Only available for Android and iOS.

Since: 1.1.0

disable()

disable() => Promise<void>

Disables the privacy screen protection.

Only available for Android and iOS.

Since: 1.1.0

Changelog

See CHANGELOG.md.

License

See LICENSE.