Getting Started

GitHub

Eine Einrichtungsvorlage mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.

        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.

Installation

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten aufgeführten plattformabhängigen Anweisungen befolgen:

Das Plugin installieren
Terminal-Fenster
```
bun add @capgo/capacitor-privacy-screen
```
Synchronisieren Sie native Plattformen
Terminal-Fenster
```
bunx cap sync
```
Überprüfen Sie die Plattformverhalten
- Lesen Sie die iOS-Hinweise für das App-Switcher-Verhalten.
- Lese die Android-Hinweise für das Screenshot- und Aufnahmeverhalten.

Standardverhalten

Der Plugin aktiviert die Datenschutzfunktion automatisch, wenn die native Implementierung geladen wird.

Auf Android blockiert der sichere Modus Screenshots, die Aufnahmeeinblendung und die Anzeige der kürzlich geöffneten Apps.
Auf iOS versteckt sich die App während der Erstellung eines App-Switcher-Snapshots.
Auf der Web-Seite wird ein in-Memory-Flag nur für die API-Parität gespeichert.

Basic usage

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);

Wenn Sie es vorübergehend deaktivieren möchten

Use disable() nur dann, wenn die aktuelle Bildschirmansicht in Systemvorschau oder von dem Benutzer aufgezeichnet werden soll, zum Beispiel:

Schritte zur Kontoverifizierung, die Screenshots für den Support benötigen
Zahlungs- oder Identitätsanbieter-Flüsse, die eine sichtbare App-Switcher-Vorschau benötigen
Kontrollierte Debugging-Sitzungen auf vertrauenswürdigen Geräten

Schutz wiederherstellen, sobald möglich, mit enable().

Weitermachen von Getting Started

Wenn Sie Capgo verwenden Zur Einführung um Sicherheit und Compliance zu planen, verbinden Sie es mit Mit @capgo/capacitor-Privacy-Screen für die native Fähigkeit im @capgo/capacitor-Privacy-Screen Encryption für die Implementierungsdetails in der Verschlüsselung, Compliance für die Implementierungsdetails in Compliance, Für den Produktworkflow in Capgo-Sicherheits-Scanner, und für den Produktworkflow in Capgo Security Scanner, und Für den Produktworkflow in Capgo-Sicherheit. für den Produktworkflow in Capgo Sicherheit.