Getting Started

Copiez une invite de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.

        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

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

Installer le plugin
Fenêtre de terminal
```
bun add @capgo/capacitor-privacy-screen
```
Synchroniser les plateformes natives
Fenêtre de terminal
```
bunx cap sync
```
Examiner le comportement de la plateforme
- Lisez le Notes iOS pour le comportement du commutateur d'applications.
- Lisez le Notes Android for screenshot and recording behavior.

Comportement par défaut

Le plugin active la protection de la vie privée automatiquement lors du chargement de l'implémentation native.

Sur iOS, le plugin cache votre application lors de la génération de la capture d'écran de l'application Switcher.
Sur Web, le plugin conserve un drapeau activé en mémoire uniquement pour la parité __CAPGO_KEEP_0__.
Sur le Web, le plugin conserve un drapeau activé en mémoire uniquement pour la parité API.

Utilisation de base

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

Quand désactiver temporairement

Utilisez disable() seulement lorsque l'écran actuel doit rester visible dans les aperçus du système ou être capturé par l'utilisateur, par exemple :

étapes de vérification de compte nécessitant des captures d'écran pour le support
flux de paiement ou de fournisseur d'identité qui nécessitent un aperçu d'un commutateur d'applications visible
sessions de débogage contrôlées sur des appareils fiables

Rétablir la protection immédiatement après avec enable().

Continuez de Getting Started

Si vous utilisez Getting Started pour planifier la sécurité et la conformité, connectez-l’à En utilisant @capgo/capacitor-écran de confidentialité pour la capacité native dans En utilisant @capgo/capacitor-écran de confidentialité, Chiffrement pour le détail d'implémentation dans Chiffrement, Conformité pour le détail d'implémentation dans Conformité, Capgo Scanner de sécurité pour le flux de travail du produit dans Capgo Scanner de sécurité. Capgo Sécurité pour le flux de travail du produit dans Capgo Sécurité.