chrome.webviewTag

説明

webview タグを使用すると、ネットワーク経由でウェブからライブ コンテンツをアクティブに読み込み、Chrome アプリに埋め込むことができます。アプリは webview の外観を制御し、ウェブ コンテンツとやり取りしたり、埋め込まれたウェブページでナビゲーションを開始したり、その中で発生したエラー イベントに反応したりできます（使用方法を参照）。

権限

webview

型

ClearDataOptions

clearData によってクリアされるデータを決定するオプション。

プロパティ

  • 開始:

    number 省略可

    この日以降に蓄積されたデータを消去します。この日付は、エポックからの経過時間（ミリ秒単位）で表されます（JavaScript の Date オブジェクトの getTime メソッドでアクセスできます）。省略した場合、デフォルトで 0 になります（すべての閲覧データが削除されます）。

ClearDataTypeSet

データ型のセット。存在しないプロパティは false として解釈されます。

プロパティ

  • appcache

    ブール値（省略可）

    ウェブサイトの appcache。

  • キャッシュ

    ブール値（省略可）

    Chrome 44 以降

    Chrome 43 以降。 ブラウザのキャッシュ。注: データを削除すると、指定した範囲だけでなく、キャッシュ全体がクリアされます。

  • Cookie

    ブール値（省略可）

    パーティションの Cookie。

  • fileSystems

    ブール値（省略可）

    ウェブサイトのファイル システム。

  • indexedDB

    ブール値（省略可）

    ウェブサイトの IndexedDB データ。

  • localStorage

    ブール値（省略可）

    ウェブサイトのローカル ストレージ データ。

  • persistentCookies

    ブール値（省略可）

    Chrome 58 以降

    パーティションの永続 Cookie。

  • sessionCookies

    ブール値（省略可）

    Chrome 58 以降

    パーティションのセッション Cookie。

  • webSQL

    ブール値（省略可）

    ウェブサイトの WebSQL データ。

ContentScriptDetails

Chrome 44 以降

挿入するコンテンツ スクリプトの詳細。詳しくは、コンテンツ スクリプトのドキュメントをご覧ください。

プロパティ

  • all_frames

    ブール値（省略可）

    all_frames が true の場合、JavaScript または CSS が現在のページのすべてのフレームに挿入されることを意味します。デフォルトでは、all_frames は false であり、JavaScript または CSS は最上位のフレームにのみ挿入されます。

  • css

    InjectionItems 省略可

    一致するページに挿入する CSS コードまたは CSS ファイルのリスト。これらは、ページの DOM が構築または表示される前に、表示される順序で挿入されます。

  • exclude_globs

    string[] 省略可

    一致した後に適用され、この glob に一致する URL を除外します。@exclude Greasemonkey キーワードをエミュレートすることを目的としています。

  • exclude_matches

    string[] 省略可

    このコンテンツ スクリプトが挿入されるページを除外します。

  • include_globs

    string[] 省略可

    一致後に適用され、この glob にも一致する URL のみが含まれます。@include Greasemonkey キーワードをエミュレートすることを目的としています。

  • js

    InjectionItems 省略可

    一致するページに挿入される JavaScript コードまたは JavaScript ファイルのリスト。これらは表示される順序で挿入されます。

  • match_about_blank

    ブール値（省略可）

    about:blank と about:srcdoc にコンテンツ スクリプトを挿入するかどうか。コンテンツ スクリプトは、継承された URL が matches フィールドで宣言されたパターンのいずれかと一致する場合にのみ、ページに挿入されます。継承 URL は、フレームまたはウィンドウを作成したドキュメントの URL です。コンテンツ スクリプトをサンドボックス化されたフレームに挿入することはできません。

  • 一致

    string[]

    このコンテンツ スクリプトが挿入されるページを指定します。

  • name

    文字列

    挿入するコンテンツ スクリプトの名前。

  • run_at

    RunAt 省略可

    JavaScript または CSS がタブに挿入される最も早いタイミング。デフォルトは「document_idle」です。

ContentWindow

ゲスト ウィンドウへのメッセージ ハンドル。

プロパティ

  • postMessage

    void

    埋め込みコンテンツがターゲット オリジンのページを表示している限り、埋め込みウェブ コンテンツにメッセージを投稿します。このメソッドは、ページの読み込みが完了すると使用できるようになります。contentload イベントをリッスンし、メソッドを呼び出します。

    ゲストは、受信したメッセージ イベントの event.source にメッセージを投稿することで、埋め込み元に返信を送信できます。

    この API は、ウェブページ間の通信用の HTML5 postMessage API と同じです。埋め込み側は、独自のフレームに message イベント リスナーを追加することで、返信をリッスンできます。

    postMessage 関数は次のようになります。 

    (message: any, targetOrigin: string) => {...}

    • メッセージ

      任意

      ゲストに送信するメッセージ オブジェクト。

    • targetOrigin

      文字列

      イベントをディスパッチするために、ゲスト ウィンドウのオリジンが何である必要があるかを指定します。

ContextMenuCreateProperties

Chrome 44 以降

