1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
---
title: runtime.sendMessage()
slug: Mozilla/Add-ons/WebExtensions/API/runtime/sendMessage
tags:
- API
- Add-ons
- Extensions
- Method
- Non-standard
- Reference
- WebExtensions
- runtime
- sendMessage
translation_of: Mozilla/Add-ons/WebExtensions/API/runtime/sendMessage
---
<div>{{AddonSidebar()}}</div>
<p>単一のメッセージを、自分や別の拡張機能が持つイベントリスナーに送信します。</p>
<p>自分自身の拡張機能に送信する場合は、引数 <code>extensionId</code> を省略してください。自らの拡張機能に含まれる全てのページで {{WebExtAPIRef('runtime.onMessage')}} イベントが起動されます。ただし、<code>runtime.sendMessage</code> を実行したフレームは除きます。</p>
<p>別の拡張機能に送信する場合は、引数 <code>extensionId</code> に拡張機能の ID を設定してください。その拡張機能で {{WebExtAPIRef('runtime.onMessageExternal')}} イベントが起動されます。</p>
<p>このメソッドを使ってコンテンツスクリプトにメッセージを送信することはできません。コンテンツスクリプトにメッセージを送信するには、{{WebExtAPIRef('tabs.sendMessage')}} を使ってください。</p>
<ul>
</ul>
<p>これは、<code><a href="https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></code> を返す非同期関数です。</p>
<div class="blockIndicator note">
<p><a href="/ja/docs/Mozilla/Add-ons/WebExtensions/Content_scripts#Connection-based_messaging">コネクションベースのメッセージ</a>を使うこともできます。</p>
</div>
<h2 id="構文">構文</h2>
<pre class="syntaxbox brush:js">var sending = browser.runtime.sendMessage(
extensionId, // optional string
message, // any
options // optional object
)
</pre>
<h3 id="引数">引数</h3>
<dl>
<dt><code>extensionId</code>{{optional_inline}}</dt>
<dd><code>string</code> 型。 メッセージを送信する拡張機能の ID。別の拡張機能にメッセージを送信する場合は、この引数を含めてください。受信させることを意図している拡張機能が manifest.json の <a href="https://developer.mozilla.org/ja/docs/Mozilla/Add-ons/WebExtensions/manifest.json/applications">applications</a> キーを使って明示的に ID を設定されている場合は、その値を <code>extensionId</code> に指定する必要があります。そうでない場合、受信側の拡張機能のために生成された ID を指定する必要があります。</dd>
<dd>もし <code>extensionId</code> が省略された場合、メッセージは自分自身の拡張機能に送信されます。</dd>
<dt><code>message</code></dt>
<dd><code>any</code> 型。シリアライズされたクローンに構造化できるオブジェクト。</dd>
<dt><code>options</code>{{optional_inline}}</dt>
<dd><code>object</code> 型。
<dl class="reference-values">
<dt><code>includeTlsChannelId</code>{{optional_inline}}</dt>
<dd><code>boolean</code> 型。接続イベントを待つプロセスのための {{WebExtAPIRef('runtime.onMessageExternal')}} に TLS チャンネル ID が渡されるかどうか。</dd>
<dt><code>toProxyScript{{optional_inline}}</code></dt>
<dd><code>boolean</code> 型。 メッセージが {{WebExtAPIRef("proxy")}} API を使って読み込まれる PAC ファイル向けである場合、true を指定しなければならない。</dd>
</dl>
</dd>
</dl>
<p>引数に指定される値によっては、この API はあいまいです。以降のルールが使われます。</p>
<ul>
<li><strong>引数が一つの場合</strong>、それは送信されるメッセージで、内部的に送信されます。</li>
<li><strong>引数が二つの場合</strong>
<ul>
<li>二番目の引数が次のいずれかである場合、引数は <code>(message, options)</code> と解釈され、メッセージは内部的に送信されます。
<ol>
<li>有効な <code>options</code> オブジェクトである (つまり、ブラウザがサポートする <code>options</code> のプロパティのみを持つオブジェクト)</li>
<li>null</li>
<li>undefined</li>
</ol>
</li>
<li>それ以外の場合、引数は <code>(extensionId, message)</code> と解釈され、メッセージは <code>extensionId</code> によって識別された拡張機能に送信されます。</li>
</ul>
</li>
<li><strong>引数が三つの場合</strong>、引数は <code>(extensionId, message, options)</code> と解釈されます。メッセージは <code>extensionId</code> によって識別された拡張機能に送信されます。</li>
</ul>
<p>Firefox 55 より前では、引数が二つの場合のルールが異なることに注意してください。古いルールでは、最初の引数が文字列である場合、それを <code>extensionId</code> と扱い、二番目の引数をメッセージとして使います。これは、<code>sendMessage()</code> を <code>("my-message", {})</code> のような引数を使って実行する場合、空のメッセージを "my-message" によって識別される拡張機能に送信してしまうということです。新しいルールのもとでは、このような引数を使うと、"my-message" というメッセージを空のオプションオブジェクトを使って内部的に送信します。</p>
<h3 id="戻り値">戻り値</h3>
<p><code><a href="https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></code> 型。受信側が応答を送信する場合、その応答を JSON オブジェクトとして使って fulfilled 状態にされます。それ以外の場合、値を持たない fulfilled 状態になります。拡張機能との接続中にエラーが発生した場合、Promise はエラーメッセージを持つ rejected 状態になります。</p>
<h2 id="ブラウザー実装状況">ブラウザー実装状況</h2>
<p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p>
<p>{{Compat("webextensions.api.runtime.sendMessage")}}</p>
<h2 id="使用例">使用例</h2>
<p>これは、ユーザーがコンテンツのウィンドウをクリックしたときにバックグラウンド スクリプトにメッセージを送信するコンテンツスクリプトです。送信されるメッセージは <code>{greeting: "Greeting from the content script"}</code> で、送信側は応答を受信をすることになっており、それを <code>handleResponse</code> 関数で扱います。</p>
<pre class="brush: js">// content-script.js
function handleResponse(message) {
console.log(`Message from the background script: ${message.response}`);
}
function handleError(error) {
console.log(`Error: ${error}`);
}
function notifyBackgroundPage(e) {
var sending = browser.runtime.sendMessage({
greeting: "Greeting from the content script"
});
sending.then(handleResponse, handleError);
}
window.addEventListener("click", notifyBackgroundPage);</pre>
<p>対応するバックグラウンド スクリプトは次のようなものです。</p>
<pre class="brush: js">// background-script.js
function handleMessage(request, sender, sendResponse) {
console.log("Message from the content script: " +
request.greeting);
sendResponse({response: "Response from background script"});
}
browser.runtime.onMessage.addListener(handleMessage);</pre>
<p>{{WebExtExamples}}</p>
<div class="note"><strong>謝辞</strong>
<p>この API は Chromium の <a href="https://developer.chrome.com/extensions/runtime#method-sendMessage"><code>chrome.runtime</code></a> API に基づいています。このドキュメントは <a href="https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/runtime.json"><code>runtime.json</code></a> における Chromium のコードに基づいています。</p>
<p>Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。</p>
</div>
<div class="hidden">
<pre>// 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.
</pre>
</div>
|
