runtime

このモジュールは拡張機能と実行環境の情報を提供します。

また以下のような機能を持つメッセージ API も提供します:

runtime.Port (en-US)

2 つのコンテキスト間の接続の一方を表します。メッセージを交換するために使います。

runtime.MessageSender

接続リクエストやメッセージの送信者の情報です。

runtime.PlatformOs (en-US)

ブラウザーの OS の識別です。

runtime.PlatformArch (en-US)

ブラウザーのプロセッサーアーキテクチャの識別です。

runtime.PlatformInfo (en-US)

ブラウザーが動作しているプラットフォームの情報です。

runtime.RequestUpdateCheckStatus (en-US)

runtime.requestUpdateCheck() (en-US) を呼び出した結果です。

runtime.OnInstalledReason (en-US)

runtime.onInstalled (en-US) イベントをディスパッチした理由です。

runtime.OnRestartRequiredReason (en-US)

runtime.onRestartRequired (en-US) イベントをディスパッチした理由です。

プロパティ

runtime.lastError

呼び出し元に伝える必要があるエラーが非同期の関数で起こった時に、この値が設定されます。

runtime.id (en-US)

拡張機能の ID です。

関数

runtime.getBackgroundPage() (en-US)

拡張機能が動作しているバックグラウンドページの Window オブジェクトを取得します。

runtime.openOptionsPage()

拡張機能のオプションページを開きます。

runtime.getFrameId() (en-US)

グローバルまたはフレーム要素のウィンドウのフレーム ID を取得します。

runtime.getManifest() (en-US)

完全な manifest.json ファイルを取得し、オブジェクトとしてシリアライズします。

runtime.getURL() (en-US)

manifest.json からの相対パスを指定し、拡張機能に含まれるリソースの完全修飾の URL を返します。

runtime.setUninstallURL() (en-US)

拡張機能がアンインストールされた時にアクセスさせる URL を設定します。

runtime.reload() (en-US)

拡張機能をリロードします。

runtime.requestUpdateCheck() (en-US)

拡張機能のアップデートを確認します。

runtime.connect() (en-US)

コンテンツスクリプトから同じ拡張機能の別の処理、または別の拡張機能への接続します。

runtime.connectNative() (en-US)

ユーザーのコンピューターに入っているネイティブアプリケーションと拡張機能を接続します。

runtime.sendMessage()

拡張機能自身や別の拡張機能のイベントリスナーに 1 つのメッセージを送信します。 runtime.connect (en-US) と似ていますが、 runtime.sendMessage() では 1 つのメッセージを送るだけで、オプションで応答可能です。

runtime.sendNativeMessage() (en-US)

拡張機能からネイティプアプリケーションに 1 つのメッセージを送信します。

runtime.getPlatformInfo() (en-US)

現在のプラットフォーム情報を返します。

runtime.getBrowserInfo() (en-US)

拡張機能がインストールされたブラウザーの情報を返します。

runtime.getPackageDirectoryEntry() (en-US)

拡張機能のディレクトリの DirectoryEntry オブジェクトを返します。

イベント

runtime.onStartup (en-US)

拡張機能がインストールされたプロフィールが最初に起動された時に発火します。このイベントは、プライベートプロフィールの起動では発火しません。

runtime.onInstalled (en-US)

拡張機能が最初にインストールされた時、拡張機能やブラウザーが新しいバージョンに更新された時に発火します。

runtime.onSuspend (en-US)

拡張機能がアンロードされる直前にイベントページに送信します。拡張機能をクリーンアップできます。

runtime.onSuspendCanceled (en-US)

拡張機能が結果的にアンロードされなかったことを示すため、 runtime.onSuspend (en-US) の後に送信します。

runtime.onUpdateAvailable (en-US)

拡張機能が更新可能ですが現在実行中のため、すぐにインストールされない時に発火します。

runtime.onBrowserUpdateAvailable (en-US)

ブラウザーが更新可能ですが再起動が必要であるため、すぐにインストールされない時に発火します。

runtime.onConnect (en-US)

拡張機能の処理や コンテンツスクリプトと接続した時に発火します。

runtime.onConnectExternal (en-US)

別の拡張機能と接続した時に発火します。

runtime.onMessage

拡張機能の処理や コンテンツスクリプトからメッセージが送信された時に発火します。

runtime.onMessageExternal (en-US)

別の拡張機能からメッセージが送信された時に発火します。コンテンツスクリプトでは使えません。

runtime.onRestartRequired (en-US)

デバイスの再起動が必要な時に発火します。

ブラウザーの互換性

BCD tables only load in the browser

Example extensions

メモ: この API は Chromium の chrome.runtime API に基づいています。また、このドキュメントは runtime.json における Chromium のコードに基づいています。Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。