プロパティ

  • ON

    ブール値（省略可）

    チェックボックスまたはラジオ アイテムの初期状態。選択されている場合は true、選択されていない場合は false。ラジオ アイテムのグループ内で一度に選択できるラジオ アイテムは 1 つだけです。

  • コンテキスト

    [ContextType, ...ContextType[]] 省略可

    このメニュー項目が表示されるコンテキストのリスト。指定しない場合、デフォルトは ['page'] です。

  • documentUrlPatterns

    string[] 省略可

    アイテムを、指定されたパターンのいずれかに URL が一致するドキュメントにのみ適用するように制限できます。（これはフレームにも当てはまります）。パターンの形式の詳細については、一致パターンをご覧ください。

  • 有効

    ブール値（省略可）

    このコンテキスト メニュー項目が有効か無効か。デフォルトは true です。

  • id

    文字列 省略可

    このアイテムに割り当てる一意の ID。イベントページでは必須です。この拡張機能の別の ID と同じにすることはできません。

  • parentId

    文字列 | 数値 省略可

    親メニュー項目の ID。これにより、項目が以前に追加された項目の子になります。

  • targetUrlPatterns

    string[] 省略可

    documentUrlPatterns と同様ですが、img/audio/video タグの src 属性とアンカータグの href に基づいてフィルタできます。

  • title

    文字列 省略可

    アイテムに表示するテキスト。type が「separator」でない限り、必須です。コンテキストが「選択」の場合、文字列内で %s を使用して、選択したテキストを表示できます。たとえば、このパラメータの値が「Translate '%s' to Pig Latin」で、ユーザーが「cool」という単語を選択した場合、選択項目のコンテキスト メニュー項目は「Translate 'cool' to Pig Latin」になります。

  • type

    ItemType 省略可

    メニュー項目のタイプ。指定しない場合のデフォルトは「normal」です。

  • onclick

    void optional

    メニュー項目がクリックされたときに呼び出される関数。

    onclick 関数は次のようになります。 

    (info: OnClickData) => {...}

    • 情報

      OnClickData

      クリックされたアイテムとクリックが発生したコンテキストに関する情報。

ContextMenus

Chrome 44 以降

プロパティ

  • onShow

    Event<functionvoidvoid>

    この webview でコンテキスト メニューを表示する前に発生します。event.preventDefault() を呼び出して、このコンテキスト メニューを無効にできます。

    onShow.addListener 関数は次のようになります。 

    (callback: function) => {...}

    • callback

      関数

      callback パラメータは次のようになります。 

      (event: object) => void

      • イベント

        オブジェクト

        • preventDefault

          void

          コンテキスト メニューの表示を禁止するために呼び出します。

          preventDefault 関数は次のようになります。 

          () => {...}

  • create

    void

    新しいコンテキスト メニュー項目を作成します。作成中にエラーが発生した場合、作成コールバックが起動するまでエラーがわからないことがあります（詳細は runtime.lastError にあります）。

    create 関数は次のようになります。 

    (createProperties: object, callback?: function) => {...}

    • createProperties

      オブジェクト

      アイテムの作成に使用されるプロパティ

    • callback

      関数 省略可

      callback パラメータは次のようになります。 

      () => void

    • 戻り値

      string | number

      新しく作成されたアイテムの ID。

  • 削除

    void

    コンテキスト メニュー項目を削除します。

    remove 関数は次のようになります。 

    (menuItemId: string | number, callback?: function) => {...}

    • menuItemId

      string | number

      削除するコンテキスト メニュー項目の ID。

    • callback

      関数 省略可

      callback パラメータは次のようになります。 

      () => void

  • removeAll

    void

    この webview に追加されたすべてのコンテキスト メニュー項目を削除します。

    removeAll 関数は次のようになります。 

    (callback?: function) => {...}

    • callback

      関数 省略可

      callback パラメータは次のようになります。 

      () => void

  • update

    void

    以前に作成されたコンテキスト メニュー項目を更新します。

    update 関数は次のようになります。 

    (id: string | number, updateProperties: object, callback?: function) => {...}

    • id

      string | number

      更新するアイテムの ID。

    • updateProperties

      オブジェクト

      更新するプロパティ。作成関数と同じ値を受け入れます。

    • callback

      関数 省略可

      callback パラメータは次のようになります。 

      () => void

ContextMenuUpdateProperties

Chrome 44 以降

プロパティ

  • ON

    ブール値（省略可）

    チェックボックスまたはラジオ項目の状態。選択されている場合は true、選択されていない場合は false。ラジオ アイテムのグループ内で一度に選択できるラジオ アイテムは 1 つだけです。

  • コンテキスト

    [ContextType, ...ContextType[]] 省略可

    このメニュー項目が表示されるコンテキストのリスト。

  • documentUrlPatterns

    string[] 省略可

    アイテムを、指定されたパターンのいずれかに URL が一致するドキュメントにのみ適用するように制限できます。（これはフレームにも当てはまります）。パターンの形式の詳細については、一致パターンをご覧ください。

  • 有効

    ブール値（省略可）

    このコンテキスト メニュー項目が有効か無効か。

  • parentId

    文字列 | 数値 省略可

    親メニュー項目の ID。これにより、項目が以前に追加された項目の子になります。注: 項目をその子孫の 1 つの子に変更することはできません。

  • targetUrlPatterns

    string[] 省略可

    documentUrlPatterns と同様ですが、img/audio/video タグの src 属性とアンカータグの href に基づいてフィルタできます。

  • title

    文字列 省略可

    項目に表示するテキスト

  • type

    ItemType 省略可

    メニュー項目のタイプ。

  • onclick

    void optional

    メニュー項目がクリックされたときに呼び出される関数。

    onclick 関数は次のようになります。 

    (info: OnClickData) => {...}

    • 情報

      OnClickData

      クリックされたアイテムとクリックが発生したコンテキストに関する情報。

