拡張機能に関連するユーティリティ。拡張機能のリソースパッケージのURLを取得したり、拡張機能のページの Window オブジェクトを取得したり、いろいろな設定の値を取得したりします。注意として、このモジュールのメッセージ APIs は非推奨で、 runtime モジュールの同様な API が好まれます。
型
extension.ViewType- 拡張機能ビューの型
プロパティ
extension.lastError- 同期型の拡張機能APIがエラーに終わった場合のコールバックの寿命をセットします。エラーが起きなかったら lastError は undefined.になります。
extension.inIncognitoContext- incognito タブ内でコンテンツスクリプトが実行されたり、 incognito プロセス内で拡張機能ページが実行されたら true になります。後者は 'split' incognito_behavior の場合だけです。
関数
extension.getURL()- 拡張機能がインストールされたディレクトリーの相対パスを完全修飾 URL に変換する
extension.getViews()- 今の拡張機能内で実行されているページの
Windowオブジェクトを返す extension.getBackgroundPage()- 今の拡張機能内で実行されているバックグラウンドページの
Windowオブジェクトを返す。拡張機能がバックグラウンドページを持たない場合は null を返す extension.isAllowedIncognitoAccess()- 拡張機能が Incognito-モード (ユーザーが制御する 'Incognito を許可' のチェックボックスで定義される) にアクセスする状態を取得する
extension.isAllowedFileSchemeAccess()- 拡張機能が 'file://' スキーム(ユーザーが制御する 'File URLs のアクセスを許可' のチェックボックスで定義される) にアクセスする状態を取得する
extension.setUpdateUrlData()- 拡張機能の更新URL内で使われる ap CGI パラメーターをセットする。この値はブラウザーのベンダーストアでホストされる拡張機能では無視される
イベント
extension.onRequest- 拡張機能のプロセスかコンテンツスクリプトのいずれかからリクエストが送られた時に発火します
extension.onRequestExternal- その他の拡張機能からリクエストが送られた時に発火します
ブラウザ実装状況
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
ViewType | 有り | 無し | 45 | 48 | 有り |
getBackgroundPage | 有り | 有り | 45 | 48 | 有り |
getExtensionTabs | 有り | 無し | 無し | 無し | 無し |
getURL | 有り | 有り | 45 | 48 | 有り |
getViews | 有り | 有り | 45 * | 48 * | 有り |
inIncognitoContext | 有り | 無し | 45 | 48 | 有り |
isAllowedFileSchemeAccess | 有り | 無し | 48 | 48 | 有り |
isAllowedIncognitoAccess | 有り | 無し | 48 | 48 | 有り |
lastError | 有り | 無し | 47 | 48 | 有り |
onRequest | 有り | 無し | 無し | 無し | 有り |
onRequestExternal | 有り | 無し | 無し | 無し | 有り |
sendRequest | 有り | 無し | 無し | 無し | 無し |
setUpdateUrlData | 有り | 無し | 無し | 無し | 有り |
Example extensions
- beastify
- cookie-bg-picker
- find-across-tabs
- imagify
- notify-link-clicks-i18n
- proxy-blocker
- user-agent-rewriter
謝辞
この API は Chromium の chrome.extension API に基づいています。また、このドキュメントは extension.jsonにおける Chromium のコードに基づいています。
Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.