chrome.extension

説明

chrome.extension API には、任意の拡張機能ページで使用できるユーティリティがあります。拡張機能とそのコンテンツ スクリプト間、または拡張機能間でのメッセージ交換がサポートされています。詳しくは、メッセージ パススルーをご覧ください。

型

ViewType

Chrome 44 以降

拡張機能ビューのタイプ。

列挙型

「タブ」

「popup」

プロパティ

inIncognitoContext

シークレット タブ内で実行されるコンテンツ スクリプトと、シークレット プロセス内で実行される拡張機能ページの場合、true です。後者は、incognito_behavior が「split」の拡張機能にのみ適用されます。

タイプ

ブール値

メソッド

getBackgroundPage()

フォアグラウンドのみ 
chrome.extension.getBackgroundPage()

現在の拡張機能内で実行されているバックグラウンド ページの JavaScript の「window」オブジェクトを返します。拡張機能にバックグラウンド ページがない場合、null を返します。

戻り値

  • ウィンドウ | 未定義

getViews()

フォアグラウンドのみ 
chrome.extension.getViews(
  fetchProperties?: object,
)

現在の拡張機能内で実行されている各ページの JavaScript の「window」オブジェクトの配列を返します。

パラメータ

  • fetchProperties

    オブジェクト（省略可）

    • tabId

      number（省略可）

      Chrome 54 以降

      タブ ID に応じてビューを検索します。このフィールドを省略すると、すべてのビューが返されます。

    • type

      ViewType 省略可

      取得するビューのタイプ。省略すると、すべてのビュー（バックグラウンド ページとタブを含む）が返されます。

    • windowId

      number（省略可）

      検索対象の期間。省略すると、すべてのビューが返されます。

戻り値

  • Window[]

    グローバル オブジェクトの配列

isAllowedFileSchemeAccess()

Promise 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

拡張機能の「file://」スキームへのアクセスの状態を取得します。これは、chrome://extensions ページからアクセスできる、ユーザーが拡張機能ごとに管理する [ファイルの URL へのアクセスを許可する] 設定に対応しています。

パラメータ

  • callback

    function 省略可

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      ブール値

      拡張機能が「file://」スキームにアクセスできる場合は true、それ以外の場合は false。

戻り値

  • Promise<boolean>

    Chrome 99 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

isAllowedIncognitoAccess()

Promise 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

シークレット モードへの拡張機能のアクセスの状態を取得します。これは、chrome://extensions ページからアクセスできる、ユーザーが拡張機能ごとに制御できる [シークレット モードで許可] 設定に対応しています。

パラメータ

  • callback

    function 省略可

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      ブール値

      拡張機能がシークレット モードにアクセスできる場合は true、それ以外の場合は false。

戻り値

  • Promise<boolean>

    Chrome 99 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

拡張機能の更新 URL で使用される ap CGI パラメータの値を設定します。Chrome 拡張機能ギャラリーでホストされている拡張機能の場合、この値は無視されます。

パラメータ

  • データ

    文字列

イベント