ContextType

Chrome 44 以降

メニューが表示されるさまざまなコンテキスト。「all」を指定することは、他のすべてのコンテキストの組み合わせと同じです。

列挙型

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

dialog DOM イベントに接続されたインターフェース。

プロパティ

  • キャンセル

    void

    ダイアログを拒否します。confirm または prompt ダイアログで [キャンセル] をクリックするのと同じです。

    cancel 関数は次のようになります。 

    () => {...}

  • OK

    void

    ダイアログを承認します。alert、confirm、prompt のダイアログで [OK] をクリックするのと同等です。

    ok 関数は次のようになります。 

    (response?: string) => {...}

    • レスポンス

      文字列 省略可

      prompt ダイアログを受け入れたときにゲストに提供するレスポンス文字列。

DialogMessageType

保留中

ゲストがリクエストしたモーダル ダイアログのタイプ。

列挙型

"alert"

"confirm"

"prompt"

DownloadPermissionRequest

download permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • requestMethod

    文字列

    ダウンロード リクエストに関連付けられている HTTP リクエスト タイプ（GET など）。

  • URL

    文字列

    リクエストされたダウンロード URL。

  • allow

    void

    権限リクエストを許可します。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。これは、allow が呼び出されない場合のデフォルトの動作です。

    deny 関数は次のようになります。 

    () => {...}

ExitReason

保留中

終了の理由を示す文字列。

列挙型

"normal"

"abnormal"

"crashed"

"killed"

"oom killed"

"oom"

「起動に失敗しました」

"integrity failure"

FileSystemPermissionRequest

filesystem permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • URL

    文字列

    ローカル ファイル システムへのアクセスをリクエストしているフレームの URL。

  • allow

    void

    権限リクエストを許可します。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。

    deny 関数は次のようになります。 

    () => {...}

FindCallbackResults

検索リクエストの結果がすべて含まれます。

プロパティ

  • activeMatchOrdinal

    数値

    現在の試合の序数。

  • キャンセル済み

    ブール値

    この検索リクエストがキャンセルされたかどうかを示します。

  • numberOfMatches

    数値

    ページ上で searchText が一致した回数。

  • selectionRect

    SelectionRect

    画面座標でアクティブな一致を囲む長方形を表します。

FindOptions

検索リクエストのオプション。

プロパティ

  • backward

    ブール値（省略可）

    逆順で一致を検索するフラグ。デフォルト値は false です。

  • matchCase

    ブール値（省略可）

    大文字と小文字を区別して照合するフラグ。デフォルト値は false です。

FullscreenPermissionRequest

Chrome 43 以降

fullscreen permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • origin

    文字列

    全画面表示リクエストを開始した webview 内のフレームのオリジン。

  • allow

    void

    権限リクエストを許可します。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。

    deny 関数は次のようになります。 

    () => {...}

GeolocationPermissionRequest

geolocation permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • URL

    文字列

    位置情報データへのアクセスをリクエストしているフレームの URL。

  • allow

    void

    権限リクエストを許可します。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。これは、allow が呼び出されない場合のデフォルトの動作です。

    deny 関数は次のようになります。 

    () => {...}

HidPermissionRequest

Chrome 125 以降

hid permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • URL

    文字列

    HID API へのアクセスをリクエストしているフレームの URL。

  • allow

    void

    権限リクエストを許可します。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。これは、allow が呼び出されない場合のデフォルトの動作です。

    deny 関数は次のようになります。 

    () => {...}

InjectDetails

挿入するスクリプトまたは CSS の詳細。コード プロパティまたはファイル プロパティのいずれかを設定する必要がありますが、両方を同時に設定することはできません。

プロパティ

  • コード

    文字列 省略可

    挿入する JavaScript または CSS コード。

    警告: code パラメータを使用する場合は注意してください。正しく使用しないと、アプリがクロスサイト スクリプティング攻撃を受ける可能性があります。

  • ファイル

    文字列 省略可

    挿入する JavaScript ファイルまたは CSS ファイル。

InjectionItems

Chrome 44 以降

インジェクション アイテムのタイプ（コードまたはファイルのセット）。

プロパティ

  • コード

    文字列 省略可

    一致するページに挿入される JavaScript コードまたは CSS。

  • ファイル

    string[] 省略可

    一致するページに挿入される JavaScript ファイルまたは CSS ファイルのリスト。これらは、この配列に表示されている順序で挿入されます。

LoadAbortReason

保留中

発生した中止の種類を示す文字列。この文字列は、リリース間で下位互換性が維持されることが保証されていません。そのコンテンツを解析して、それに基づいて行動してはなりません。また、ここに記載されていないエラーが報告される場合もあります。

列挙型

"ERR_ABORTED"

"ERR_INVALID_URL"

"ERR_DISALLOWED_URL_SCHEME"

"ERR_BLOCKED_BY_CLIENT"

"ERR_ADDRESS_UNREACHABLE"

