@capgo/capacitor-inappbrowser

Capacitorのネイティブインアプリブラウザ

概要

@capgo/capacitor-inappbrowser gives Capacitor apps two browser paths: open() 管理されたネイティブのWebViewのパス openWebView() Ionic UIと組み合わせて、サイズ、非表示、メッセージ、スクリプト、プロキシ、レイヤーを実行できます。

外部ブラウザでは実行できない複雑なページの場合に使用してください: OAuth とチェックアウトフロー、埋め込まれたサポートポータル、決済画面、ビデオコール、ドキュメントポータル、インタラクティブなWebアプリ、またはライブWebコンテンツにネイティブなコントロールが必要なフローなど。

パッケージ名が変更されました。

一般的な使用例

ライブブラウザページの上に、Ionic または Capacitor の UI を表示します。 toBack, sendToBack(), bringToFront(), transparentBackground, および dispatchInputEvent().
部分スクリーンのブラウザ、下部シート、ピクチャーインピクチャー Web ビューを作成するには width, height, x, y, および updateDimensions().
Android と iOS でカスタムサイズのブラウザ枠外で Capacitor アプリをタップしてください。
チェックアウト、ログイン、サポート、またはアカウント切り替えフローを実行するには、パーシステントウェブサイトストレージを使用せずに persistWebViewData: false 、および clearAllBrowsingData().
複数のブラウザインスタンスをロードして hidden, hide(), そして show() ページの状態を保存する
Google Pay のサポート、リンクハンドリング、そしてアプリからページへのメッセージングを必要とする高度な Web アプリを埋め込む _blank Core Capabilities

Core Capabilities

open - カスタムツールバー、サイズ、ネイティブナビゲーション、メッセージング、スクリプティング、プロキシ、ダウンロード、ポップアップ、データコントロールを備えた管理されたネイティブ WebView を開く SFSafariViewController - __CAPGO_KEEP_0__ ホスト WebView の後ろまたは上に移動する管理されたブラウザ
openWebView - ネイティブアプリ UI の後ろにあるブラウザにクリック、タッチ、スクロールイベントを転送する
sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
dispatchInputEvent -
updateDimensions - WebViewのサイズと位置を変更し、ページを再読み込みせずに実行します。
hide / show - マネージド WebViewを削除または復元するときに、ロードしたままにします。
postMessage / executeScript - Capacitorアプリと、JavaScriptが実行されているマネージドページの間で接続します。
clearAllBrowsingData / persistWebViewData - Cookie、キャッシュ、ストレージ、IndexedDB、セッションの永続化を制御します。
handleDownloads- プロキシルール、ポップアップイベント - ドキュメントポータル、アップロードフロー、支払いページ、埋め込まれたWebアプリをサポートします。

Public API

