tabs.sendMessage()
从 background scripts 中发送单个消息 (or other privileged scripts, such as popup scripts or options page scripts) 到任何 content scripts that belong to the extension and are running in the specified tab.
这个消息将被 content scripts 中 runtime.onMessage
事件的所有监听者收到,然后它们可以选择通过使用 sendResponse
这个方法发送一个 response 到 background scripts。
This is an asynchronous function that returns a Promise
.
Syntax
var sending = browser.tabs.sendMessage(
tabId, // integer
message, // any
options // optional object
)
Parameters
tabId
-
integer
. ID of the tab whose content scripts we want to send a message to. message
-
any
. An object that can be serialized to JSON. options
可选-
object
.frameId
可选-
integer
. Sends the message to a specific frame identified byframeId
instead of all frames in the tab. Whether the content script is executed in all frames depends on theall_frames
setting in thecontent_scripts
section of manifest.json.
Return value
A Promise
that will be fulfilled with the JSON response object sent by the handler of the message in the content script, or with no arguments if the content script did not send a response. If an error occurs while connecting to the specified tab or any other error occurs, the promise will be rejected with an error message. If several frames response to the message, the promise is resolved to one of answers.
Browser compatibility
BCD tables only load in the browser
Examples
Here's an example of a background script that sends a message to the content scripts running in the active tab when the user clicks the browser action. The background script also expects the content script to send a response:
// background-script.js
"use strict";
function onError(error) {
console.error(`Error: ${error}`);
}
function sendMessageToTabs(tabs) {
for (let tab of tabs) {
browser.tabs.sendMessage(
tab.id,
{greeting: "Hi from background script"}
).then(response => {
console.log("Message from the content script:");
console.log(response.response);
}).catch(onError);
}
}
browser.browserAction.onClicked.addListener(() => {
browser.tabs.query({
currentWindow: true,
active: true
}).then(sendMessageToTabs).catch(onError);
});
Here's the corresponding content script:
// content-script.js
"use strict";
browser.runtime.onMessage.addListener(request => {
console.log("Message from the background script:");
console.log(request.greeting);
return Promise.resolve({response: "Hi from content script"});
});
Example extensions
备注: This API is based on Chromium's chrome.tabs
API. This documentation is derived from tabs.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.