chrome.webviewTag

説明

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

権限

webview

型

ClearDataOptions

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

プロパティ

  • 開始:

    number（省略可）

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

ClearDataTypeSet

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

プロパティ

  • 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[] 省略可

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

  • exclude_matches

    string[] 省略可

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

  • include_globs

    string[] 省略可

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

  • 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 省略可

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

    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

      function 省略可

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

      () => void

    • 戻り値

      文字列 | 数値

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

  • 削除

    void

    コンテキスト メニュー アイテムを削除します。

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

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

    • menuItemId

      文字列 | 数値

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

    • callback

      function 省略可

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

      () => void

  • removeAll

    void

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

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

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

    • callback

      function 省略可

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

      () => void

  • update

    void

    以前に作成したコンテキスト メニュー アイテムを更新します。

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

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

    • id

      文字列 | 数値

      更新するアイテムの ID。

    • updateProperties

      オブジェクト

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

    • callback

      function 省略可

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

      () => void

ContextMenuUpdateProperties

Chrome 44 以降

プロパティ

  • ON

    ブール値（省略可）

    チェックボックスまたはラジオボタンの状態: オンの場合は true、オフの場合は false。ラジオアイテムの特定のグループで一度に選択できるラジオアイテムは 1 つのみです。

  • コンテキスト

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

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

  • documentUrlPatterns

    string[] 省略可

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

  • 有効

    ブール値（省略可）

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

  • parentId

    文字列 | 数値（省略可）

    親メニュー アイテムの ID。これにより、このアイテムは以前に追加したアイテムの子アイテムになります。注: アイテムを、そのアイテムの子孫のいずれかの子に変更することはできません。

  • targetUrlPatterns

    string[] 省略可

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

  • title

    文字列（省略可）

    項目に表示するテキスト

  • type

    ItemType 省略可

    メニュー項目のタイプ。

  • onclick

    void 省略可

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

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

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

    • 情報

      OnClickData

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

ContextType

Chrome 44 以降

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

列挙型

「all」

「page」

「frame」

「選択」

「link」

「編集可能」

「image」

「video」

「audio」

DialogController

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

プロパティ

  • キャンセル

    void

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

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

    () => {...}

  • OK

    void

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

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

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

    • レスポンス

      文字列（省略可）

      prompt ダイアログを承認する際にゲストに提供するレスポンス文字列。

DownloadPermissionRequest

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

プロパティ

  • requestMethod

    文字列

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

  • URL

    文字列

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

  • allow

    void

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

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

    () => {...}

  • 拒否

    void

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

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

    () => {...}

FileSystemPermissionRequest

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

プロパティ

  • URL

    文字列

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

  • allow

    void

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

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

    () => {...}

  • 拒否

    void

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

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

    () => {...}

FindCallbackResults

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

プロパティ

  • activeMatchOrdinal

    数値

    現在の一致の序数。

  • キャンセル済み

    ブール値

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

  • numberOfMatches

    数値

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

  • selectionRect

    SelectionRect

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

FindOptions

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

プロパティ

  • 後方

    ブール値（省略可）

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

  • matchCase

    ブール値（省略可）

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

FullscreenPermissionRequest

Chrome 43 以降

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

プロパティ

  • オリジン

    文字列

    全画面リクエストを開始した 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 の詳細。code プロパティまたは file プロパティのいずれかを設定する必要がありますが、両方を同時に設定することはできません。

プロパティ

  • コード

    文字列（省略可）

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

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

  • ファイル

    文字列（省略可）

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

InjectionItems

Chrome 44 以降

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

プロパティ

  • コード

    文字列（省略可）

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

  • ファイル

    string[] 省略可

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

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 関数は次のようになります。 

    () => {...}

PointerLockPermissionRequest

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

プロパティ

  • lastUnlockedBySelf

    ブール値

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

  • URL

    文字列

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

  • userGesture

    ブール値

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

  • allow

    void

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

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

    () => {...}

  • 拒否

    void

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

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

    () => {...}

SelectionRect

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

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

プロパティ

  • height

    数値

    長方形の高さ。

  • 左

    数値

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

  • 上

    数値

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

  • 幅

    数値

    長方形の幅。

WebRequestEventInterface

Chrome 44 以降

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

拡張機能の 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 をご覧ください。

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

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

ZoomMode

Chrome 43 以降

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

列挙型

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

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

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

プロパティ

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[]],
)

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

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

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,
)

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

パラメータ

  • callback

    function 省略可

    Chrome 44 以降

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

    (success: boolean) => void

    • success

      ブール値

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

canGoBack()

chrome.webviewTag.canGoBack()

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

戻り値

  • ブール値

canGoForward()

chrome.webviewTag.canGoForward()

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

戻り値

  • ブール値

captureVisibleRegion()

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

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

パラメータ

  • オプション

    ImageDetails 省略可

  • callback

    関数

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

    (dataUrl: string) => void

    • dataUrl

      文字列

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

clearData()

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

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

パラメータ

  • オプション

    ClearDataOptions

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

  • タイプ

    ClearDataTypeSet

    消去するデータの種類。

  • callback

    function 省略可

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

    () => void

executeScript()

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

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

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

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

パラメータ

  • 詳細

    InjectDetails

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

  • callback

    function 省略可

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

    (result?: any[]) => void

    • 件の結果

      any[] 省略可

      挿入された各フレームでのスクリプトの結果。

find()

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

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

パラメータ

  • searchText

    文字列

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

  • オプション

    FindOptions（省略可）

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

  • callback

    function 省略可

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

    (results?: FindCallbackResults) => void

    • 結果

      FindCallbackResults（省略可）

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

