@capgo/capacitor-inappbrowser

概要

@capgo/capacitor-inappbrowser Capacitor アプリに 2 つのブラウザ パスを提供します。 open() システム ブラウザ エクスペリエンス用のパスと openWebView() 管理されたネイティブ WebView を使用して、Ionic UI でサイズ、非表示、メッセージ、スクリプト、プロキシ、レイヤーを実行できます。

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

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

一般的な使用例

• ライブ ブラウザ ページの上に Ionic または Capacitor UI を表示します。 toBack, sendToBack(), bringToFront(), transparentBackground、 dispatchInputEvent().
• 部分画面ブラウザ、下部シート、ピクチャーインピクチャー ウェブビューを width, height, x, y、 updateDimensions().
• AndroidおよびiOSでカスタムサイズのブラウザフレーム外でCapacitorアプリをタップできるようにします。
• パーシスタントウェブサイトストレージなしでチェックアウト、ログイン、サポート、またはアカウント切り替えフローを実行する persistWebViewData: false 、 clearAllBrowsingData().
• 複数のブラウザインスタンスをロードし、ページ状態を保存する hidden, hide()、 show() ページの状態を維持する。
• リクエストプロキシ、ファイルアップロード、ダウンロード、ポップアップ制御、Google Payサポート、リンクハンドリング、およびアプリからページへのメッセージングを必要とする高度なWebアプリを埋め込む _blank Capgoの基本機能

context

• open Android または iOS で Chrome Custom Tabs を開きます。 SFSafariViewController iOSで利用可能です。
• openWebView カスタムツールバー、サイズ、ネイティブナビゲーション、メッセージング、スクリプティング、プロキシ、ダウンロード、ポップアップ、データコントロールのあるマネージドネイティブウェブビューを開きます。
• sendToBack / bringToFront - Moves a managed browser behind or above the Capacitor host WebView.
• dispatchInputEvent ネイティブアプリUIの後ろにあるブラウザにクリック、タッチ、スクロールイベントを転送します。
• updateDimensions ページを再読み込みせずにマネージドウェブビューのサイズと位置を変更します。
• hide / show マネージドウェブビューをロードしたままにし、またはそのネイティブプレゼンテーションを削除または復元します。
• postMessage / executeScript マネージドページ内で実行中のJavaScriptとCapacitorアプリを接続します。
• clearAllBrowsingData / persistWebViewData クッキー、キャッシュ、ストレージ、IndexedDB、セッションパーミッションを制御します。
• handleDownloadsプロキシルール、ポップアップイベント - ドキュメントポータル、アップロードフロー、支払いページ、埋め込まれたウェブアプリをサポートします。

パブリックAPI