「ERR_EMPTY_RESPONSE」

"ERR_FILE_NOT_FOUND"

"ERR_UNKNOWN_URL_SCHEME"

LoadPluginPermissionRequest

loadplugin permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • identifier

    文字列

    プラグインの識別子文字列。

  • name

    文字列

    プラグインの表示名。

  • allow

    void

    権限リクエストを許可します。deny が呼び出されない場合、これがデフォルトの動作です。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。

    deny 関数は次のようになります。 

    () => {...}

MediaPermissionRequest

media permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • URL

    文字列

    ユーザー メディアへのアクセスをリクエストしているフレームの URL。

  • allow

    void

    権限リクエストを許可します。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。これは、allow が呼び出されない場合のデフォルトの動作です。

    deny 関数は次のようになります。 

    () => {...}

NewWindow

newwindow DOM イベントに接続されたインターフェース。

プロパティ

  • アタッチする

    void

    リクエストされたターゲット ページを既存の webview 要素に関連付けます。

    attach 関数は次のようになります。 

    (webview: object) => {...}

    • webview

      オブジェクト

      ターゲット ページを添付する webview 要素。

  • 破棄

    void

    新しいウィンドウのリクエストをキャンセルします。

    discard 関数は次のようになります。 

    () => {...}

PermissionType

保留中

リクエストされている権限のタイプ。

列挙型

"media"

"geolocation"

"pointerLock"

"download"

"loadplugin"

"filesystem"

"fullscreen"

"hid"

PointerLockPermissionRequest

pointerLock permissionrequest DOM イベントに付随する request オブジェクトの型。

プロパティ

  • lastUnlockedBySelf

    ブール値

    リクエスト元のフレームが、ポインタ ロックを保持した最新のクライアントであったかどうか。

  • URL

    文字列

    ポインタ ロックをリクエストしているフレームの URL。

  • userGesture

    ブール値

    ユーザー入力ジェスチャーの結果としてポインタ ロックがリクエストされたかどうか。

  • allow

    void

    権限リクエストを許可します。

    allow 関数は次のようになります。 

    () => {...}

  • 拒否

    void

    権限リクエストを拒否します。これは、allow が呼び出されない場合のデフォルトの動作です。

    deny 関数は次のようになります。 

    () => {...}

SelectionRect

画面座標の長方形を記述します。

包含セマンティクスは配列に似ています。つまり、座標 (left, top) は長方形に含まれると見なされますが、座標 (left + width, top) は含まれません。

プロパティ

  • height

    数値

    長方形の高さ。

  • 左

    数値

    画面の左端から長方形の左端までの距離。

  • 上

    数値

    画面の上端から長方形の上端までの距離。

  • 幅

    数値

    長方形の幅。

StopFindingAction

保留中

セッションの検索が終了した後にアクティブな一致をどうするかを決定します。clear はアクティブな一致のハイライト表示をクリアします。keep はアクティブな一致のハイライト表示を維持します。activate はアクティブな一致のハイライト表示を維持し、その一致に対するユーザーのクリックをシミュレートします。デフォルトのアクションは keep です。

列挙型

"clear"

"keep"

"activate"

WebRequestEventInterface

Chrome 44 以降

ゲストページの webRequest イベントへのアクセスを提供するインターフェース。webRequest のライフサイクルと関連するコンセプトについて詳しくは、chrome.webRequest 拡張機能 API をご覧ください。注: chrome.webRequest.onActionIgnored イベントは WebView ではサポートされていません。

使用方法が拡張機能の webRequest API とどのように異なるかを示すため、*://www.evil.com/* に一致する URL へのゲスト リクエストをブロックする次のコード例を考えてみましょう。

webview.request.onBeforeRequest.addListener(
  function(details) { return {cancel: true}; },
  {urls: ["*://www.evil.com/*"]},
  ["blocking"]);

また、このインターフェースは、onRequest イベントと onMessage イベントを介して宣言型 webRequest ルールをサポートします。API の詳細については、declarativeWebRequest をご覧ください。

宣言型 WebView の webRequest の条件とアクションは、chrome.webViewRequest.* の対応するオブジェクトからインスタンス化する必要があります。次のサンプルコードは、webview myWebview で "example.com" へのすべてのリクエストを宣言的にブロックします。

var rule = {
  conditions: [
    new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
  ],
  actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);

WindowOpenDisposition

保留中

新しいウィンドウの要求された処分。

列挙型

"ignore"

"save_to_disk"

"current_tab"

"new_background_tab"

"new_foreground_tab"

"new_window"

"new_popup"

ZoomMode

Chrome 43 以降

webview でのズームの処理方法を定義します。

列挙型

「オリジン単位」
ズームの変更は、ズームされたページのオリジンに保持されます。つまり、同じパーティション内の他のすべてのウェブビューが同じオリジンに移動すると、それらもズームされます。また、per-origin ズームの変更はオリジンとともに保存されます。つまり、同じオリジンの他のページに移動すると、すべてのページが同じズーム率でズームされます。

「per-view」
ズームの変更はこのウェブビューでのみ有効になり、他のウェブビューでのズームの変更はこのウェブビューのズームに影響しません。また、ナビゲーション時に per-view ズームの変更がリセットされます。WebView をナビゲートすると、常に（パーティションの範囲内で）オリジンごとのズーム率でページが読み込まれます。

