@capgo/capacitor-inappbrowser

概要

@capgo/capacitor-inappbrowser apps Capacitor に 2 つのブラウザパスを提供します。 open() システムブラウザの経験と openWebView() 管理されたネイティブ WebView の経験を提供します。アプリは WebView をサイズ変更、非表示、メッセージを送信、スクリプトを実行、プロキシを設定、レイヤーを追加することができます。Ionic UI と統合することができます。

ページが単純な外部ブラウザでは十分ではない場合に使用してください: OAuth とチェックアウト フロー、埋め込まれたサポート ポータル、支払い画面、ビデオ カウント、ドキュメント ポータル、インタラクティブな Web アプリ、またはアプリがライブ Web コンテンツにネイティブのコントロールを必要とするいかなるフローでも

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

一般的な使用例

• イオニックまたはCapacitorのUIをライブブラウザページの上に表示します。 toBack, sendToBack(), bringToFront(), transparentBackground, dispatchInputEvent().
• 部分スクリーンのブラウザ、下部シート、ピクチャーインピクチャーWebビューをビルドします。 width, height, x, y, updateDimensions().
• ユーザーはAndroidとiOSの両方でカスタムサイズのブラウザフレームの外側のCapacitorアプリをタップできます。
• チェックアウト、ログイン、サポート、またはアカウント切り替えフローの実行に、永続的なウェブサイトストレージを使用せずに persistWebViewData: false 、 clearAllBrowsingData().
• 複数のブラウザインスタンスをロードして保持します。 hidden, hide()日本語 show() ページの状態を保存しながら
• 高度なWebアプリケーションを埋め込むことができます。リクエストのプロキシ、ファイルのアップロード、ダウンロード、ポップアップの制御、Google Payのサポート、リンクの処理、およびアプリからページへのメッセージングが必要な場合 _blank 基本機能

「基本機能」セクション

• open - Android で Chrome Custom Tabs を使用して URL を開きます。 SFSafariViewController iOSで。
• openWebView - ネイティブアプリUIの後ろにあるブラウザにクリック、タッチ、スクロールイベントを転送します。
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent - iOSでChromeカスタムタブを開きます。
• updateDimensions - AndroidでChromeカスタムタブを開きます。
• hide / show - WebViewを管理している場合、WebViewsをロードし、削除または復元するときに、ネイティブの表示を維持します。
• postMessage / executeScript - Capacitorアプリと、管理ページ内で実行されているJavaScriptを接続します。
• clearAllBrowsingData / persistWebViewData - Cookie、キャッシュ、ストレージ、IndexedDB、セッションの永続化を制御します。
• handleDownloads- プロキシルール、ポップアップイベント - ドキュメントポータル、アップロードフロー、支払いページ、埋め込まれたWebアプリをサポートします。

Public API