forward()

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

可能であれば、履歴エントリを 1 つ前方に移動します。go(1) と同じです。

パラメータ

  • callback

    function 省略可

    Chrome 44 以降

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

    (success: boolean) => void

    • success

      ブール値

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

getAudioState()

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

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

パラメータ

  • callback

    関数

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

    (audible: boolean) => void

    • Audible

      ブール値

getProcessId()

chrome.webviewTag.getProcessId()

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

戻り値

  • 数値

getUserAgent()

chrome.webviewTag.getUserAgent()

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

戻り値

  • 文字列

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

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

パラメータ

  • callback

    関数

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

    (zoomFactor: number) => void

    • zoomFactor

      数値

      現在のズーム倍率。

getZoomMode()

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

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

パラメータ

  • callback

    関数

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

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      ZoomMode

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

go()

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

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

パラメータ

  • relativeIndex

    数値

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

  • callback

    function 省略可

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

    (success: boolean) => void

    • success

      ブール値

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

insertCSS()

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

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

パラメータ

  • 詳細

    InjectDetails

    挿入する CSS の詳細。

  • callback

    function 省略可

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

    () => void

isAudioMuted()

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

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

パラメータ

  • callback

    関数

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

    (muted: boolean) => void

    • ミュート中

      ブール値

isSpatialNavigationEnabled()

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

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

パラメータ

  • callback

    関数

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

    (enabled: boolean) => void

    • 有効

      ブール値

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

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

loadDataWithBaseUrl()

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

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

パラメータ

  • dataUrl

    文字列

    読み込むデータの URL。

  • baseUrl

    文字列

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

  • virtualUrl

    文字列（省略可）

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

print()

chrome.webviewTag.print()

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

reload()

chrome.webviewTag.reload()

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

removeContentScripts()

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

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

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

webview.removeContentScripts(['myRule']);

すべてのルールを削除するには、次を呼び出します。

webview.removeContentScripts();

パラメータ

  • scriptNameList

    string[] 省略可

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

setAudioMuted()

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

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

パラメータ

  • ミュート

    ブール値

    音声をミュートする値

setSpatialNavigationEnabled()

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

ウェブビューの空間ナビゲーションの状態を設定します。

パラメータ

  • 有効

    ブール値

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

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

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

パラメータ

  • userAgent

    文字列

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

setZoom()

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

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

パラメータ

  • zoomFactor

    数値

    新しいズーム倍率。

  • callback

    function 省略可

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

    () => void

setZoomMode()

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

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

パラメータ

  • ZoomMode

    ZoomMode

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

  • callback

    function 省略可

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

    () => void

stop()

chrome.webviewTag.stop()

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

stopFinding()

chrome.webviewTag.stopFinding(
  action?: "clear" 
  | "keep" 
  | "activate" 
 ,
)

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

パラメータ

  • アクション

    "clear"
     | "keep"
     | "activate"
     省略可

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

terminate()

chrome.webviewTag.terminate()

ゲストウェブページのレンダラ プロセスを強制終了します。これは、同じプロセスを共有している場合、現在のアプリ内の複数の 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() が呼び出された場合）、ゲストプロセスがブロックされます。

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

パラメータ

  • callback

    関数

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

    (messageType: "alert" 
      | "confirm" 
      | "prompt" 
     , messageText: string, dialog: DialogController) => void

    • messageType

      「alert」
       | 「confirm」
       | 「prompt」

    • messageText

      文字列

    • ダイアログ

      DialogController

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 パラメータは次のようになります。 

    (processID: number, reason: "normal" 
      | "abnormal" 
      | "crash" 
      | "kill" 
     ) => void

    • processID

      数値

    • reason

      「normal」
       | 「abnormal」
       | 「crash」
       | 「kill」

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,
)

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

注: リソースの読み込みが中止されると、最後の loadstop イベント（存在する場合）以降に commit されたすべての読み込みが中止された場合でも、loadabort イベントの後に loadstop イベントが最終的に発生します。

注: about URL または JavaScript URL の読み込みが中断されると、loadabort がトリガーされ、webview が「about:blank」に移動します。

パラメータ

  • callback

    関数

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

    (url: string, isTopLevel: boolean, code: number, reason: "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" 
     ) => void

    • URL

      文字列

    • isTopLevel

      ブール値

    • コード

      数値

    • reason

      "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"

loadcommit

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

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

パラメータ

  • 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 イベント以降のコミット済みの読み込みがすべて中止された場合でも、最終的に loadabort イベントの後に loadstop イベントが発生します。

パラメータ

  • 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: "ignore" 
      | "save_to_disk" 
      | "current_tab" 
      | "new_background_tab" 
      | "new_foreground_tab" 
      | "new_window" 
      | "new_popup" 
     ) => void

    • 窓

      NewWindow

    • targetUrl

      文字列

    • initialWidth

      数値

    • initialHeight

      数値

    • name

      文字列

    • windowOpenDisposition

      "ignore"
       | "save_to_disk"
       | "current_tab"
       | "new_background_tab"
       | "new_foreground_tab"
       | "new_window"
       | "new_popup"

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: "media" 
      | "geolocation" 
      | "pointerLock" 
      | "download" 
      | "loadplugin" 
      | "filesystem" 
      | "fullscreen" 
      | "hid" 
     , request: object) => void

    • 権限

      "media"
       | "geolocation"
       | "pointerLock"
       | "download"
       | "loadplugin"
       | "filesystem"
       | "fullscreen"
       | "hid"

    • request

      オブジェクト

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

      数値