Revision control
Copy as Markdown
Other Tools
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
[
{
"namespace": "manifest",
"types": [
{
"$extend": "OptionalPermissionNoPrompt",
"choices": [
{
"type": "string",
"enum": ["activeTab"]
}
]
},
{
"$extend": "OptionalPermission",
"choices": [
{
"type": "string",
"enum": ["tabs", "tabHide"]
}
]
}
]
},
{
"namespace": "tabs",
"description": "The tabs API supports creating, modifying and interacting with tabs in Thunderbird windows.",
"types": [
{
"id": "Tab",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -1,
"optional": true,
"description": "The ID of the tab. Tab IDs are unique within a session. Under some circumstances a Tab may not be assigned an ID. Tab ID can also be set to :ref:`tabs.TAB_ID_NONE` for apps and devtools windows."
},
"index": {
"type": "integer",
"minimum": -1,
"description": "The zero-based index of the tab within its window."
},
"windowId": {
"type": "integer",
"optional": true,
"minimum": 0,
"description": "The ID of the window the tab is contained within."
},
"selected": {
"type": "boolean",
"description": "Whether the tab is selected.",
"deprecated": "Please use :ref:`tabs.Tab.highlighted`.",
"unsupported": true
},
"highlighted": {
"type": "boolean",
"description": "Whether the tab is highlighted. Works as an alias of active"
},
"active": {
"type": "boolean",
"description": "Whether the tab is active in its window. (Does not necessarily mean the window is focused.)"
},
"url": {
"type": "string",
"optional": true,
"permissions": ["tabs"],
"description": "The URL the tab is displaying. This property is only present if the extension's manifest includes the <permission>tabs</permission> permission."
},
"title": {
"type": "string",
"optional": true,
"permissions": ["tabs"],
"description": "The title of the tab. This property is only present if the extension's manifest includes the <permission>tabs</permission> permission."
},
"favIconUrl": {
"type": "string",
"optional": true,
"permissions": ["tabs"],
"description": "The URL of the tab's favicon. This property is only present if the extension's manifest includes the <permission>tabs</permission> permission. It may also be an empty string if the tab is loading."
},
"status": {
"type": "string",
"optional": true,
"description": "Either <value>loading</value> or <value>complete</value>."
},
"width": {
"type": "integer",
"optional": true,
"description": "The width of the tab in pixels."
},
"height": {
"type": "integer",
"optional": true,
"description": "The height of the tab in pixels."
},
"cookieStoreId": {
"type": "string",
"optional": true,
"description": "The `CookieStore <|link-cookieStore|>`__ id used by the tab. Either a custom id created using the `contextualIdentities API <|link-contextualIdentity|>`__, or a built-in one: <value>firefox-default</value>, <value>firefox-container-1</value>, <value>firefox-container-2</value>, <value>firefox-container-3</value>, <value>firefox-container-4</value>, <value>firefox-container-5</value>. **Note:** The naming pattern was deliberately not changed for Thunderbird, but kept for compatibility reasons."
},
"type": {
"$ref": "TabType",
"optional": true
},
"mailTab": {
"type": "boolean",
"optional": true,
"description": "Whether the tab is a 3-pane tab."
},
"spaceId": {
"type": "integer",
"description": "The id of the space.",
"minimum": 1,
"optional": true
}
}
},
{
"id": "TabStatus",
"type": "string",
"enum": ["loading", "complete"],
"description": "Whether the tabs have completed loading."
},
{
"id": "TabType",
"type": "string",
"enum": [
"addressBook",
"calendar",
"calendarEvent",
"calendarTask",
"chat",
"content",
"mail",
"messageCompose",
"messageDisplay",
"special",
"tasks"
],
"description": "Tab types supported by the tabs API."
},
{
"id": "WindowType",
"type": "string",
"description": "The type of a window. Under some circumstances a Window may not be assigned a type property.",
"enum": [
"normal",
"popup",
"panel",
"app",
"devtools",
"messageCompose",
"messageDisplay"
]
},
{
"id": "UpdatePropertyName",
"type": "string",
"enum": ["favIconUrl", "status", "title"],
"description": "Event names supported in onUpdated."
},
{
"id": "UpdateFilter",
"type": "object",
"description": "An object describing filters to apply to tabs.onUpdated events.",
"properties": {
"urls": {
"type": "array",
"description": "A list of URLs or URL patterns. Events that cannot match any of the URLs will be filtered out. Filtering with urls requires the <permission>tabs</permission> or <permission>activeTab</permission> permission.",
"optional": true,
"items": {
"type": "string"
},
"minItems": 1
},
"properties": {
"type": "array",
"optional": true,
"description": "A list of property names. Events that do not match any of the names will be filtered out.",
"items": {
"$ref": "UpdatePropertyName"
},
"minItems": 1
},
"tabId": {
"type": "integer",
"optional": true
},
"windowId": {
"type": "integer",
"optional": true
}
}
}
],
"properties": {
"TAB_ID_NONE": {
"value": -1,
"description": "An ID which represents the absence of a tab."
}
},
"functions": [
{
"name": "get",
"type": "function",
"description": "Retrieves details about the specified tab.",
"async": "callback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "tab",
"$ref": "Tab"
}
]
}
]
},
{
"name": "getCurrent",
"type": "function",
"description": "Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example: a background page or popup view).",
"async": "callback",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "tab",
"$ref": "Tab",
"optional": true
}
]
}
]
},
{
"name": "connect",
"type": "function",
"description": "Connects to the content script(s) in the specified tab. The `runtime.onConnect <|link-runtime-on-connect|>`__ event is fired in each content script running in the specified tab for the current extension. For more details, see `Content Script Messaging <|link-content-scripts|>`__.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "connectInfo",
"properties": {
"name": {
"type": "string",
"optional": true,
"description": "Will be passed into onConnect for content scripts that are listening for the connection event."
},
"frameId": {
"type": "integer",
"optional": true,
"minimum": 0,
"description": "Open a port to a specific frame identified by ``frameId`` instead of all frames in the tab."
}
},
"optional": true
}
],
"returns": {
"$ref": "runtime.Port",
"description": "A port that can be used to communicate with the content scripts running in the specified tab."
}
},
{
"name": "sendMessage",
"type": "function",
"description": "Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The `runtime.onMessage <|link-runtime-on-message|>`__ event is fired in each content script running in the specified tab for the current extension.",
"async": "responseCallback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "any",
"name": "message"
},
{
"type": "object",
"name": "options",
"properties": {
"frameId": {
"type": "integer",
"optional": true,
"minimum": 0,
"description": "Send a message to a specific frame identified by ``frameId`` instead of all frames in the tab."
}
},
"optional": true
},
{
"type": "function",
"name": "responseCallback",
"optional": true,
"parameters": [
{
"name": "response",
"type": "any",
"description": "The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and `runtime.lastError <|link-runtime-last-error|>`__ will be set to the error message."
}
]
}
]
},
{
"name": "create",
"type": "function",
"description": "Creates a new content tab. Use the :ref:`messageDisplay_api` to open messages. Only supported in <value>normal</value> windows. Same-site links in the loaded page are opened within Thunderbird, all other links are opened in the user's default browser. To override this behavior, add-ons have to register a `content script <https://bugzilla.mozilla.org/show_bug.cgi?id=1618828#c3>`__ , capture click events and handle them manually.",
"async": "callback",
"parameters": [
{
"type": "object",
"name": "createProperties",
"description": "Properties for the new tab. Defaults to an empty tab, if no ``url`` is provided.",
"properties": {
"windowId": {
"type": "integer",
"minimum": -2,
"optional": true,
"description": "The window to create the new tab in. Defaults to the current window."
},
"index": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window."
},
"url": {
"type": "string",
"optional": true,
"description": "The URL to navigate the tab to initially. If the URL points to a content page (a web page, an extension page or a registered WebExtension protocol handler page), the tab will navigate to the requested page. All other URLs will be opened externally after creating an empty tab. Fully-qualified URLs must include a scheme (i.e. <value>http://www.google.com</value>, not <value>www.google.com</value>). Relative URLs will be relative to the root of the extension. "
},
"active": {
"type": "boolean",
"optional": true,
"description": "Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see :ref:`windows.update`). Defaults to <value>true</value>."
},
"cookieStoreId": {
"type": "string",
"optional": true,
"description": "The `CookieStore <|link-cookieStore|>`__ id the new tab should use. Either a custom id created using the `contextualIdentities API <|link-contextualIdentity|>`__, or a built-in one: <value>firefox-default</value>, <value>firefox-container-1</value>, <value>firefox-container-2</value>, <value>firefox-container-3</value>, <value>firefox-container-4</value>, <value>firefox-container-5</value>. **Note:** The naming pattern was deliberately not changed for Thunderbird, but kept for compatibility reasons."
},
"selected": {
"deprecated": "Please use ``createProperties.active``.",
"unsupported": true,
"type": "boolean",
"optional": true,
"description": "Whether the tab should become the selected tab in the window. Defaults to <value>true</value>"
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "tab",
"$ref": "Tab",
"optional": true,
"description": "Details about the created tab. Will contain the ID of the new tab."
}
]
}
]
},
{
"name": "duplicate",
"type": "function",
"description": "Duplicates a tab.",
"async": "callback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"description": "The ID of the tab which is to be duplicated."
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "tab",
"optional": true,
"description": "Details about the duplicated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the <permission>tabs</permission> permission has not been requested.",
"$ref": "Tab"
}
]
}
]
},
{
"name": "query",
"type": "function",
"description": "Gets all tabs that have the specified properties, or all tabs if no properties are specified.",
"async": "callback",
"parameters": [
{
"type": "object",
"name": "queryInfo",
"optional": true,
"default": {},
"properties": {
"mailTab": {
"type": "boolean",
"optional": true,
"description": "Whether the tab is a Thunderbird 3-pane tab."
},
"spaceId": {
"type": "integer",
"description": "The id of the space the tabs should belong to.",
"minimum": 1,
"optional": true
},
"type": {
"choices": [
{
"$ref": "TabType"
},
{
"type": "array",
"items": {
"$ref": "TabType"
}
}
],
"optional": true,
"description": "Match tabs against the given tab type or types. Ignored if ``queryInfo.mailTab`` is specified."
},
"active": {
"type": "boolean",
"optional": true,
"description": "Whether the tabs are active in their windows."
},
"highlighted": {
"type": "boolean",
"optional": true,
"description": "Whether the tabs are highlighted. Works as an alias of active."
},
"currentWindow": {
"type": "boolean",
"optional": true,
"description": "Whether the tabs are in the current window."
},
"lastFocusedWindow": {
"type": "boolean",
"optional": true,
"description": "Whether the tabs are in the last focused window."
},
"status": {
"$ref": "TabStatus",
"optional": true,
"description": "Whether the tabs have completed loading."
},
"title": {
"type": "string",
"optional": true,
"description": "Match page titles against a pattern."
},
"url": {
"choices": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"optional": true,
"description": "Match tabs against one or more `URL Patterns <|link-match-patterns|>`__. Note that fragment identifiers are not matched."
},
"windowId": {
"type": "integer",
"optional": true,
"minimum": -2,
"description": "The ID of the parent window, or :ref:`windows.WINDOW_ID_CURRENT` for the current window."
},
"windowType": {
"$ref": "WindowType",
"optional": true,
"description": "The type of window the tabs are in."
},
"index": {
"type": "integer",
"optional": true,
"minimum": 0,
"description": "The position of the tabs within their windows."
},
"cookieStoreId": {
"choices": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
],
"optional": true,
"description": "The `CookieStore <|link-cookieStore|>`__ id(s) used by the tabs. Either custom ids created using the `contextualIdentities API <|link-contextualIdentity|>`__, or built-in ones: <value>firefox-default</value>, <value>firefox-container-1</value>, <value>firefox-container-2</value>, <value>firefox-container-3</value>, <value>firefox-container-4</value>, <value>firefox-container-5</value>. **Note:** The naming pattern was deliberately not changed for Thunderbird, but kept for compatibility reasons."
}
}
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "result",
"type": "array",
"items": {
"$ref": "Tab"
}
}
]
}
]
},
{
"name": "update",
"type": "function",
"description": "Modifies the properties of a tab. Properties that are not specified in ``updateProperties`` are not modified.",
"async": "callback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the current window."
},
{
"type": "object",
"name": "updateProperties",
"description": "Properties which should to be updated.",
"properties": {
"url": {
"type": "string",
"optional": true,
"description": "A URL of a page to load. If the URL points to a content page (a web page, an extension page or a registered WebExtension protocol handler page), the tab will navigate to the requested page. All other URLs will be opened externally without changing the tab. **Note:** This function will throw an error, if a content page is loaded into a non-content tab (its type must be either <value>content</value> or <value>mail</value>)."
},
"active": {
"type": "boolean",
"optional": true,
"description": "Set this to <value>true</value>, if the tab should become active. Does not affect whether the window is focused (see :ref:`windows.update`). Setting this to <value>false</value> has no effect."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "tab",
"$ref": "Tab",
"optional": true,
"description": "Details about the updated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the <permission>tabs</permission> permission has not been requested."
}
]
}
]
},
{
"name": "move",
"type": "function",
"description": "Moves one or more tabs to a new position within its current window, or to a different window. Note that tabs can only be moved to and from windows of type <value>normal</value>.",
"async": "callback",
"parameters": [
{
"name": "tabIds",
"description": "The tab or list of tabs to move.",
"choices": [
{
"type": "integer",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "integer",
"minimum": 0
}
}
]
},
{
"type": "object",
"name": "moveProperties",
"properties": {
"windowId": {
"type": "integer",
"minimum": -2,
"optional": true,
"description": "Defaults to the window the tab is currently in."
},
"index": {
"type": "integer",
"minimum": -1,
"description": "The position to move the tab to. <value>-1</value> will place the tab at the end of the window."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "tabs",
"description": "Details about the moved tabs.",
"type": "array",
"items": {
"$ref": "Tab"
}
}
]
}
]
},
{
"name": "reload",
"type": "function",
"description": "Reload a tab. Only applicable for tabs which display a content page.",
"async": "callback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"optional": true,
"description": "The ID of the tab to reload; defaults to the selected tab of the current window."
},
{
"type": "object",
"name": "reloadProperties",
"optional": true,
"properties": {
"bypassCache": {
"type": "boolean",
"optional": true,
"description": "Whether using any local cache. Default is false."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": []
}
]
},
{
"name": "remove",
"type": "function",
"description": "Closes one or more tabs.",
"async": "callback",
"parameters": [
{
"name": "tabIds",
"description": "The tab or list of tabs to close.",
"choices": [
{
"type": "integer",
"minimum": 0
},
{
"type": "array",
"items": {
"type": "integer",
"minimum": 0
}
}
]
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": []
}
]
},
{
"name": "executeScript",
"type": "function",
"description": "Injects JavaScript code into a page. For details, see the `programmatic injection <|link-content-scripts|>`__ section of the content scripts doc.",
"async": "callback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"optional": true,
"description": "The ID of the tab in which to run the script; defaults to the active tab of the current window."
},
{
"$ref": "extensionTypes.InjectDetails",
"name": "details",
"description": "Details of the script to run."
},
{
"type": "function",
"name": "callback",
"optional": true,
"description": "Called after all the JavaScript has been executed.",
"parameters": [
{
"name": "result",
"optional": true,
"type": "array",
"items": {
"type": "any"
},
"description": "The result of the script in every injected frame."
}
]
}
]
},
{
"name": "insertCSS",
"type": "function",
"description": "Injects CSS into a page. For details, see the `programmatic injection <|link-content-scripts|>`__ section of the content scripts doc.",
"async": "callback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"optional": true,
"description": "The ID of the tab in which to insert the CSS; defaults to the active tab of the current window."
},
{
"$ref": "extensionTypes.InjectDetails",
"name": "details",
"description": "Details of the CSS text to insert."
},
{
"type": "function",
"name": "callback",
"optional": true,
"description": "Called when all the CSS has been inserted.",
"parameters": []
}
]
},
{
"name": "removeCSS",
"type": "function",
"description": "Removes injected CSS from a page. For details, see the `programmatic injection <|link-content-scripts|>`__ section of the content scripts doc.",
"async": "callback",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"optional": true,
"description": "The ID of the tab from which to remove the injected CSS; defaults to the active tab of the current window."
},
{
"$ref": "extensionTypes.InjectDetails",
"name": "details",
"description": "Details of the CSS text to remove."
},
{
"type": "function",
"name": "callback",
"optional": true,
"description": "Called when all the CSS has been removed.",
"parameters": []
}
]
}
],
"events": [
{
"name": "onCreated",
"type": "function",
"description": "Fired when a tab is created. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events to be notified when a URL is set.",
"parameters": [
{
"$ref": "Tab",
"name": "tab",
"description": "Details of the tab that was created."
}
]
},
{
"name": "onUpdated",
"type": "function",
"description": "Fired when a tab is updated.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "changeInfo",
"description": "Lists the changes to the state of the tab that was updated.",
"properties": {
"status": {
"type": "string",
"optional": true,
"description": "The status of the tab. Can be either <value>loading</value> or <value>complete</value>."
},
"url": {
"type": "string",
"optional": true,
"description": "The tab's URL if it has changed."
},
"favIconUrl": {
"type": "string",
"optional": true,
"description": "The tab's new favicon URL."
}
}
},
{
"$ref": "Tab",
"name": "tab",
"description": "Gives the state of the tab that was updated."
}
],
"extraParameters": [
{
"$ref": "UpdateFilter",
"name": "filter",
"optional": true,
"description": "A set of filters that restricts the events that will be sent to this listener."
}
]
},
{
"name": "onMoved",
"type": "function",
"description": "Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see :ref:`tabs.onDetached`.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "moveInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0
},
"fromIndex": {
"type": "integer",
"minimum": 0
},
"toIndex": {
"type": "integer",
"minimum": 0
}
}
}
]
},
{
"name": "onActivated",
"type": "function",
"description": "Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events to be notified when a URL is set.",
"parameters": [
{
"type": "object",
"name": "activeInfo",
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"description": "The ID of the tab that has become active."
},
"previousTabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The ID of the tab that was previously active, if that tab is still open."
},
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The ID of the window the active tab changed inside of."
}
}
}
]
},
{
"name": "onDetached",
"type": "function",
"description": "Fired when a tab is detached from a window, for example because it is being moved between windows.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "detachInfo",
"properties": {
"oldWindowId": {
"type": "integer",
"minimum": 0
},
"oldPosition": {
"type": "integer",
"minimum": 0
}
}
}
]
},
{
"name": "onAttached",
"type": "function",
"description": "Fired when a tab is attached to a window, for example because it was moved between windows.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "attachInfo",
"properties": {
"newWindowId": {
"type": "integer",
"minimum": 0
},
"newPosition": {
"type": "integer",
"minimum": 0
}
}
}
]
},
{
"name": "onRemoved",
"type": "function",
"description": "Fired when a tab is closed.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "removeInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The window whose tab is closed."
},
"isWindowClosing": {
"type": "boolean",
"description": "Is <value>true</value> when the tab is being closed because its window is being closed."
}
}
}
]
}
]
}
]