react-native-webviewのVega移植版であり、現在サポートされているAPIセットは限られています。
WebViewを使用するための設定については、Vegaウェブアプリの概要を参照してください。
プロパティ
source
指定されたURIを読み込みます。必要に応じてヘッダーも指定できます。sourceオブジェクトには次のサブプロパティがあります。uri(string)：WebViewで読み込むURI。headers(object)：リクエストと共に送信する追加のHTTPヘッダー。
onLoad
WebViewがウェブページの読み込みを完了した後、onLoadを呼び出します。以下に例を示します。
onLoad関数を呼び出すときに、次のプロパティを渡します。
onLoadStart
WebViewがリソースの読み込みを開始するときに、onLoadStartを呼び出します。以下に例を示します。
onLoadStartを呼び出すときに、次のプロパティを渡します。
onError
WebViewが読み込みに失敗すると、APIがonErrorを呼び出します。
以下に例を示します。
onError関数を呼び出すときに、次のプロパティを渡します。
onHttpError
WebViewで読み込みに失敗すると、onHttpError HTTPステータスエラーがスローされ、APIはonHttpError関数を呼び出します。
statusCodesが400以上の場合はすべてHTTPステータスエラーです。
isMainFrameフラグにより、エラーがメインページの読み込み中に発生したか、それとも依存ページの読み込み中に発生したかを特定できます。メインフレームの場合はtrue、サブリソースまたはiframeの場合はfalseになります。
以下に例を示します。
onHttpError関数を呼び出すときに、次のプロパティを渡します。
onCloseWindow
この関数は、指定されたWebViewを閉じてビューシステムから削除するようにホストアプリに通知します。 この呼び出し後にWebViewとやり取りすると予期しない動作を引き起こす可能性があるため、ホストアプリは、この呼び出しを受け取った後でWebViewインスタンスを破棄する必要があります。 このメソッドにはデフォルトの機能はありません。
以下に例を示します。
onMessage
WebView JSがReactNativeWebView.postMessageを呼び出したときに呼び出されます。postMessageは引数を1つ受け取り、それがeventオブジェクトに渡されます。dataは文字列です。
以下に例を示します。
onShouldStartLoadWithRequest
onShouldStartLoadWithRequestは、任意のWebViewリクエストのカスタム処理を可能にします。戻り値がtrueの場合はリクエストの読み込みを継続し、falseの場合は停止します。以下に例を示します。
onShouldStartLoadWithRequestオブジェクトには、以下のプロパティが含まれます。
onClientCertAuthentication（省略可能）
この省略可能な関数を使用すると、ホストアプリがクライアント証明書認証リクエストを管理できるようになります。パラメーター
- これにより、認証リクエストの詳細が表示されます。
- このコールバックオブジェクトには、認証を処理する関数があります。
コールバック関数
- この関数は、証明書がPKCS#12形式の場合にクライアント証明書認証を処理します。
- この関数はクライアント証明書認証プロセスをキャンセルします。
hostName- サーバーのホスト名。portNumber- リクエストのポート番号。
onSslError (optional)
この省略可能な関数を使用すると、リソースの読み込み時にSSLエラーが発生した場合にホストアプリが通知を受け取るようになります。ホストアプリは、SslErrorHandler.cancel()またはSslErrorHandler.proceed()を呼び出す必要があります。デフォルトでは、URLの読み込み時にSSLエラーが発生した場合は拒否されます。
ユーザーは、今後のSSLエラーに応答するために、proceed()メソッドまたはcancel()メソッドを呼び出すことができます。デフォルトでは、これらの関数のいずれかによって、リソースの読み込みプロセスがキャンセルされます。WebViewは、信頼されていない証明機関、証明書の期限切れ、自己署名など、回復可能なSSL証明書エラーに対してのみこの関数を呼び出します。サーバーがクライアントを拒否した場合など、回復不可能なエラーについては、WebViewはonError(WebView, WebResourceRequest, WebResourceError)をERROR_FAILED_SSL_HANDSHAKE（-11）引数と共に呼び出します。
以下に例を示します。
SslErrorDataオブジェクト
SslErrorDataオブジェクトには、次のプロパティが含まれています。
urlcodedescription
OnSslErrorCallbackオブジェクトには、次のメソッドが含まれています。
proceed()- SSLエラーを許容します。cancel()- SSLエラーを拒否します。
javaScriptEnabled
WebViewでJavaScriptを有効または無効にするブール値です。デフォルト値はtrueです。
以下に例を示します。
domStorageEnabled
WebViewでDOMストレージ（ローカルウェブストレージ）を有効または無効にするブール値です。デフォルトはfalseです。
以下に例を示します。
userAgent
WebViewのuser-Agentを設定します。
以下に例を示します。
mixedContentMode
WebViewの混在コンテンツモードを指定します。 以下に例を示します。mixedContentModeに指定できる値は次のとおりです。
- Never（デフォルト）：
MIXED_CONTENT_NEVER_ALLOWが使用されます。WebViewは、安全なオリジンが安全でないオリジンからコンテンツを読み込むことを禁止します。最も安全であるため、このモードを検討してください。 - Always：
MIXED_CONTENT_ALWAYS_ALLOWが使用されます。WebViewは、安全なオリジンがほかの任意のオリジンからコンテンツを読み込むことを許可します。ほかのオリジンが安全でなくても許可されます。安全性が最も低いモードであるため、Amazonでは推奨していません。 - Compatibility：
MIXED_CONTENT_COMPATIBILITY_MODEが使用されます。WebViewは、混在コンテンツに関してモダンウェブブラウザで使用されているアプローチと互換性を保つように試みます。WebViewは、安全な発信元からのものであり、ほかの種類のコンテンツがブロックされている場合に、安全でないコンテンツを許可することがあります。WebViewが許可またはブロックするコンテンツの種類は、リリースごとに変わる可能性があり、明示的には定義されていません。このモードは、レンダリングされる独自のコンテンツの制御は行わないものの、適度なセキュリティを必要とするアプリ向けに用意されています。最も高いセキュリティを確保するには、MIXED_CONTENT_NEVER_ALLOWを使用してください。
allowFileAccess
file:// URIを使用したファイルシステムへのアクセスを有効または無効にするブール値です。デフォルト値はfalseです。
以下に例を示します。
allowSystemKeyEvents
戻るボタン（keyCode: 27）などの特別なシステムキーイベントを、ウェブアプリのウェブJavaScript層でリッスンするかどうかを決定するブール値です。この機能は、ウェブアプリのビジネスロジック全体をウェブサイト上で実行し、アプリコードに頼らないようにする場合に役立ちます。allowSystemKeyEventsがtrueの場合、アプリは独自のバックハンドラーを実装でき、イベントはコンポーネントのバックハンドラー（WebView／アプリのハンドラー）の登録順序に基づいて伝播されます。これにより、アプリレベルの制御を提供しながら、システムキーイベントがWebViewコンテンツに対して適切に処理されるようになります。
重要な考慮事項
- WebViewは、戻るキーイベントを受け取ると、常にそのイベントを消費します。アプリのJavaScriptがキーイベントを消費しなくても、残りのほかのバックハンドラー（ある場合）にはイベントは伝播されません。
- 複数のWebViewが存在するシナリオでは、最後に作成されたWebViewインスタンスだけが戻るキーイベントを受け取ります。
mediaPlaybackRequiresUserAction
HTML5のオーディオやビデオの再生を開始する前に、ユーザーによるジェスチャーを必要とするかどうかを決定するブール値です。デフォルト値はtrueです。
以下に例を示します。
thirdPartyCookiesEnabled
WebViewで開発者のCookieを有効または無効にするブール値です。デフォルトはfalseです。
以下に例を示します。
allowsDefaultMediaControl
VegaMediaControlのイベントが、アクティブなWebViewメディアセッションに自動的にブリッジされるようにします。これにより、WebViewで音声コマンドをシームレスに統合できます。詳細については、Vegaメディアコントロールの概要を参照してください。
trueに設定すると、再生、一時停止、早送り、早戻しなど、WebViewメディアセッションのデフォルトのメディアトランスポートコントロールが有効になります。falseに設定すると、デフォルトのメディアトランスポートコントロールが無効になります。
- この設定は、広告やライブストリームを含むすべてのメディアコンテンツタイプに影響します。
- メディアコンテンツをきめ細かく制御する方法については、デフォルトのメディアコントロールハンドラーをオーバーライドする方法を参照してください。
injectedJavaScriptBeforeContentLoaded
injectedJavaScriptBeforeContentLoadedを設定すると、ドキュメント要素が作成された後、ほかのサブリソースの読み込みが終了する前に、ウェブページにJavaScriptを挿入できます。これは、ウェブコードの実行に先立って、ウィンドウ、localStorage、ドキュメントに何かを挿入する場合に便利です。
以下に例を示します。
メソッド
injectJavaScript
injectJavaScriptは、WebViewでJavaScript文字列を評価します。
以下に例を示します。
stopLoading
現在のページの読み込みを停止します。 以下に例を示します。clearCache(bool)
リソースのキャッシュを消去します。キャッシュはアプリ単位で管理されるため、clearCacheを呼び出すと、同じアプリに存在するすべてのWebViewパーツのキャッシュが消去されます。引数がtrueの場合、ディスクファイルも対象になります。引数がfalseの場合、RAMキャッシュのみが消去されます。
以下に例を示します。
goBack()
WebView履歴の1ページ前に戻ります。履歴に項目がない場合、この関数はノーオペレーションとなり、何も実行せずに戻ります。 以下に例を示します。goForward()
WebView履歴の1 ページ先に進みます。履歴に次の項目がない場合、この関数はノーオペレーションとなり、何も実行せずに戻ります。 以下に例を示します。clearHistory()
WebViewインスタンスの内部の戻る／進む履歴を消去します。 以下に例を示します。dispatchTouchEvent(event: TouchEvent)
指定されたターゲットのウェブ要素にタッチイベントをディスパッチします。これにより、touchstartやtouchendなどのタッチイベントをプログラムで発生させることができます。
パラメーター
event：ディスパッチされるタッチイベントを表すTouchEventオブジェクト。このオブジェクトには、タッチイベントのタイプに関する情報（type）と、イベントに関連付けるタッチポイントの配列（touches）が含まれます。
以下に例を示します。
scrollBy(offsetX: number, offsetY: number)
WebViewのコンテンツを、オフセット値で指定した分だけスクロールします。このメソッドを使用すると、WebViewのコンテンツを、水平オフセット（offsetX）と垂直オフセット（offsetY）を指定してプログラムでスクロールできます。
パラメーター
offsetX: コンテンツをスクロールする水平オフセットを表す数値。正の値を指定すると、コンテンツが右にスクロールします。負の値を指定すると、左にスクロールします。offsetY: コンテンツをスクロールする垂直オフセットを表す数値。正の値を指定すると、コンテンツが下にスクロールします。負の値を指定すると、上にスクロールします。
getVisualViewportInfo()
WebViewのビジュアルビューポートに関する情報を取得します。戻り値
ビジュアルビューポートに関する情報を含むオブジェクト。次の情報が含まれます。height: ビジュアルビューポートの高さ。width：ビジュアルビューポートの幅。offsetTop：ビジュアルビューポートの上端からコンテンツの上端までのオフセット。offsetLeft：ビジュアルビューポートの左端からコンテンツの左端までのオフセット。
getContentSizeInfo()
WebView内のコンテンツのサイズに関する情報を取得します。戻り値
コンテンツのサイズに関する情報を含むオブジェクト。次の情報が含まれます。scrollWidth：コンテンツの合計の幅。scrollHeight：コンテンツの合計の高さ。