メソッド	説明
goBack	WebViewの履歴を戻すことが可能であれば戻します。
open	URLを開き、フルスクリーンで新しいウィンドウに表示します。AndroidではChromeカスタムタブを使用し、iOSではSFSafariViewControllerを使用します。
clearCookies	URLのクッキーをクリアします。 When id 省略された場合、すべての開いているWebViewsに適用されます。
clearAllCookies	クッキーをすべて削除 When id 省略すると、すべての開いているWebビューに適用されます。
clearCache	キャッシュを削除 When id 省略すると、すべての開いているWebビューに適用されます。
clearAllBrowsingData	デフォルトのストアと管理されたWebビューからクッキー、キャッシュ、ローカルストレージ、セッションストレージ、IndexedDB、他のブラウジングデータを削除します。
getCookies	特定のURLのCookieを取得します。
close	Webビューを閉じます。 When id 省略すると、現在アクティブなWebビューを閉じます。
hide	Webビューを非表示にします。 show() を使用して、元に戻すことができます。 When id 省略すると、現在アクティブなWebビューをターゲットにします。
show	以前のWebビューを表示します。 When id 省略すると、現在アクティブなWebビューをターゲットにします。
sendToBack	ホストの WebView の背後にあるネイティブブラウザを Capacitor に移動して、アプリの UI を上に表示します。
bringToFront	ホストの WebView の背後にあるブラウザを前面に戻します。
dispatchInputEvent	マネージドブラウザにクリック、タッチ、またはスクロール入力を送信します。座標はブラウザのビュー ポートに基づいています。
openWebView	ツールバーと拡張機能、カメラアクセス、ファイルアクセス、イベントリスナー、JavaScriptのインジェクション、双方向通信などを備えた新しいウェブビューでURLを開きます。
executeScript	InAppBrowserウィンドウにJavaScript code をインジェクトします。省略すると、すべての開いているウェブビューで実行されます。 id 省略すると、すべての開いているウェブビューで実行されます。
postMessage	イベントをウェブビュー（インアプリブラウザ）に送信します。ページ内でリスンします。 window.addEventListener('messageFromNative', listenerFunc). The detail payload は JSON としてシリアライズ可能でなければなりません。 When id 移動
takeScreenshot	イベント id イベント
setUrl	URLを設定します。省略した場合、現在のwebviewをターゲットにします。 id webviewのURLの変更をリスンする、openWebViewのみ。
addListener	webviewのURLの変更をリスンする。
addListener	onBrowserLoaded buttonNearDoneClickwebviewのclose clickをリスンする、openWebViewのみ。 id.
addListener	開いた WebView のみでクリックを待ちます。
addListener	webviewからイベントを受け取ったときに発火します。page内で使用し、payloadはJSONシリアライズ可能なものでなければなりません。
addListener	イベントがウェブビューからアプリに送信されたときに発生します。使用 window.mobileApp.postMessage(...) ページが読み込まれたときに発火します。
addListener	スクリーンショットがプラグイン API、ネイティブのスクリーンショットボタン、またはインジェクションされたJavaScriptブリッジからキャプチャされるたびにトリガーされます。
addListener	__CAPGO_KEEP_0__
addListener	__CAPGO_KEEP_0__
addListener	ネイティブのダウンロード処理がローカルにファイルを保存した後、トリガーされます。有効にするには handleDownloads: true ウェブビューを開いたときに
addListener	ネイティブのダウンロード処理が失敗したときにトリガーされます。有効にするには handleDownloads: true ウェブビューを開いたときに
addListener	ページがポップアップ/新しいウィンドウを開いたときにトリガーされます。返されたポップアップIDを使用して executeScript, postMessage, show, hide、 close.
addListener	ネイティブランタイムによって委任されたプロキシされた要求をリスンします。代わりに addProxyHandler() 直接呼び出すのではなく
addListener	ネイティブランタイムによって委任されたプロキシされた要求をリスンします。代わりに captureConsoleLogs: true ウェブビューを開いたときに
handleProxyRequest	直接呼び出すのではなく addProxyHandler() JavaScriptコンソール出力を受信するために、管理ページによって発行されることをリスンします。有効にするには phase 返信する際に手動で proxyRequest リスナー。
removeAllListeners	このプラグインのすべてのリスナーを削除します。
reload	現在のWebページを再読み込みします。
updateDimensions	Webビューのサイズと位置を実行時で変更できます。 id 省略すると、現在のWebビューを対象にします。
setEnabledSafeTopMargin	Webビューの有効な上部マージンを実行時で設定します。省略すると、現在のWebビューを対象にします。Web上では、このメソッドは無効であり、レイアウトを変更することなく解決します。 id Webビューの有効な下部マージンを実行時で設定します。省略すると、現在のWebビューを対象にします。
setEnabledSafeBottomMargin	ウェブビューの有効な安全な下部マージンを実行時で設定します。ウェブビューの安全な下部マージンを有効にすると、ユーザーが画面の下部にスクロールすると、安全な領域が表示されます。 id Webビューの有効な下部マージンを実行時で設定します。省略すると、現在のWebビューを対象にします。
openSecureWindow	リダイレクトURLを;モバイルでは、カスタムリダイレクトURIをアプリの設定で登録します。 BroadcastChannelモバイルでは、カスタムリダイレクトURIをアプリの設定で登録します。

リファレンス値

インアプリブラウザーやWebViewを開くときにツールバーのオプションと共に使用する値です。

ツールバーの種類

値	ユーザーは
activity	閉じると共に共有ボタンが付いたシンプルなツールバーを見つけるでしょう。
compact	閉じるボタンが付いたシンプルなツールバー
navigation	前進と戻るボタンが付いたフルナビゲーションツールバー
blank	ツールバーが付いていない

ソースオブトゥース

このリファレンスはsynced されています 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を使用して」 native capabilityのcapgo/capacitor-inappbrowser Capgo プラグインディレクトリ Capgo製品ワークフローについての Capgo プラグインディレクトリで Capacitor プラグインは Capgo によって提供されます Capgo製品ワークフローについての Capacitor プラグインは Capgo によって提供されます プラグインの追加または更新 プラグインの追加または更新の実装詳細については、 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについて