Getting Started

Copiez un prompt 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 plug-in. 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 plug-in en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

Installer le plug-in
Fenêtre de terminal
```
bun add @capgo/capacitor-privacy-screen
```
Synchroniser les plateformes natives
Fenêtre de terminal
```
bunx cap sync
```
Réviser le comportement de la plateforme
- Lire le Notes iOS pour le comportement de l'application Switcher.
- Lire le Notes Android pour le comportement de capture d'écran et d'enregistrement.

Comportement par défaut

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

Sur Android, le mode sécurisé bloque les captures d'écran, la capture de l'enregistrement de l'écran et la prévisualisation des applications récentes.
Sur iOS, le plugin masque votre application lors de la génération de la capture de l'appareil de changement d'applications.
Sur Web, le plugin conserve un drapeau activé en mémoire uniquement pour API parité.

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 le désactiver temporairement

Utiliser disable() seulement lorsque l'écran actuel doit rester visible dans les prévisualisations 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 d'identité-providence nécessitant une prévisualisation du commutateur d'application visible
sessions de débogage contrôlées sur des appareils de confiance

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

Continuer depuis Getting Started

Si vous utilisez Getting Started pour planifier la sécurité et la conformité, connectez-le avec Utiliser @capgo/capacitor-écran de confidentialité pour la capacité native dans Utiliser @capgo/capacitor-écran de confidentialité, Chiffrement pour les détails d'implémentation dans l'Encryption, Conformité pour les détails d'implémentation dans la Conformité, Capgo Scanner de sécurité pour le flux de travail du produit dans Capgo Scanner de sécurité, et Capgo Sécurité for the product workflow in Capgo Security.