メソッド	説明
`goBack`	WebViewの履歴を戻します。
`open`	URLを開きます。新しいウィンドウでフルスクリーンに表示します。AndroidではChromeカスタムタブを使用し、iOSではSFSafariViewControllerを使用します。
`clearCookies`	URLのクッキーをクリアします。 `id` __CAPGO_KEEP_0__ (全てのオープンウェブビューに適用されます。)
`clearAllCookies`	すべてのクッキーを削除する When `id` __CAPGO_KEEP_0__ (全てのオープンウェブビューに適用されます。)
`clearCache`	キャッシュをすべて削除する When `id` __CAPGO_KEEP_0__ (全てのオープンウェブビューに適用されます。)
`clearAllBrowsingData`	デフォルトのストアとマネージドウェブビューからクッキー、キャッシュ、ローカルストレージ、セッションストレージ、IndexedDB、他のブラウジングデータを削除します。
`getCookies`	特定の URL のクッキーを取得します。
`close`	ウェブビューを閉じます。 When `id` __CAPGO_KEEP_0__ (アクティブなウェブビューを閉じます。)
`hide`	ウェブビューを非表示にします。閉じません。 show() を使用して元に戻します。 When `id` __CAPGO_KEEP_0__ (アクティブなウェブビューをターゲットにします。)
`show`	以前のウェブビューを表示します。 When `id` は省略されると、現在のウェブビューをターゲットにします。
`sendToBack`	Moves the native browser behind the Capacitor host WebView so app UI can appear above it.
`bringToFront`	ホストのWebViewの背後にあるブラウザを前面に戻します。
`dispatchInputEvent`	マネージドブラウザにクリック、タッチ、またはスクロール入力を送信します。座標はブラウザのビューポートに相対的です。
`openWebView`	ツールバーと、カメラアクセス、ファイルアクセス、イベントリスニング、JavaScriptのインジェクション、双方向通信など、強化された機能を持つ新しいウェブビューでURLを開きます。
`executeScript`	Injects JavaScript code into the InAppBrowser window. When `id` は省略されると、すべての開いているウェブビューで実行されます。
`postMessage`	ウェブビュー (インアプリブラウザ) にイベントを送信します。ページで `window.addEventListener('messageFromNative', listenerFunc)`を使用してリスンします。 `detail` ウェブビューのペイロードはJSONシリアライズ可能でなければなりません。 `id` は省略されると、すべての開いているウェブビューにブロードキャストされます。
`takeScreenshot`	現在のウェブビューのビューポートをPNG形式のスクリーンショットとしてキャプチャします。 `id` 省略すると、現在のウェブビューをターゲットにします。
`setUrl`	ウェブビューのURLを設定します。省略すると、現在のウェブビューをターゲットにします。 `id` openWebViewのみで、URLの変更をリスンします。
`addListener`	openWebViewのみで、送信されるイベントをリスンします。
`addListener`	openWebViewのみで、閉じるクリックをリスンします。 `buttonNearDoneClick`ユーザーが確認ボタンをクリックしたときに発火されます。ディスクリーマーが必要な場合、openWebViewのshareDisclaimerとcloseModalと一緒に使用します。 `id`.
`addListener`	アプリにイベントを送信するウェブビューからイベントが送信されたときに発火されます。Use event.detailをページ内で、payloadをJSONシリアライズ可能なものに保ちます。
`addListener`	プラグイン__CAPGO_KEEP_0__、ネイティブのスクリーンショットボタン、またはインジェクションされたJavaScriptブリッジからスクリーンショットがキャプチャされたときに発火されます。
`addListener`	ページが読み込まれたときに発火されます。 `window.mobileApp.postMessage(...)` openWebViewのみで、URLの変更をリスンします。
`addListener`	Will be triggered whenever a screenshot is captured from the plugin API, the native screenshot button, or the injected JavaScript bridge.
`addListener`	openWebViewのみで、閉じるクリックをリスンします。
`addListener`	ページ読み込みエラーが発生したときにトリガーされます。
`addListener`	ローカルにファイルを保存したときにネイティブダウンロードハンドリングが完了した後、トリガーされます。この機能を有効にするには `handleDownloads: true` Webビューを開いたときにトリガーされます。
`addListener`	ネイティブダウンロードハンドリングが失敗したときにトリガーされます。この機能を有効にするには `handleDownloads: true` Webビューを開いたときにトリガーされます。
`addListener`	ページがポップアップ/新しいウィンドウを開いたときにトリガーされます。返されたポップアップIDを `executeScript`, `postMessage`, `show`, `hide`と `close`.
`addListener`	ネイティブランタイムによって委譲されたプロキシされた要求をリスンします。代わりに `addProxyHandler()` を呼び出すのではなく、呼び出してください。
`addListener`	JavaScriptコンソール出力が管理ページによって発行されたときにトリガーされます。この機能を有効にするには `captureConsoleLogs: true` Webビューを開いたときにトリガーされます。
`handleProxyRequest`	ネイティブランタイムによって委譲されたプロキシされた要求をリスンします。代わりに `addProxyHandler()` 原生にプロキシの決定を送り返します。元の内容を前方に送ります。 `phase` 手動の返信の場合に使用します。 `proxyRequest` リスナー。
`removeAllListeners`	このプラグインのすべてのリスナーを削除します。
`reload`	現在のWebページを再読み込みします。
`updateDimensions`	Webビューのサイズと位置を変更できます。実行時にはサイズと位置を変更できます。 `id` 省略すると、現在のWebビューをターゲットにします。
`setEnabledSafeTopMargin`	Webビューの有効な安全上限のマージンを実行時に設定します。省略すると、現在のWebビューをターゲットにします。Web上では、このメソッドはレイアウトを変更せずに解決します。 `id` Webビューの有効な安全下限のマージンを実行時に設定します。省略すると、現在のWebビューをターゲットにします。Web上では、このメソッドはレイアウトを変更せずに解決します。
`setEnabledSafeBottomMargin`	安全なOAuth2ウィンドウを開きます。Web上では、リダイレクトされたURLを返します。 `id` Web上では、リダイレクトされたURLを返します。
`openSecureWindow`	Web上では、リダイレクトされたURLを返します。 `BroadcastChannel`;モバイルでは、カスタムリダイレクトURIをアプリの設定に登録してください。詳細は、HTML、Info.plist、AndroidManifestの例を参照してください。

Reference Values

これらの値を、インアプリブラウザまたはWebViewを開くときにツールバーのオプションと組み合わせて使用してください。

Value	ユーザーは
`activity`	閉じると共に共有ボタンが付いたシンプルなツールバー。
`compact`	閉じるボタンが付いたシンプルなツールバー。
`navigation`	前進と戻るボタンが付いたフルナビゲーションツールバー。
`blank`	ツールバーが付いていない。

真実の源

このリファレンスはsyncdから src/definitions.ts in capacitor-inappbrowser.

capgoから続けてください@capacitor/capgo-inappbrowser

__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-inappbrowserを使用している場合 capgo/capacitor-inappbrowser __CAPGO_KEEP_0__/__CAPGO_KEEP_1__-inappbrowserを使用して「capgo/capacitor-inappbrowserを使用して」「capgo/capacitor-inappbrowserを使用してnative capability」 Capgo プラグインディレクトリ Capgo製品ワークフロー向けに Capgo プラグインディレクトリ Capacitor Capgo によって提供されるプラグイン Capgo製品ワークフロー向けに Capacitor Capgo によって提供されるプラグインプラグインの追加または更新プラグインの追加または更新の実装詳細についてはイオニックエンタープライズプラグインの代替イオニックエンタープライズプラグインの代替の製品ワークフロー