Prise en main

Copiez un prompt de configuration incluant 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 IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque 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
```
Vérifier le comportement de la plateforme
- Lire le Notes iOS pour le comportement de l'app switcher.
- Lire le Notes Android for screenshot and recording behavior.

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, l'enregistrement d'écran et l'aperçu dans le sélecteur d'applications.
Sur iOS, le plugin masque votre application lors de la génération de l'aperçu dans l'app switcher.
Sur le Web, le plugin conserve un flag activé en mémoire uniquement pour la parité avec 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);

Erreurs courantes

Désactivation temporaire : réactivez immédiatement après les flux de support ou de paiement nécessitant des captures d'écran.
Overlays AndroidLe comportement de l'overlay de dimming est configurable ; consultez la doc Android avant de modifier les paramètres par défaut.
Parité web: isEnabled() sur le web, cela ne reflète que le flag en mémoire, pas la protection au niveau de l'OS.

Quand le désactiver temporairement

Utiliser disable() uniquement lorsque l'écran actuel doit rester visible dans les aperçus système ou être capturable 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'authentification nécessitant un aperçu visible du sélecteur d'applications
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 Prise en main pour planifier la sécurité et la conformité, connectez-l’à Utilisation de @capgo/capacitor-privacy-screen pour la fonctionnalité native de la page Utilisation de @capgo/capacitor-privacy-screen, Chiffrement pour les détails d'implémentation du chiffrement, Conformité pour les détails d'implémentation de la conformité, Scanner de sécurité Capgo pour le workflow produit dans Capgo Security Scanner, et Capgo et la sécurité pour le workflow produit dans Capgo Security.