このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。
runtime
このモジュールは拡張機能と実行環境の情報を提供します。
また以下のような機能を持つメッセージ API も提供します:
- 拡張機能の別々の部分同士で通信します。メッセージのオプションについて詳しく知りたい場合は、ワンオフメッセージとコネクションベースのメッセージとの選択をご覧ください。
- 他の拡張機能と通信します。
- ネイティブアプリケーションと通信します。
型
runtime.Port-
2 つのコンテキスト間の接続の一方を表します。メッセージを交換するために使います。
runtime.MessageSender-
接続リクエストやメッセージの送信者の情報です。
runtime.PlatformOs-
ブラウザーの OS の識別です。
runtime.PlatformArch-
ブラウザーのプロセッサーアーキテクチャの識別です。
runtime.PlatformInfo-
ブラウザーが動作しているプラットフォームの情報です。
runtime.RequestUpdateCheckStatus-
runtime.requestUpdateCheck()を呼び出した結果です。 runtime.OnInstalledReason-
runtime.onInstalledイベントをディスパッチした理由です。 runtime.OnRestartRequiredReason-
runtime.onRestartRequiredイベントをディスパッチした理由です。
プロパティ
runtime.lastError-
呼び出し元に伝える必要があるエラーが非同期の関数で起こった時に、この値が設定されます。
runtime.id-
拡張機能の ID です。
関数
runtime.getBackgroundPage()-
拡張機能が動作しているバックグラウンドページの Window オブジェクトを取得します。
runtime.openOptionsPage()-
拡張機能のオプションページを開きます。
runtime.getFrameId()-
グローバルまたはフレーム要素のウィンドウのフレーム ID を取得します。
runtime.getManifest()-
完全な manifest.json ファイルを取得し、オブジェクトとしてシリアライズします。
runtime.getURL()-
manifest.json からの相対パスを指定し、拡張機能に含まれるリソースの完全修飾の URL を返します。
runtime.setUninstallURL()-
拡張機能がアンインストールされた時にアクセスさせる URL を設定します。
runtime.reload()-
拡張機能をリロードします。
runtime.requestUpdateCheck()-
拡張機能のアップデートを確認します。
runtime.connect()-
コンテンツスクリプトから同じ拡張機能の別の処理、または別の拡張機能への接続します。
runtime.connectNative()-
ユーザーのコンピューターに入っているネイティブアプリケーションと拡張機能を接続します。
runtime.sendMessage()-
拡張機能自身や別の拡張機能のイベントリスナーに 1 つのメッセージを送信します。
runtime.connectと似ていますが、runtime.sendMessage()では 1 つのメッセージを送るだけで、オプションで応答可能です。 runtime.sendNativeMessage()-
拡張機能からネイティプアプリケーションに 1 つのメッセージを送信します。
runtime.getPlatformInfo()-
現在のプラットフォーム情報を返します。
runtime.getBrowserInfo()-
拡張機能がインストールされたブラウザーの情報を返します。
runtime.getPackageDirectoryEntry()-
拡張機能のディレクトリーの DirectoryEntry オブジェクトを返します。
イベント
runtime.onStartup-
拡張機能がインストールされたプロフィールが最初に起動された時に発火します。このイベントは、プライベートプロフィールの起動では発火しません。
runtime.onInstalled-
拡張機能が最初にインストールされた時、拡張機能やブラウザーが新しいバージョンに更新された時に発火します。
runtime.onSuspend-
拡張機能がアンロードされる直前にイベントページに送信します。拡張機能をクリーンアップできます。
runtime.onSuspendCanceled-
拡張機能が結果的にアンロードされなかったことを示すため、
runtime.onSuspendの後に送信します。 runtime.onUpdateAvailable-
拡張機能が更新可能ですが現在実行中のため、すぐにインストールされない時に発火します。
runtime.onBrowserUpdateAvailable-
ブラウザーが更新可能ですが再起動が必要であるため、すぐにインストールされない時に発火します。
runtime.onConnect-
拡張機能の処理や コンテンツスクリプトと接続した時に発火します。
runtime.onConnectExternal-
別の拡張機能と接続した時に発火します。
runtime.onMessage-
拡張機能の処理や コンテンツスクリプトからメッセージが送信された時に発火します。
runtime.onMessageExternal-
別の拡張機能からメッセージが送信された時に発火します。コンテンツスクリプトでは使えません。
runtime.onRestartRequired-
デバイスの再起動が必要な時に発火します。
ブラウザーの互換性
Loading...
Example extensions
- beastify
- content-script-register
- cookie-bg-picker
- devtools-panels
- export-helpers
- favourite-colour
- find-across-tabs
- imagify
- menu-demo
- mocha-client-tests
- native-messaging
- notify-link-clicks-i18n
- permissions
- runtime-examples
- store-collected-images
- user-script-register
- userScripts-mv3
- webpack-modules
メモ:
この API は Chromium の chrome.runtime API に基づいています。また、このドキュメントは runtime.json における Chromium のコードに基づいています。