「disabled」
WebView のズームをすべて無効にします。コンテンツはデフォルトのズームレベルに戻り、ズームの変更はすべて無視されます。

プロパティ

contentWindow

ゲストページにメッセージを投稿するために使用できるオブジェクト参照。

タイプ

ContentWindow

contextMenus

Chrome 44 以降

Chrome の ContextMenus API と同様ですが、ブラウザではなく webview に適用されます。webview.contextMenus API を使用して、webview のコンテキスト メニューにアイテムを追加します。コンテキスト メニューに追加するオブジェクトのタイプ（画像、ハイパーリンク、ページなど）を選択できます。

タイプ

ContextMenus

request

ゲストページの webRequest イベントへのアクセスを提供するインターフェース。

タイプ

WebRequestEventInterface

メソッド

addContentScripts()

Chrome 44 以降 
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
): void

webview にコンテンツ スクリプト挿入ルールを追加します。webview が 1 つ以上のルールに一致するページに移動すると、関連付けられたスクリプトが挿入されます。プログラムでルールを追加したり、既存のルールを更新したりできます。

次の例では、webview に「myRule」と「anotherRule」の 2 つのルールを追加します。

webview.addContentScripts([
  {
    name: 'myRule',
    matches: ['http://www.foo.com/*'],
    css: { files: ['mystyles.css'] },
    js: { files: ['jquery.js', 'myscript.js'] },
    run_at: 'document_start'
  },
  {
    name: 'anotherRule',
    matches: ['http://www.bar.com/*'],
    js: { code: "document.body.style.backgroundColor = 'red';" },
    run_at: 'document_end'
  }]);
 ...

// Navigates webview.
webview.src = 'http://www.foo.com';

スクリプトの挿入が必要になるまで、addContentScripts 呼び出しを延期できます。

次の例は、既存のルールを上書きする方法を示しています。

webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.foo.com/*'],
    js: { files: ['scriptA.js'] },
    run_at: 'document_start'}]);

// Do something.
webview.src = 'http://www.foo.com/*';
 ...
// Overwrite 'rule' defined before.
webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.bar.com/*'],
    js: { files: ['scriptB.js'] },
    run_at: 'document_end'}]);

webview がオリジン（foo.com など）に移動し、webview.addContentScripts を呼び出して「myRule」を追加した場合、スクリプトを挿入するには次のナビゲーションを待つ必要があります。すぐに挿入したい場合は、executeScript が適切な処理を行います。

ゲスト プロセスがクラッシュまたは強制終了された場合や、webview が親を変更された場合でも、ルールは保持されます。

詳しくは、コンテンツ スクリプトのドキュメントをご覧ください。

パラメータ

back()

chrome.webviewTag.back(
  callback?: function,
): void

可能であれば、履歴エントリを 1 つ戻ります。go(-1) と同じです。

パラメータ

  • callback

    関数 省略可

    Chrome 44 以降

    callback パラメータは次のようになります。 

    (success: boolean) => void

    • 成功

      ブール値

      ナビゲーションが成功したかどうかを示します。

canGoBack()

chrome.webviewTag.canGoBack(): boolean

履歴を前に戻ることができるかどうかを示します。この関数の状態はキャッシュに保存され、各 loadcommit の前に更新されるため、この関数を呼び出すのに最適な場所は loadcommit です。

戻り値

  • ブール値

canGoForward()

chrome.webviewTag.canGoForward(): boolean

履歴を前方に移動できるかどうかを示します。この関数の状態はキャッシュに保存され、各 loadcommit の前に更新されるため、この関数を呼び出すのに最適な場所は loadcommit です。

戻り値

  • ブール値

captureVisibleRegion()

Chrome 50 以降 
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
): void

WebView の表示領域をキャプチャします。

パラメータ

  • オプション

    ImageDetails 省略可

  • callback

    関数

    callback パラメータは次のようになります。 

    (dataUrl: string) => void

    • dataUrl

      文字列

      キャプチャされたタブの表示領域の画像をエンコードするデータ URL。表示用の HTML 画像要素の「src」プロパティに割り当てることができます。

clearData()

chrome.webviewTag.clearData(
  options: ClearDataOptions,
  types: ClearDataTypeSet,
  callback?: function,
): void

webview パーティションの閲覧履歴データを消去します。

パラメータ

  • オプション

    ClearDataOptions

    削除するデータを決定するオプション。

  • タイプ

    ClearDataTypeSet

    消去するデータの種類。

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    () => void

executeScript()

chrome.webviewTag.executeScript(
  details: InjectDetails,
  callback?: function,
): void

JavaScript コードをゲストページに挿入します。

次のサンプルコードでは、スクリプト インジェクションを使用してゲストページの背景色を赤に設定しています。

webview.executeScript({ code: "document.body.style.backgroundColor = 'red'" });

パラメータ

  • 詳細

    InjectDetails

    実行するスクリプトの詳細。

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    (result?: any[]) => void

    • 件の結果

      any[] 省略可

      挿入されたすべてのフレームのスクリプトの結果。

find()

chrome.webviewTag.find(
  searchText: string,
  options?: FindOptions,
  callback?: function,
): void

ページ内検索リクエストを開始します。

パラメータ

  • searchText

    文字列

    ページ内で検索する文字列。

  • オプション

    FindOptions 省略可

    検索リクエストのオプション。

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    (results?: FindCallbackResults) => void

    • 結果

      FindCallbackResults 省略可

      検索リクエストの結果がすべて含まれます。コールバック関数本体で使用されない場合（たとえば、コールバックが検索リクエストの完了時期を判断するためにのみ使用される場合）、results は省略できます。

forward()

chrome.webviewTag.forward(
  callback?: function,
): void

可能であれば、履歴エントリを 1 つ進めます。go(1) と同じです。

パラメータ

  • callback

    関数 省略可

    Chrome 44 以降

    callback パラメータは次のようになります。 

    (success: boolean) => void

    • 成功

      ブール値

      ナビゲーションが成功したかどうかを示します。

getAudioState()

Chrome 62 以降 
chrome.webviewTag.getAudioState(
  callback: function,
): void

音声の状態をクエリします。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (audible: boolean) => void

    • Audible

      ブール値

getProcessId()

chrome.webviewTag.getProcessId(): number

ゲスト ウェブページの現在のプロセスの Chrome 内部プロセス ID を返します。これにより、プロセスを終了した場合に影響を受けるゲストの数を埋め込み側が把握できます。2 つのゲストがプロセスを共有するのは、同じアプリに属し、同じストレージ パーティション ID を持っている場合のみです。呼び出しは同期で、現在のプロセス ID のエンベダーのキャッシュされた概念を返します。プロセス ID は、オペレーティング システムのプロセス ID と同じではありません。

戻り値

  • 数値

getUserAgent()

chrome.webviewTag.getUserAgent(): string

ゲストページ リクエストで webview が使用するユーザー エージェント文字列を返します。

戻り値

  • 文字列

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
): void

現在のズーム率を取得します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (zoomFactor: number) => void

    • zoomFactor

      数値

      現在のズーム ファクタ。

getZoomMode()

Chrome 43 以降 
chrome.webviewTag.getZoomMode(
  callback: function,
): void

現在のズームモードを取得します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      ZoomMode

      webview の現在のズームモード。

go()

chrome.webviewTag.go(
  relativeIndex: number,
  callback?: function,
): void

現在のナビゲーションを基準とした履歴インデックスを使用して、履歴エントリに移動します。リクエストされたナビゲーションが不可能な場合、このメソッドは効果がありません。

パラメータ

  • relativeIndex

    数値

    webview が移動する相対履歴インデックス。たとえば、値が 2 の場合は、可能であれば履歴エントリを 2 つ進めます。値が -3 の場合は、エントリを 3 つ戻します。

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    (success: boolean) => void

    • 成功

      ブール値

      ナビゲーションが成功したかどうかを示します。

insertCSS()

chrome.webviewTag.insertCSS(
  details: InjectDetails,
  callback?: function,
): void

CSS をゲストページに挿入します。

パラメータ

  • 詳細

    InjectDetails

    挿入する CSS の詳細。

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    () => void

isAudioMuted()

Chrome 62 以降 
chrome.webviewTag.isAudioMuted(
  callback: function,
): void

音声がミュートされているかどうかをクエリします。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (muted: boolean) => void

    • ミュート中

      ブール値

isSpatialNavigationEnabled()

Chrome 71 以降 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
): void

WebView で空間ナビゲーションが有効になっているかどうかをクエリします。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (enabled: boolean) => void

    • 有効

      ブール値

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden(): void

webview のユーザー エージェント文字列が webviewTag.setUserAgentOverride によってオーバーライドされたかどうかを示します。

loadDataWithBaseUrl()

chrome.webviewTag.loadDataWithBaseUrl(
  dataUrl: string,
  baseUrl: string,
  virtualUrl?: string,
): void

相対リンクに使用される指定されたベース URL を含むデータ URL を読み込みます。必要に応じて、データ URL の代わりにユーザーに表示する仮想 URL を指定できます。

パラメータ

  • dataUrl

    文字列

    読み込むデータ URL。

  • baseUrl

    文字列

    相対リンクに使用されるベース URL。

  • virtualUrl

    文字列 省略可

    ユーザーに表示される URL（アドレスバーに表示されます）。

print()

chrome.webviewTag.print(): void

webview の内容を出力します。これは、webview 自体からスクリプト化された print 関数を呼び出すことと同じです。

reload()

chrome.webviewTag.reload(): void

現在のトップレベル ページを再読み込みします。

removeContentScripts()

Chrome 44 以降 
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
): void

webview からコンテンツ スクリプトを削除します。

次の例では、以前に追加した「myRule」を削除します。

webview.removeContentScripts(['myRule']);

次の呼び出しで、すべてのルールを削除できます。

webview.removeContentScripts();

パラメータ

  • scriptNameList

    string[] 省略可

    削除されるコンテンツ スクリプトの名前のリスト。リストが空の場合、webview に追加されたすべてのコンテンツ スクリプトが削除されます。

setAudioMuted()

Chrome 62 以降 
chrome.webviewTag.setAudioMuted(
  mute: boolean,
): void

WebView の音声ミュート状態を設定します。

パラメータ

  • ミュート

    ブール値

    音声ミュートの値

setSpatialNavigationEnabled()

Chrome 71 以降 
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
): void

WebView の空間ナビゲーションの状態を設定します。

パラメータ

  • 有効

    ブール値

    空間ナビゲーションの状態値。

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
): void

ゲストページのリクエストで webview が使用するユーザー エージェント文字列をオーバーライドします。オーバーライドすると、このオーバーライドが適用されるゲストページ リクエストの User-Agent クライアント ヒント ヘッダー値と navigator.userAgentData から返される値が空になります。

パラメータ

  • userAgent

    文字列

    使用するユーザー エージェント文字列。

setZoom()

chrome.webviewTag.setZoom(
  zoomFactor: number,
  callback?: function,
): void

ページのズーム率を変更します。この変更のスコープと永続性は、WebView の現在のズームモードによって決まります（webviewTag.ZoomMode を参照）。

パラメータ

  • zoomFactor

    数値

    新しいズーム倍率。

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    () => void

setZoomMode()

Chrome 43 以降 
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
): void

webview のズームモードを設定します。

パラメータ

  • ZoomMode

    ZoomMode

    webview でのズームの処理方法を定義します。

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    () => void

stop()

chrome.webviewTag.stop(): void

進行中の現在の webview ナビゲーションの読み込みを停止します。

stopFinding()

chrome.webviewTag.stopFinding(
  action?: StopFindingAction,
): void

現在の検索セッションを終了し（すべてのハイライト表示をクリア）、進行中のすべての検索リクエストをキャンセルします。

パラメータ

  • アクション

    StopFindingAction 省略可

    セッションの検索が終了した後にアクティブな一致をどうするかを決定します。clear はアクティブな一致のハイライト表示をクリアします。keep はアクティブな一致のハイライト表示を維持します。activate はアクティブな一致のハイライト表示を維持し、その一致に対するユーザーのクリックをシミュレートします。デフォルトのアクションは keep です。

terminate()

chrome.webviewTag.terminate(): void

ゲスト ウェブページのレンダラ プロセスを強制終了します。同じプロセスを共有している場合、現在のアプリの複数の webview タグに影響する可能性がありますが、他のアプリの webview タグには影響しません。

イベント

close

chrome.webviewTag.close.addListener(
  callback: function,
)

ゲスト ウィンドウが閉じようとしたときに発生します。

次のサンプルコードは、ゲストが自身を閉じようとしたときに webview を about:blank に移動します。

webview.addEventListener('close', function() {
  webview.src = 'about:blank';
});

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void

consolemessage

chrome.webviewTag.consolemessage.addListener(
  callback: function,
)

ゲスト ウィンドウがコンソール メッセージをログに記録したときに発生します。

次のコード例では、ログレベルやその他のプロパティに関係なく、すべてのログメッセージをエンベッダのコンソールに転送します。

webview.addEventListener('consolemessage', function(e) {
  console.log('Guest page logged a message: ', e.message);
});

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (level: number, message: string, line: number, sourceId: string) => void

    • level

      数値

    • メッセージ

      文字列

    • 台詞

      数値

    • sourceId

      文字列

contentload

chrome.webviewTag.contentload.addListener(
  callback: function,
)

ゲスト ウィンドウが load イベントを発生させたとき（新しいドキュメントが読み込まれたとき）に呼び出されます。これには、現在のドキュメント内のページ ナビゲーションや非同期リソースの読み込みは含まれません。

次のコード例では、ページの読み込み後にゲストの body 要素のデフォルトのフォントサイズを変更します。

webview.addEventListener('contentload', function() {
  webview.executeScript({ code: 'document.body.style.fontSize = "42px"' });
});

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void

dialog

chrome.webviewTag.dialog.addListener(
  callback: function,
)

ゲスト ウィンドウが window.alert、window.confirm、または window.prompt を介してモーダル ダイアログを開こうとしたときに発生します。

このイベントを処理すると、各イベント リスナーが戻るか、dialog オブジェクトが到達不能になるまで（preventDefault() が呼び出された場合）、ゲスト プロセスがブロックされます。

デフォルトの動作では、ダイアログがキャンセルされます。

パラメータ

exit

chrome.webviewTag.exit.addListener(
  callback: function,
)

ゲストのウェブ コンテンツをレンダリングするプロセスが終了したときに発生します。

次のコード例では、ゲストページがクラッシュするたびに別れのメッセージが表示されます。

webview.addEventListener('exit', function(e) {
  if (e.reason === 'crash') {
    webview.src = 'data:text/plain,Goodbye, world!';
  }
});

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (details: object) => void

    • 詳細

      オブジェクト

      • processID

        数値

        終了したプロセスの Chrome の内部 ID。

      • reason

        ExitReason

        終了の理由を示す文字列。

findupdate

chrome.webviewTag.findupdate.addListener(
  callback: function,
)

アクティブな検索リクエストの新しい検索結果が利用可能になると呼び出されます。一致が見つかるたびに、1 つの検索リクエストに対して複数回発生する可能性があります。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (searchText: string, numberOfMatches: number, activeMatchOrdinal: number, selectionRect: SelectionRect, canceled: boolean, finalUpdate: string) => void

    • searchText

      文字列

    • numberOfMatches

      数値

    • activeMatchOrdinal

      数値

    • selectionRect

      SelectionRect

    • キャンセル済み

      ブール値

    • finalUpdate

      文字列

loadabort

chrome.webviewTag.loadabort.addListener(
  callback: function,
)

コミットせずにトップレベルの読み込みが中止されたときに呼び出されます。イベントがデフォルトで防止されていない限り、エラー メッセージがコンソールに出力されます。

注: リソースの読み込みが中止されると、最後の loadstop イベント以降にコミットされた読み込みがすべて中止された場合でも、最終的に loadabort イベントの後に loadstop イベントが続きます。

注: about URL または JavaScript URL の読み込みが中止されると、loadabort が発火し、webview が 'about:blank' に移動します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (url: string, isTopLevel: boolean, code: number, reason: LoadAbortReason) => void

    • URL

      文字列

    • isTopLevel

      ブール値

    • コード

      数値

loadcommit

chrome.webviewTag.loadcommit.addListener(
  callback: function,
)

読み込みがコミットされたときに発生します。これには、現在のドキュメント内のナビゲーションとサブフレーム ドキュメント レベルの読み込みが含まれますが、非同期リソースの読み込みは含まれません。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (url: string, isTopLevel: boolean) => void

    • URL

      文字列

    • isTopLevel

      ブール値

loadredirect

chrome.webviewTag.loadredirect.addListener(
  callback: function,
)

トップレベルの読み込みリクエストが別の URL にリダイレクトされたときに発生します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (oldUrl: string, newUrl: string, isTopLevel: boolean) => void

    • oldUrl

      文字列

    • newUrl

      文字列

    • isTopLevel

      ブール値

loadstart

chrome.webviewTag.loadstart.addListener(
  callback: function,
)

読み込みが開始されると呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (url: string, isTopLevel: boolean) => void

    • URL

      文字列

    • isTopLevel

      ブール値

loadstop

chrome.webviewTag.loadstop.addListener(
  callback: function,
)

ゲストページ内のすべてのフレームレベルの読み込み（すべてのサブフレームを含む）が完了すると呼び出されます。これには、現在のドキュメント内のナビゲーションとサブフレーム ドキュメント レベルの読み込みが含まれますが、非同期リソースの読み込みは含まれません。このイベントは、ドキュメント レベルの読み込み数が 1 以上から 0 に移行するたびに発生します。たとえば、読み込みが完了したページ（loadstop がすでに 1 回トリガーされている場合、新しい iframe が作成されてページが読み込まれ、iframe ページの読み込みが完了すると 2 回目の loadstop がトリガーされます。このパターンは、広告を読み込むページでよく見られます。

注: コミットされた読み込みが中止されると、最後の loadstop イベント以降にコミットされた読み込みがすべて中止された場合でも、最終的に loadstop イベントが loadabort イベントに続きます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void

newwindow

chrome.webviewTag.newwindow.addListener(
  callback: function,
)

ゲストページが新しいブラウザ ウィンドウを開こうとしたときに発生します。

次のコード例では、リクエストされた新しいウィンドウごとに、エンベッダーに新しい webview を作成して移動します。

webview.addEventListener('newwindow', function(e) {
  var newWebview = document.createElement('webview');
  document.body.appendChild(newWebview);
  e.window.attach(newWebview);
});

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (window: NewWindow, targetUrl: string, initialWidth: number, initialHeight: number, name: string, windowOpenDisposition: WindowOpenDisposition) => void

permissionrequest

chrome.webviewTag.permissionrequest.addListener(
  callback: function,
)

ゲストページが埋め込み元から特別な権限をリクエストする必要がある場合に発火します。

次のサンプルコードは、ゲストページに webkitGetUserMedia API へのアクセス権を付与します。このサンプルコードを使用するアプリは、audioCapture または videoCapture のマニフェスト権限を自身で指定する必要があります。

webview.addEventListener('permissionrequest', function(e) {
  if (e.permission === 'media') {
    e.request.allow();
  }
});

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (permission: PermissionType, request: object) => void

responsive

chrome.webviewTag.responsive.addListener(
  callback: function,
)

ゲスト ウェブ コンテンツをレンダリングするプロセスが応答しなくなった後、再び応答するようになったときに発生します。

次のコード例では、webview 要素がレスポンシブになったり、レスポンシブでなくなったりするにつれて、フェードインまたはフェードアウトします。

webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
  webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
  webview.style.opacity = '1';
});

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (processID: number) => void

    • processID

      数値

sizechanged

chrome.webviewTag.sizechanged.addListener(
  callback: function,
)

埋め込みウェブ コンテンツが autosize を介してサイズ変更されたときに発生します。autosize が有効になっている場合にのみ発火します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => void

    • oldWidth

      数値

    • oldHeight

      数値

    • newWidth

      数値

    • newHeight

      数値

unresponsive

chrome.webviewTag.unresponsive.addListener(
  callback: function,
)

ゲスト ウェブ コンテンツをレンダリングするプロセスが応答しなくなったときに発生します。ゲストが再び返信を開始すると、このイベントは一致するレスポンシブ イベントとともに 1 回生成されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (processID: number) => void

    • processID

      数値

zoomchange

chrome.webviewTag.zoomchange.addListener(
  callback: function,
)

ページのズームが変更されたときに発生します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (oldZoomFactor: number, newZoomFactor: number) => void

    • oldZoomFactor

      数値

    • newZoomFactor

      数値