スタートガイド
インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。
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.
インストール
「インストール」セクションAIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins次に、以下のプロンプトを使用します:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-privacy-screen` plugin in my project.手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください:
-
プラグインをインストール
ターミナル bun add @capgo/capacitor-privacy-screen -
ネイティブプラットフォームを同期
ターミナル bunx cap sync -
プラットフォームの挙動を確認
- 以下の iOSの注意事項 をお読みください。
- 以下の Androidの注意点 スクリーンショットや画面録画の挙動を制御します。
デフォルトの動作
「デフォルトの挙動」セクションこのプラグインは、ネイティブ実装のロード時にプライバシー保護を自動的に有効にします。
- Androidでは、セキュアモードによってスクリーンショット、画面録画、および最近のアプリ一覧のプレビューがブロックされます。
- iOSでは、アプリスイッチャーのスクリーンショット生成時にアプリを非表示にします。
- Webでは、API との互換性を維持するためだけに、メモリ内に有効フラグを保持します。
基本的な使い方
「基本的な使い方」セクション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);よくある落とし穴
「よくある落とし穴」セクション- 一時的に無効化: スクリーンショットが必要なサポートや決済フローの後は、すぐに有効に戻してください。
- Androidのオーバーレイ: ディムオーバーレイの挙動は設定可能です。デフォルトを変更する前にAndroidのドキュメントページを確認してください。
- Webでのパリティ:
isEnabled()Web上ではメモリ内のフラグのみが反映され、OSレベルの保護は適用されません。
一時的に無効化すべきケース
「一時的に無効化すべきケース」というセクション使用する disable() 現在の画面をシステムプレビューに表示したままにする必要がある場合や、ユーザーがキャプチャできるようにする場合にのみ無効化します。例:
- サポートのためにスクリーンショットが必要となるアカウント認証ステップ
- アプリスイッチャーのプレビュー表示が必要な、決済やIDプロバイダーのフロー
- 信頼できるデバイス上での制御されたデバッグセッション
Restore protection immediately afterward with enable().
Getting Startedの続きを進める
「Getting Started からの続き」セクション使用している場合 スタートガイド セキュリティとコンプライアンスを計画するには、これを以下と連携させてください @capgo/capacitor-privacy-screen の使用方法 Using @capgo/capacitor-privacy-screen でのネイティブ機能について 暗号化 暗号化の実装詳細について コンプライアンス コンプライアンスの実装詳細について Capgo セキュリティスキャナー Capgo Security Scanner のプロダクトワークフローについては、 Capgo のセキュリティ Capgo Security におけるプロダクトワークフロー向けに。