メソッド	説明
goBack	WebViewの履歴を戻すことができる場合に戻します。
open	URLを開く新しいウィンドウフルスクリーン、AndroidではChromeカスタムタブ、iOSではSFSafariViewControllerを使用します。
clearCookies	URLのクッキーを消去するとき id 省略された場合、すべての開いているWebビューに適用されます。
clearAllCookies	すべてのクッキーを消去するとき id 省略された場合、すべての開いているWebビューに適用されます。
clearCache	キャッシュを消去するとき id 省略された場合、すべての開いているWebビューに適用されます。
clearAllBrowsingData	デフォルトのストアと管理されたWebビューからCookie、キャッシュ、ローカルストレージ、セッションストレージ、IndexedDB、他のブラウジングデータを消去します。
getCookies	URLの特定のURLに対してCookieを取得します。
close	ウェブビューを閉じます。省略時は、現在アクティブなウェブビューを閉じます。 id ウェブビューがアクティブの場合、省略される場合は閉じます。
hide	以前のウェブビューを表示します。省略時は、現在アクティブなウェブビューをターゲットにします。 id ホストウェブビューの後ろにあるネイティブブラウザを移動させて、アプリのUIを上に表示します。
show	ホストウェブビューの後ろにあるブラウザを前面に戻します。 id ホストウェブビューの後ろにあるネイティブブラウザを移動させて、アプリのUIを上に表示します。
sendToBack	Moves the native browser behind the Capacitor host WebView so app UI can appear above it.
bringToFront	ツールバーと、カメラアクセス、ファイルアクセス、イベントリスナー、JavaScriptのインジェクション、双方向通信など、強化された機能を持つ新しいウェブビューでURLを開きます。
dispatchInputEvent	InAppBrowserウィンドウにJavaScriptをインジェクトします。省略時は、指定されたJavaScriptがインジェクトされます。
openWebView	__CAPGO_KEEP_0__
executeScript	code id 指定されていない場合、すべてのオープンウェブビューで実行されます。
postMessage	イベントをウェブビュー（インアプリブラウザ）に送信します。ページでイベントをリスンするには window.addEventListener('messageFromNative', listenerFunc)。 detail payload は JSON としてシリアライズ可能でなければなりません。 When id webviewは開いているすべてのwebviewにブロードキャストされる。
takeScreenshot	ウェブビューのURLを設定します。指定されていない場合、オープンウェブビューのみでURLの変更をリスンします。 id URLの変更をリスンします。
setUrl	URLの変更をリスンします。 id URLの変更をリスンします。
addListener	URLの変更をリスンします。
addListener	URLの変更をリスンします。 buttonNearDoneClickURLの変更をリスンします。 id.
addListener	開閉されたウェブビューのみにリスン
addListener	ユーザーが確認ボタンをクリックしたときに発生します。確認ダイアログが必要な場合、openWebViewのshareDisclaimerとcloseModalを使用します。
addListener	ウェブビューがイベントをアプリに送信したときに発生します。ページ内で window.mobileApp.postMessage(...) ページ内で
addListener	プラグインAPI、ネイティブのスクリーンショットボタン、またはインジェクションされたJavaScriptブリッジからスクリーンショットがキャプチャされたときに発生します。
addListener	ページが読み込まれたときに発生します。
addListener	ページ読み込みエラーが発生したときに発生します。
addListener	ネイティブのダウンロードハンドリングがローカルにファイルを保存したときに発生します。有効にするには handleDownloads: true ネイティブのダウンロードハンドリングが失敗したときに発生します。有効にするには
addListener	ページがポップアップ/新しいウィンドウを開いたときに発生します。返されたポップアップIDを使用して handleDownloads: true ネイティブのダウンロードハンドリングが失敗したときに発生します。有効にするには
addListener	ページがポップアップ/新しいウィンドウを開いたときにトリガーされます。返されたポップアップIDを使用して executeScript, postMessage, show, hide, そして close.
addListener	ネイティブランタイムから委任されたプロキシリクエストを待ち受ける。 addProxyHandler() このメソッドを直接呼び出すのではなく、
addListener	JavaScriptコンソールの出力を受信する。 captureConsoleLogs: true この機能を有効にするには、
handleProxyRequest	webviewを開くときに addProxyHandler() ネイティブに送信するプロキシ決定を返すために使用される内部メソッド。 phase 元の proxyRequest マニュアル
removeAllListeners	リスナーの返信に応じて
reload	リスナーの削除
updateDimensions	現在のウェブページを再読み込みする。 id は省略されると、現在のウェブビューをターゲットにします。
setEnabledSafeTopMargin	ウェブビューの有効な安全上部マージンを実行時で設定します。 id は省略されると、現在のウェブビューをターゲットにします。ウェブ上では、このメソッドはレイアウトを変更せずに解決します。
setEnabledSafeBottomMargin	ウェブビューの有効な安全下部マージンを実行時で設定します。 id は省略されると、現在のウェブビューをターゲットにします。ウェブ上では、このメソッドはレイアウトを変更せずに解決します。
openSecureWindow	OAuth2 セキュア ウィンドウを開きます。ウェブ上では、リダイレクト URL を返します。 BroadcastChannel参照値

「参照値」のセクション

ツールバーの種類

「ツールバーの種類」のセクション

値	ユーザーは
activity	閉じると共有のコントロールのシンプルなツールバーを見つけることができます。
compact	閉じるコントロールのシンプルなツールバー
navigation	前と次のコントロールのフルナビゲーションツールバー
blank	ツールバーなし

真実の源

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

@capgo/capacitor-inappbrowser

Capgoを使用している場合 @capgo/capacitor-inappbrowser native plugin work を計画するには、を接続する Capgoを使用してネイティブ機能の「@capgo/capacitor-inappbrowser」 Capacitorのネイティブ機能として@capgo/capacitor-inappbrowserを使用します。 Capgoを使用して製品ワークフローの「Capgo Plugin Directory」 Capgo プラグイン Capgoを使用して実装詳細の「Capacitor Plugins by Capgo」 Capgoの実装詳細については、Capacitor プラグインによって Capgo で管理されます。 実装詳細の「Adding or Updating Plugins」 プラグインの追加または更新の実装詳細 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフロー