[ { "events": [ { "description": "Fired when an alarm has expired. Useful for transient background pages.", "name": "onAlarm", "parameters": [ { "$ref": "Alarm", "description": "The alarm that has expired.", "name": "name" } ], "type": "function" } ], "functions": [ { "description": "Creates an alarm. After the delay is expired, the onAlarm event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.", "name": "create", "parameters": [ { "description": "Optional name to identify this alarm. Defaults to the empty string.", "name": "name", "optional": true, "type": "string" }, { "description": "Details about the alarm. The alarm first fires either at 'when' milliseconds past the epoch (if 'when' is provided), after 'delayInMinutes' minutes from the current time (if 'delayInMinutes' is provided instead), or after 'periodInMinutes' minutes from the current time (if only 'periodInMinutes' is provided). Users should never provide both 'when' and 'delayInMinutes'. If 'periodInMinutes' is provided, then the alarm recurs repeatedly after that many minutes.", "name": "alarmInfo", "properties": { "delayInMinutes": { "description": "Number of minutes from the current time after which the alarm should first fire.", "optional": true, "type": "number" }, "periodInMinutes": { "description": "Number of minutes after which the alarm should recur repeatedly.", "optional": true, "type": "number" }, "when": { "description": "Time when the alarm is scheduled to first fire, in milliseconds past the epoch.", "optional": true, "type": "number" } }, "type": "object" } ], "type": "function" }, { "async": "callback", "description": "Retrieves details about the specified alarm.", "name": "get", "parameters": [ { "description": "The name of the alarm to get. Defaults to the empty string.", "name": "name", "optional": true, "type": "string" }, { "name": "callback", "parameters": [ { "$ref": "Alarm", "name": "alarm", "optional": true } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets an array of all the alarms.", "name": "getAll", "parameters": [ { "name": "callback", "parameters": [ { "items": { "$ref": "Alarm" }, "name": "alarms", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears the alarm with the given name.", "name": "clear", "parameters": [ { "description": "The name of the alarm to clear. Defaults to the empty string.", "name": "name", "optional": true, "type": "string" }, { "name": "callback", "parameters": [ { "description": "Whether an alarm of the given name was found to clear.", "name": "wasCleared", "type": "boolean" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears all alarms.", "name": "clearAll", "parameters": [ { "name": "callback", "parameters": [ { "description": "Whether any alarm was found to clear.", "name": "wasCleared", "type": "boolean" } ], "type": "function" } ], "type": "function" } ], "namespace": "alarms", "permissions": [ "alarms" ], "types": [ { "id": "Alarm", "properties": { "name": { "description": "Name of this alarm.", "type": "string" }, "periodInMinutes": { "description": "When present, signals that the alarm triggers periodically after so many minutes.", "optional": true, "type": "number" }, "scheduledTime": { "description": "Time when the alarm is scheduled to fire, in milliseconds past the epoch.", "type": "number" } }, "type": "object" } ] }, { "description": "Use the browser.bookmarks API to create, organize, and otherwise manipulate bookmarks. Also see $(topic:override)[Override Pages], which you can use to create a custom Bookmark Manager page.", "events": [ { "description": "Fired when a bookmark or folder is created.", "name": "onCreated", "parameters": [ { "name": "id", "type": "string" }, { "$ref": "BookmarkTreeNode", "name": "bookmark" } ], "type": "function" }, { "description": "Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.", "name": "onRemoved", "parameters": [ { "name": "id", "type": "string" }, { "name": "removeInfo", "properties": { "index": { "type": "integer" }, "node": { "$ref": "BookmarkTreeNode" }, "parentId": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a bookmark or folder changes. Note: Currently, only title and url changes trigger this.", "name": "onChanged", "parameters": [ { "name": "id", "type": "string" }, { "name": "changeInfo", "properties": { "title": { "type": "string" }, "url": { "optional": true, "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a bookmark or folder is moved to a different parent folder.", "name": "onMoved", "parameters": [ { "name": "id", "type": "string" }, { "name": "moveInfo", "properties": { "index": { "type": "integer" }, "oldIndex": { "type": "integer" }, "oldParentId": { "type": "string" }, "parentId": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when the children of a folder have changed their order due to the order being sorted in the UI. This is not called as a result of a move().", "name": "onChildrenReordered", "parameters": [ { "name": "id", "type": "string" }, { "name": "reorderInfo", "properties": { "childIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } ], "type": "function", "unsupported": true }, { "description": "Fired when a bookmark import session is begun. Expensive observers should ignore onCreated updates until onImportEnded is fired. Observers should still handle other notifications immediately.", "name": "onImportBegan", "parameters": [], "type": "function", "unsupported": true }, { "description": "Fired when a bookmark import session is ended.", "name": "onImportEnded", "parameters": [], "type": "function", "unsupported": true } ], "functions": [ { "async": "callback", "description": "Retrieves the specified BookmarkTreeNode(s).", "name": "get", "parameters": [ { "choices": [ { "type": "string" }, { "items": { "type": "string" }, "minItems": 1, "type": "array" } ], "description": "A single string-valued id, or an array of string-valued ids", "name": "idOrIdList" }, { "name": "callback", "parameters": [ { "items": { "$ref": "BookmarkTreeNode" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves the children of the specified BookmarkTreeNode id.", "name": "getChildren", "parameters": [ { "name": "id", "type": "string" }, { "name": "callback", "parameters": [ { "items": { "$ref": "BookmarkTreeNode" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves the recently added bookmarks.", "name": "getRecent", "parameters": [ { "description": "The maximum number of items to return.", "minimum": 1, "name": "numberOfItems", "type": "integer" }, { "name": "callback", "parameters": [ { "items": { "$ref": "BookmarkTreeNode" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves the entire Bookmarks hierarchy.", "name": "getTree", "parameters": [ { "name": "callback", "parameters": [ { "items": { "$ref": "BookmarkTreeNode" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves part of the Bookmarks hierarchy, starting at the specified node.", "name": "getSubTree", "parameters": [ { "description": "The ID of the root of the subtree to retrieve.", "name": "id", "type": "string" }, { "name": "callback", "parameters": [ { "items": { "$ref": "BookmarkTreeNode" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Searches for BookmarkTreeNodes matching the given query. Queries specified with an object produce BookmarkTreeNodes matching all specified properties.", "name": "search", "parameters": [ { "choices": [ { "description": "A string of words and quoted phrases that are matched against bookmark URLs and titles.", "type": "string" }, { "description": "An object specifying properties and values to match when searching. Produces bookmarks matching all properties.", "properties": { "query": { "description": "A string of words and quoted phrases that are matched against bookmark URLs and titles.", "optional": true, "type": "string" }, "title": { "description": "The title of the bookmark; matches verbatim.", "optional": true, "type": "string" }, "url": { "description": "The URL of the bookmark; matches verbatim. Note that folders have no URL.", "format": "url", "optional": true, "type": "string" } }, "type": "object" } ], "description": "Either a string of words and quoted phrases that are matched against bookmark URLs and titles, or an object. If an object, the properties query, url, and title may be specified and bookmarks matching all specified properties will be produced.", "name": "query" }, { "name": "callback", "parameters": [ { "items": { "$ref": "BookmarkTreeNode" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Creates a bookmark or folder under the specified parentId. If url is NULL or missing, it will be a folder.", "name": "create", "parameters": [ { "$ref": "CreateDetails", "name": "bookmark" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "BookmarkTreeNode", "name": "result" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Moves the specified BookmarkTreeNode to the provided location.", "name": "move", "parameters": [ { "name": "id", "type": "string" }, { "name": "destination", "properties": { "index": { "minimum": 0, "optional": true, "type": "integer" }, "parentId": { "optional": true, "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "BookmarkTreeNode", "name": "result" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified properties will be left unchanged. Note: Currently, only 'title' and 'url' are supported.", "name": "update", "parameters": [ { "name": "id", "type": "string" }, { "name": "changes", "properties": { "title": { "optional": true, "type": "string" }, "url": { "optional": true, "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "BookmarkTreeNode", "name": "result" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes a bookmark or an empty bookmark folder.", "name": "remove", "parameters": [ { "name": "id", "type": "string" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Recursively removes a bookmark folder.", "name": "removeTree", "parameters": [ { "name": "id", "type": "string" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Imports bookmarks from an html bookmark file", "name": "import", "parameters": [ { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Exports bookmarks to an html bookmark file", "name": "export", "parameters": [ { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true } ], "namespace": "bookmarks", "permissions": [ "bookmarks" ], "types": [ { "description": "Indicates the reason why this node is unmodifiable. The managed value indicates that this node was configured by the system administrator or by the custodian of a supervised user. Omitted if the node can be modified by the user and the extension (default).", "enum": [ "managed" ], "id": "BookmarkTreeNodeUnmodifiable", "type": "string" }, { "description": "Indicates the type of a BookmarkTreeNode, which can be one of bookmark, folder or separator.", "enum": [ "bookmark", "folder", "separator" ], "id": "BookmarkTreeNodeType", "type": "string" }, { "description": "A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder.", "id": "BookmarkTreeNode", "properties": { "children": { "description": "An ordered list of children of this node.", "items": { "$ref": "BookmarkTreeNode" }, "optional": true, "type": "array" }, "dateAdded": { "description": "When this node was created, in milliseconds since the epoch (new Date(dateAdded)).", "optional": true, "type": "number" }, "dateGroupModified": { "description": "When the contents of this folder last changed, in milliseconds since the epoch.", "optional": true, "type": "number" }, "id": { "description": "The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the browser is restarted.", "type": "string" }, "index": { "description": "The 0-based position of this node within its parent folder.", "optional": true, "type": "integer" }, "parentId": { "description": "The id of the parent folder. Omitted for the root node.", "optional": true, "type": "string" }, "title": { "description": "The text displayed for the node.", "type": "string" }, "type": { "$ref": "BookmarkTreeNodeType", "description": "Indicates the type of the BookmarkTreeNode, which can be one of bookmark, folder or separator.", "optional": true }, "unmodifiable": { "$ref": "BookmarkTreeNodeUnmodifiable", "description": "Indicates the reason why this node is unmodifiable. The managed value indicates that this node was configured by the system administrator or by the custodian of a supervised user. Omitted if the node can be modified by the user and the extension (default).", "optional": true }, "url": { "description": "The URL navigated to when a user clicks the bookmark. Omitted for folders.", "optional": true, "type": "string" } }, "type": "object" }, { "description": "Object passed to the create() function.", "id": "CreateDetails", "properties": { "index": { "minimum": 0, "optional": true, "type": "integer" }, "parentId": { "description": "Defaults to the Other Bookmarks folder.", "optional": true, "type": "string" }, "title": { "optional": true, "type": "string" }, "type": { "$ref": "BookmarkTreeNodeType", "description": "Indicates the type of BookmarkTreeNode to create, which can be one of bookmark, folder or separator.", "optional": true }, "url": { "optional": true, "type": "string" } }, "type": "object" } ] }, { "description": "Use browser actions to put icons in the main browser toolbar, to the right of the address bar. In addition to its icon, a browser action can also have a tooltip, a badge, and a popup.", "events": [ { "description": "Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.", "name": "onClicked", "parameters": [ { "$ref": "tabs.Tab", "name": "tab" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Sets the title of the browser action. This shows up in the tooltip.", "name": "setTitle", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.", "optional": true, "type": "integer" }, "title": { "description": "The string the browser action should display when moused over.", "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the title of the browser action.", "name": "getTitle", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the title from. If no tab is specified, the non-tab-specific title is returned.", "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "name": "result", "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets the icon for the browser action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the path or the imageData property must be specified.", "name": "setIcon", "parameters": [ { "name": "details", "properties": { "imageData": { "choices": [ { "$ref": "ImageDataType" }, { "patternProperties": { "^[1-9]\\d*$": { "$ref": "ImageDataType" } }, "type": "object" } ], "description": "Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}'", "optional": true }, "path": { "choices": [ { "type": "string" }, { "patternProperties": { "^[1-9]\\d*$": { "type": "string" } }, "type": "object" } ], "description": "Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'", "optional": true }, "tabId": { "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.", "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets the html document to be opened as a popup when the user clicks on the browser action's icon.", "name": "setPopup", "parameters": [ { "name": "details", "properties": { "popup": { "description": "The html file to show in a popup. If set to the empty string (''), no popup is shown.", "type": "string" }, "tabId": { "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the html document set as the popup for this browser action.", "name": "getPopup", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the popup from. If no tab is specified, the non-tab-specific popup is returned.", "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "name": "result", "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets the badge text for the browser action. The badge is displayed on top of the icon.", "name": "setBadgeText", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.", "optional": true, "type": "integer" }, "text": { "description": "Any number of characters can be passed, but only about four can fit in the space.", "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the badge text of the browser action. If no tab is specified, the non-tab-specific badge text is returned.", "name": "getBadgeText", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the badge text from. If no tab is specified, the non-tab-specific badge text is returned.", "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "name": "result", "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets the background color for the badge.", "name": "setBadgeBackgroundColor", "parameters": [ { "name": "details", "properties": { "color": { "choices": [ { "type": "string" }, { "$ref": "ColorArray" } ], "description": "An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is [255, 0, 0, 255]. Can also be a string with a CSS value, with opaque red being #FF0000 or #F00." }, "tabId": { "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.", "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the background color of the browser action.", "name": "getBadgeBackgroundColor", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the badge background color from. If no tab is specified, the non-tab-specific badge background color is returned.", "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "$ref": "ColorArray", "name": "result" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Enables the browser action for a tab. By default, browser actions are enabled.", "name": "enable", "parameters": [ { "description": "The id of the tab for which you want to modify the browser action.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Disables the browser action for a tab.", "name": "disable", "parameters": [ { "description": "The id of the tab for which you want to modify the browser action.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": true, "description": "Opens the extension popup window in the active window.", "name": "openPopup", "parameters": [], "requireUserInput": true, "type": "function" } ], "namespace": "browserAction", "permissions": [ "manifest:browser_action" ], "types": [ { "id": "ColorArray", "items": { "maximum": 255, "minimum": 0, "type": "integer" }, "maxItems": 4, "minItems": 4, "type": "array" }, { "additionalProperties": { "type": "any" }, "description": "Pixel data for an image. Must be an ImageData object (for example, from a canvas element).", "id": "ImageDataType", "isInstanceOf": "ImageData", "postprocess": "convertImageDataToURL", "type": "object" } ] }, { "description": "Use the browser.browserSettings API to control global settings of the browser.", "namespace": "browserSettings", "permissions": [ "browserSettings" ], "properties": { "allowPopupsForUserEvents": { "$ref": "types.Setting", "description": "Allows or disallows pop-up windows from opening in response to user events." }, "cacheEnabled": { "$ref": "types.Setting", "description": "Enables or disables the browser cache." }, "contextMenuShowEvent": { "$ref": "types.Setting", "description": "Controls after which mouse event context menus popup. This setting's value is of type ContextMenuMouseEvent, which has possible values of mouseup and mousedown." }, "homepageOverride": { "$ref": "types.Setting", "description": "Returns the value of the overridden home page. Read-only." }, "imageAnimationBehavior": { "$ref": "types.Setting", "description": "Controls the behaviour of image animation in the browser. This setting's value is of type ImageAnimationBehavior, defaulting to normal." }, "newTabPageOverride": { "$ref": "types.Setting", "description": "Returns the value of the overridden new tab page. Read-only." }, "webNotificationsDisabled": { "$ref": "types.Setting", "description": "Disables webAPI notifications." } }, "types": [ { "description": "How images should be animated in the browser.", "enum": [ "normal", "none", "once" ], "id": "ImageAnimationBehavior", "type": "string" }, { "description": "After which mouse event context menus should popup.", "enum": [ "mouseup", "mousedown" ], "id": "ContextMenuMouseEvent", "type": "string" } ] }, { "description": "Use the chrome.browsingData API to remove browsing data from a user's local profile.", "functions": [ { "async": "callback", "description": "Reports which types of data are currently selected in the 'Clear browsing data' settings UI. Note: some of the data types included in this API are not available in the settings UI, and some UI settings control more than one data type listed here.", "name": "settings", "parameters": [ { "name": "callback", "parameters": [ { "name": "result", "properties": { "dataRemovalPermitted": { "$ref": "DataTypeSet", "description": "All of the types will be present in the result, with values of true if they are permitted to be removed (e.g., by enterprise policy) and false if not." }, "dataToRemove": { "$ref": "DataTypeSet", "description": "All of the types will be present in the result, with values of true if they are both selected to be removed and permitted to be removed, otherwise false." }, "options": { "$ref": "RemovalOptions" } }, "type": "object" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears various types of browsing data stored in a user's profile.", "name": "remove", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "$ref": "DataTypeSet", "description": "The set of data types to remove.", "name": "dataToRemove" }, { "description": "Called when deletion has completed.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears websites' appcache data.", "name": "removeAppcache", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when websites' appcache data has been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Clears the browser's cache.", "name": "removeCache", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when the browser's cache has been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears the browser's cookies and server-bound certificates modified within a particular timeframe.", "name": "removeCookies", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when the browser's cookies and server-bound certificates have been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears the browser's list of downloaded files (not the downloaded files themselves).", "name": "removeDownloads", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when the browser's list of downloaded files has been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears websites' file system data.", "name": "removeFileSystems", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when websites' file systems have been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Clears the browser's stored form data (autofill).", "name": "removeFormData", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when the browser's form data has been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears the browser's history.", "name": "removeHistory", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when the browser's history has cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears websites' IndexedDB data.", "name": "removeIndexedDB", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when websites' IndexedDB data has been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Clears websites' local storage data.", "name": "removeLocalStorage", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when websites' local storage has been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears plugins' data.", "name": "removePluginData", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when plugins' data has been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears the browser's stored passwords.", "name": "removePasswords", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when the browser's passwords have been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears websites' WebSQL data.", "name": "removeWebSQL", "parameters": [ { "$ref": "RemovalOptions", "name": "options" }, { "description": "Called when websites' WebSQL databases have been cleared.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true } ], "namespace": "browsingData", "permissions": [ "browsingData" ], "types": [ { "description": "Options that determine exactly what data will be removed.", "id": "RemovalOptions", "properties": { "hostnames": { "description": "Only remove data associated with these hostnames (only applies to cookies and localStorage).", "items": { "format": "hostname", "type": "string" }, "optional": true, "type": "array" }, "originTypes": { "description": "An object whose properties specify which origin types ought to be cleared. If this object isn't specified, it defaults to clearing only \"unprotected\" origins. Please ensure that you really want to remove application data before adding 'protectedWeb' or 'extensions'.", "optional": true, "properties": { "extension": { "description": "Extensions and packaged applications a user has installed (be _really_ careful!).", "optional": true, "type": "boolean" }, "protectedWeb": { "description": "Websites that have been installed as hosted applications (be careful!).", "optional": true, "type": "boolean" }, "unprotectedWeb": { "description": "Normal websites.", "optional": true, "type": "boolean" } }, "type": "object" }, "since": { "$ref": "extensionTypes.Date", "description": "Remove data accumulated on or after this date, represented in milliseconds since the epoch (accessible via the getTime method of the JavaScript Date object). If absent, defaults to 0 (which would remove all browsing data).", "optional": true } }, "type": "object" }, { "description": "A set of data types. Missing data types are interpreted as false.", "id": "DataTypeSet", "properties": { "cache": { "description": "The browser's cache. Note: when removing data, this clears the entire cache: it is not limited to the range you specify.", "optional": true, "type": "boolean" }, "cookies": { "description": "The browser's cookies.", "optional": true, "type": "boolean" }, "downloads": { "description": "The browser's download list.", "optional": true, "type": "boolean" }, "formData": { "description": "The browser's stored form data.", "optional": true, "type": "boolean" }, "history": { "description": "The browser's history.", "optional": true, "type": "boolean" }, "indexedDB": { "description": "Websites' IndexedDB data.", "optional": true, "type": "boolean" }, "localStorage": { "description": "Websites' local storage data.", "optional": true, "type": "boolean" }, "passwords": { "description": "Stored passwords.", "optional": true, "type": "boolean" }, "pluginData": { "description": "Plugins' data.", "optional": true, "type": "boolean" }, "serverBoundCertificates": { "description": "Server-bound certificates.", "optional": true, "type": "boolean" }, "serviceWorkers": { "description": "Service Workers.", "optional": true, "type": "boolean" } }, "type": "object" } ] }, { "description": "Offers the ability to write to the clipboard. Reading is not supported because the clipboard can already be read through the standard web platform APIs.", "functions": [ { "async": true, "description": "Copy an image to the clipboard. The image is re-encoded before it is written to the clipboard. If the image is invalid, the clipboard is not modified.", "name": "setImageData", "parameters": [ { "additionalProperties": true, "description": "The image data to be copied.", "isInstanceOf": "ArrayBuffer", "name": "imageData", "type": "object" }, { "description": "The type of imageData.", "enum": [ "jpeg", "png" ], "name": "imageType", "type": "string" } ], "type": "function" } ], "namespace": "clipboard", "permissions": [ "clipboardWrite" ] }, { "description": "Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the xtension.", "events": [ { "description": "Fired when a registered command is activated using a keyboard shortcut.", "name": "onCommand", "parameters": [ { "name": "command", "type": "string" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Returns all the registered extension commands for this extension and their shortcut (if active).", "name": "getAll", "parameters": [ { "description": "Called to return the registered commands.", "name": "callback", "optional": true, "parameters": [ { "items": { "$ref": "Command" }, "name": "commands", "type": "array" } ], "type": "function" } ], "type": "function" } ], "namespace": "commands", "permissions": [ "manifest:commands" ], "types": [ { "id": "Command", "properties": { "description": { "description": "The Extension Command description", "optional": true, "type": "string" }, "name": { "description": "The name of the Extension Command", "optional": true, "type": "string" }, "shortcut": { "description": "The shortcut active for this command, or blank if not active.", "optional": true, "type": "string" } }, "type": "object" } ] }, { "description": "Use the browser.contextualIdentities API to query and modify contextual identity, also called as containers.", "events": [ { "description": "Fired when a container is updated.", "name": "onUpdated", "parameters": [ { "name": "changeInfo", "properties": { "contextualIdentity": { "$ref": "ContextualIdentity", "description": "Contextual identity that has been updated" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a new container is created.", "name": "onCreated", "parameters": [ { "name": "changeInfo", "properties": { "contextualIdentity": { "$ref": "ContextualIdentity", "description": "Contextual identity that has been created" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a container is removed.", "name": "onRemoved", "parameters": [ { "name": "changeInfo", "properties": { "contextualIdentity": { "$ref": "ContextualIdentity", "description": "Contextual identity that has been removed" } }, "type": "object" } ], "type": "function" } ], "functions": [ { "async": true, "description": "Retrieves information about a single contextual identity.", "name": "get", "parameters": [ { "description": "The ID of the contextual identity cookie store. ", "name": "cookieStoreId", "type": "string" } ], "type": "function" }, { "async": true, "description": "Retrieves all contextual identities", "name": "query", "parameters": [ { "description": "Information to filter the contextual identities being retrieved.", "name": "details", "properties": { "name": { "description": "Filters the contextual identity by name.", "optional": true, "type": "string" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Creates a contextual identity with the given data.", "name": "create", "parameters": [ { "description": "Details about the contextual identity being created.", "name": "details", "properties": { "color": { "description": "The color of the contextual identity.", "optional": false, "type": "string" }, "icon": { "description": "The icon of the contextual identity.", "optional": false, "type": "string" }, "name": { "description": "The name of the contextual identity.", "optional": false, "type": "string" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Updates a contextual identity with the given data.", "name": "update", "parameters": [ { "description": "The ID of the contextual identity cookie store. ", "name": "cookieStoreId", "type": "string" }, { "description": "Details about the contextual identity being created.", "name": "details", "properties": { "color": { "description": "The color of the contextual identity.", "optional": true, "type": "string" }, "icon": { "description": "The icon of the contextual identity.", "optional": true, "type": "string" }, "name": { "description": "The name of the contextual identity.", "optional": true, "type": "string" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Deletes a contetual identity by its cookie Store ID.", "name": "remove", "parameters": [ { "description": "The ID of the contextual identity cookie store. ", "name": "cookieStoreId", "type": "string" } ], "type": "function" } ], "namespace": "contextualIdentities", "permissions": [ "contextualIdentities" ], "types": [ { "description": "Represents information about a contextual identity.", "id": "ContextualIdentity", "properties": { "color": { "description": "The color name of the contextual identity.", "type": "string" }, "colorCode": { "description": "The color hash of the contextual identity.", "type": "string" }, "cookieStoreId": { "description": "The cookie store ID of the contextual identity.", "type": "string" }, "icon": { "description": "The icon name of the contextual identity.", "type": "string" }, "iconUrl": { "description": "The icon url of the contextual identity.", "type": "string" }, "name": { "description": "The name of the contextual identity.", "type": "string" } }, "type": "object" } ] }, { "description": "Use the browser.cookies API to query and modify cookies, and to be notified when they change.", "events": [ { "description": "Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with \"cause\" of \"overwrite\" . Afterwards, a new cookie is written with the updated values, generating a second notification with \"cause\" \"explicit\".", "name": "onChanged", "parameters": [ { "name": "changeInfo", "properties": { "cause": { "$ref": "OnChangedCause", "description": "The underlying reason behind the cookie's change." }, "cookie": { "$ref": "Cookie", "description": "Information about the cookie that was set or removed." }, "removed": { "description": "True if a cookie was removed.", "type": "boolean" } }, "type": "object" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned.", "name": "get", "parameters": [ { "description": "Details to identify the cookie being retrieved.", "name": "details", "properties": { "name": { "description": "The name of the cookie to retrieve.", "type": "string" }, "storeId": { "description": "The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store will be used.", "optional": true, "type": "string" }, "url": { "description": "The URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is simply ignored. If host permissions for this URL are not specified in the manifest file, the API call will fail.", "type": "string" } }, "type": "object" }, { "name": "callback", "parameters": [ { "$ref": "Cookie", "description": "Contains details about the cookie. This parameter is null if no such cookie was found.", "name": "cookie", "optional": true } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first.", "name": "getAll", "parameters": [ { "description": "Information to filter the cookies being retrieved.", "name": "details", "properties": { "domain": { "description": "Restricts the retrieved cookies to those whose domains match or are subdomains of this one.", "optional": true, "type": "string" }, "name": { "description": "Filters the cookies by name.", "optional": true, "type": "string" }, "path": { "description": "Restricts the retrieved cookies to those whose path exactly matches this string.", "optional": true, "type": "string" }, "secure": { "description": "Filters the cookies by their Secure property.", "optional": true, "type": "boolean" }, "session": { "description": "Filters out session vs. persistent cookies.", "optional": true, "type": "boolean" }, "storeId": { "description": "The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.", "optional": true, "type": "string" }, "url": { "description": "Restricts the retrieved cookies to those that would match the given URL.", "optional": true, "type": "string" } }, "type": "object" }, { "name": "callback", "parameters": [ { "description": "All the existing, unexpired cookies that match the given cookie info.", "items": { "$ref": "Cookie" }, "name": "cookies", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.", "name": "set", "parameters": [ { "description": "Details about the cookie being set.", "name": "details", "properties": { "domain": { "description": "The domain of the cookie. If omitted, the cookie becomes a host-only cookie.", "optional": true, "type": "string" }, "expirationDate": { "description": "The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.", "optional": true, "type": "number" }, "httpOnly": { "description": "Whether the cookie should be marked as HttpOnly. Defaults to false.", "optional": true, "type": "boolean" }, "name": { "description": "The name of the cookie. Empty by default if omitted.", "optional": true, "type": "string" }, "path": { "description": "The path of the cookie. Defaults to the path portion of the url parameter.", "optional": true, "type": "string" }, "secure": { "description": "Whether the cookie should be marked as Secure. Defaults to false.", "optional": true, "type": "boolean" }, "storeId": { "description": "The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store.", "optional": true, "type": "string" }, "url": { "description": "The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.", "type": "string" }, "value": { "description": "The value of the cookie. Empty by default if omitted.", "optional": true, "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "Cookie", "description": "Contains details about the cookie that's been set. If setting failed for any reason, this will be \"null\", and $(ref:runtime.lastError) will be set.", "name": "cookie", "optional": true } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Deletes a cookie by name.", "name": "remove", "parameters": [ { "description": "Information to identify the cookie to remove.", "name": "details", "properties": { "name": { "description": "The name of the cookie to remove.", "type": "string" }, "storeId": { "description": "The ID of the cookie store to look in for the cookie. If unspecified, the cookie is looked for by default in the current execution context's cookie store.", "optional": true, "type": "string" }, "url": { "description": "The URL associated with the cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.", "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "description": "Contains details about the cookie that's been removed. If removal failed for any reason, this will be \"null\", and $(ref:runtime.lastError) will be set.", "name": "details", "optional": true, "properties": { "name": { "description": "The name of the cookie that's been removed.", "type": "string" }, "storeId": { "description": "The ID of the cookie store from which the cookie was removed.", "type": "string" }, "url": { "description": "The URL associated with the cookie that's been removed.", "type": "string" } }, "type": "object" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Lists all existing cookie stores.", "name": "getAllCookieStores", "parameters": [ { "name": "callback", "parameters": [ { "description": "All the existing cookie stores.", "items": { "$ref": "CookieStore" }, "name": "cookieStores", "type": "array" } ], "type": "function" } ], "type": "function" } ], "namespace": "cookies", "permissions": [ "cookies" ], "types": [ { "description": "Represents information about an HTTP cookie.", "id": "Cookie", "properties": { "domain": { "description": "The domain of the cookie (e.g. \"www.google.com\", \"example.com\").", "type": "string" }, "expirationDate": { "description": "The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.", "optional": true, "type": "number" }, "hostOnly": { "description": "True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie).", "type": "boolean" }, "httpOnly": { "description": "True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts).", "type": "boolean" }, "name": { "description": "The name of the cookie.", "type": "string" }, "path": { "description": "The path of the cookie.", "type": "string" }, "secure": { "description": "True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).", "type": "boolean" }, "session": { "description": "True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.", "type": "boolean" }, "storeId": { "description": "The ID of the cookie store containing this cookie, as provided in getAllCookieStores().", "type": "string" }, "value": { "description": "The value of the cookie.", "type": "string" } }, "type": "object" }, { "description": "Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.", "id": "CookieStore", "properties": { "id": { "description": "The unique identifier for the cookie store.", "type": "string" }, "incognito": { "description": "Indicates if this is an incognito cookie store", "type": "boolean" }, "tabIds": { "description": "Identifiers of all the browser tabs that share this cookie store.", "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, { "description": "The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to $(ref:cookies.remove), \"cause\" will be \"explicit\". If a cookie was automatically removed due to expiry, \"cause\" will be \"expired\". If a cookie was removed due to being overwritten with an already-expired expiration date, \"cause\" will be set to \"expired_overwrite\". If a cookie was automatically removed due to garbage collection, \"cause\" will be \"evicted\". If a cookie was automatically removed due to a \"set\" call that overwrote it, \"cause\" will be \"overwrite\". Plan your response accordingly.", "enum": [ "evicted", "expired", "explicit", "expired_overwrite", "overwrite" ], "id": "OnChangedCause", "type": "string" } ] }, { "allowedContexts": [ "devtools", "devtools_only" ], "defaultContexts": [ "devtools", "devtools_only" ], "namespace": "devtools", "permissions": [ "devtools" ] }, { "allowedContexts": [ "devtools", "devtools_only" ], "defaultContexts": [ "devtools", "devtools_only" ], "description": "Use the chrome.devtools.inspectedWindow API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page.", "events": [ { "description": "Fired when a new resource is added to the inspected page.", "name": "onResourceAdded", "parameters": [ { "$ref": "Resource", "name": "resource" } ], "type": "function", "unsupported": true }, { "description": "Fired when a new revision of the resource is committed (e.g. user saves an edited version of the resource in the Developer Tools).", "name": "onResourceContentCommitted", "parameters": [ { "$ref": "Resource", "name": "resource" }, { "description": "New content of the resource.", "name": "content", "type": "string" } ], "type": "function", "unsupported": true } ], "functions": [ { "async": "callback", "description": "Evaluates a JavaScript expression in the context of the main frame of the inspected page. The expression must evaluate to a JSON-compliant object, otherwise an exception is thrown. The eval function can report either a DevTools-side error or a JavaScript exception that occurs during evaluation. In either case, the result parameter of the callback is undefined. In the case of a DevTools-side error, the isException parameter is non-null and has isError set to true and code set to an error code. In the case of a JavaScript error, isException is set to true and value is set to the string value of thrown object.", "name": "eval", "parameters": [ { "description": "An expression to evaluate.", "name": "expression", "type": "string" }, { "description": "The options parameter can contain one or more options.", "name": "options", "optional": true, "properties": { "contextSecurityOrigin": { "description": "Evaluate the expression in the context of a content script of an extension that matches the specified origin. If given, contextSecurityOrigin overrides the 'true' setting on userContentScriptContext.", "optional": true, "type": "string", "unsupported": true }, "frameURL": { "description": "If specified, the expression is evaluated on the iframe whose URL matches the one specified. By default, the expression is evaluated in the top frame of the inspected page.", "optional": true, "type": "string", "unsupported": true }, "useContentScriptContext": { "description": "Evaluate the expression in the context of the content script of the calling extension, provided that the content script is already injected into the inspected page. If not, the expression is not evaluated and the callback is invoked with the exception parameter set to an object that has the isError field set to true and the code field set to E_NOTFOUND.", "optional": true, "type": "boolean", "unsupported": true } }, "type": "object" }, { "description": "A function called when evaluation completes.", "name": "callback", "optional": true, "parameters": [ { "description": "The result of evaluation.", "name": "result", "type": "any" }, { "description": "An object providing details if an exception occurred while evaluating the expression.", "name": "exceptionInfo", "optional": true, "properties": { "code": { "description": "Set if the error occurred on the DevTools side before the expression is evaluated.", "type": "string" }, "description": { "description": "Set if the error occurred on the DevTools side before the expression is evaluated.", "type": "string" }, "details": { "description": "Set if the error occurred on the DevTools side before the expression is evaluated, contains the array of the values that may be substituted into the description string to provide more information about the cause of the error.", "items": { "type": "any" }, "type": "array" }, "isError": { "description": "Set if the error occurred on the DevTools side before the expression is evaluated.", "type": "boolean" }, "isException": { "description": "Set if the evaluated code produces an unhandled exception.", "type": "boolean" }, "value": { "description": "Set if the evaluated code produces an unhandled exception.", "type": "string" } }, "type": "object" } ], "type": "function" } ], "type": "function" }, { "description": "Reloads the inspected page.", "name": "reload", "parameters": [ { "name": "reloadOptions", "optional": true, "properties": { "ignoreCache": { "description": "When true, the loader will bypass the cache for all inspected page resources loaded before the load event is fired. The effect is similar to pressing Ctrl+Shift+R in the inspected window or within the Developer Tools window.", "optional": true, "type": "boolean" }, "injectedScript": { "description": "If specified, the script will be injected into every frame of the inspected page immediately upon load, before any of the frame's scripts. The script will not be injected after subsequent reloads—for example, if the user presses Ctrl+R.", "optional": true, "type": "string" }, "preprocessorScript": { "deprecated": "Please avoid using this parameter, it will be removed soon.", "description": "If specified, this script evaluates into a function that accepts three string arguments: the source to preprocess, the URL of the source, and a function name if the source is an DOM event handler. The preprocessorerScript function should return a string to be compiled by Chrome in place of the input source. In the case that the source is a DOM event handler, the returned source must compile to a single JS function.", "optional": true, "type": "string", "unsupported": true }, "userAgent": { "description": "If specified, the string will override the value of the User-Agent HTTP header that's sent while loading the resources of the inspected page. The string will also override the value of the navigator.userAgent property that's returned to any scripts that are running within the inspected page.", "optional": true, "type": "string" } }, "type": "object" } ], "type": "function" }, { "async": "callback", "description": "Retrieves the list of resources from the inspected page.", "name": "getResources", "parameters": [ { "description": "A function that receives the list of resources when the request completes.", "name": "callback", "parameters": [ { "description": "The resources within the page.", "items": { "$ref": "Resource" }, "name": "resources", "type": "array" } ], "type": "function" } ], "type": "function", "unsupported": true } ], "namespace": "devtools.inspectedWindow", "nocompile": true, "properties": { "tabId": { "description": "The ID of the tab being inspected. This ID may be used with chrome.tabs.* API.", "type": "integer" } }, "types": [ { "description": "A resource within the inspected page, such as a document, a script, or an image.", "functions": [ { "async": "callback", "description": "Gets the content of the resource.", "name": "getContent", "parameters": [ { "description": "A function that receives resource content when the request completes.", "name": "callback", "parameters": [ { "description": "Content of the resource (potentially encoded).", "name": "content", "type": "string" }, { "description": "Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported.", "name": "encoding", "type": "string" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Sets the content of the resource.", "name": "setContent", "parameters": [ { "description": "New content of the resource. Only resources with the text type are currently supported.", "name": "content", "type": "string" }, { "description": "True if the user has finished editing the resource, and the new content of the resource should be persisted; false if this is a minor change sent in progress of the user editing the resource.", "name": "commit", "type": "boolean" }, { "description": "A function called upon request completion.", "name": "callback", "optional": true, "parameters": [ { "additionalProperties": { "type": "any" }, "description": "Set to undefined if the resource content was set successfully; describes error otherwise.", "name": "error", "optional": true, "type": "object" } ], "type": "function" } ], "type": "function", "unsupported": true } ], "id": "Resource", "properties": { "url": { "description": "The URL of the resource.", "type": "string" } }, "type": "object" } ] }, { "allowedContexts": [ "devtools", "devtools_only" ], "defaultContexts": [ "devtools", "devtools_only" ], "description": "Use the chrome.devtools.network API to retrieve the information about network requests displayed by the Developer Tools in the Network panel.", "events": [ { "description": "Fired when a network request is finished and all request data are available.", "name": "onRequestFinished", "parameters": [ { "$ref": "Request", "description": "Description of a network request in the form of a HAR entry. See HAR specification for details.", "name": "request" } ], "type": "function", "unsupported": true }, { "description": "Fired when the inspected window navigates to a new page.", "name": "onNavigated", "parameters": [ { "description": "URL of the new page.", "name": "url", "type": "string" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Returns HAR log that contains all known network requests.", "name": "getHAR", "parameters": [ { "description": "A function that receives the HAR log when the request completes.", "name": "callback", "parameters": [ { "additionalProperties": { "type": "any" }, "description": "A HAR log. See HAR specification for details.", "name": "harLog", "type": "object" } ], "type": "function" } ], "type": "function", "unsupported": true } ], "namespace": "devtools.network", "types": [ { "description": "Represents a network request for a document resource (script, image and so on). See HAR Specification for reference.", "functions": [ { "async": "callback", "description": "Returns content of the response body.", "name": "getContent", "parameters": [ { "description": "A function that receives the response body when the request completes.", "name": "callback", "parameters": [ { "description": "Content of the response body (potentially encoded).", "name": "content", "type": "string" }, { "description": "Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported.", "name": "encoding", "type": "string" } ], "type": "function" } ], "type": "function" } ], "id": "Request", "type": "object" } ] }, { "allowedContexts": [ "devtools", "devtools_only" ], "defaultContexts": [ "devtools", "devtools_only" ], "description": "Use the chrome.devtools.panels API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars.", "events": [ { "description": "Fired when the devtools theme changes.", "name": "onThemeChanged", "parameters": [ { "description": "The name of the current devtools theme.", "name": "themeName", "type": "string" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Creates an extension panel.", "name": "create", "parameters": [ { "description": "Title that is displayed next to the extension icon in the Developer Tools toolbar.", "name": "title", "type": "string" }, { "choices": [ { "enum": [ "" ], "type": "string" }, { "$ref": "manifest.ExtensionURL" } ], "description": "Path of the panel's icon relative to the extension directory, or an empty string to use the default extension icon as the panel icon.", "name": "iconPath" }, { "$ref": "manifest.ExtensionURL", "description": "Path of the panel's HTML page relative to the extension directory.", "name": "pagePath" }, { "description": "A function that is called when the panel is created.", "name": "callback", "optional": true, "parameters": [ { "$ref": "ExtensionPanel", "description": "An ExtensionPanel object representing the created panel.", "name": "panel" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Specifies the function to be called when the user clicks a resource link in the Developer Tools window. To unset the handler, either call the method with no parameters or pass null as the parameter.", "name": "setOpenResourceHandler", "parameters": [ { "description": "A function that is called when the user clicks on a valid resource link in Developer Tools window. Note that if the user clicks an invalid URL or an XHR, this function is not called.", "name": "callback", "optional": true, "parameters": [ { "$ref": "devtools.inspectedWindow.Resource", "description": "A $(ref:devtools.inspectedWindow.Resource) object for the resource that was clicked.", "name": "resource" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Requests DevTools to open a URL in a Developer Tools panel.", "name": "openResource", "parameters": [ { "description": "The URL of the resource to open.", "name": "url", "type": "string" }, { "description": "Specifies the line number to scroll to when the resource is loaded.", "name": "lineNumber", "type": "integer" }, { "description": "A function that is called when the resource has been successfully loaded.", "name": "callback", "optional": true, "type": "function" } ], "type": "function", "unsupported": true } ], "namespace": "devtools.panels", "nocompile": true, "properties": { "elements": { "$ref": "ElementsPanel", "description": "Elements panel." }, "sources": { "$ref": "SourcesPanel", "description": "Sources panel." }, "themeName": { "description": "The name of the current devtools theme.", "type": "string" } }, "types": [ { "description": "Represents the Elements panel.", "events": [ { "description": "Fired when an object is selected in the panel.", "name": "onSelectionChanged", "type": "function" } ], "functions": [ { "async": "callback", "description": "Creates a pane within panel's sidebar.", "name": "createSidebarPane", "parameters": [ { "description": "Text that is displayed in sidebar caption.", "name": "title", "type": "string" }, { "description": "A callback invoked when the sidebar is created.", "name": "callback", "optional": true, "parameters": [ { "$ref": "ExtensionSidebarPane", "description": "An ExtensionSidebarPane object for created sidebar pane.", "name": "result" } ], "type": "function" } ], "type": "function" } ], "id": "ElementsPanel", "type": "object" }, { "description": "Represents the Sources panel.", "events": [ { "description": "Fired when an object is selected in the panel.", "name": "onSelectionChanged", "unsupported": true } ], "functions": [ { "description": "Creates a pane within panel's sidebar.", "name": "createSidebarPane", "parameters": [ { "description": "Text that is displayed in sidebar caption.", "name": "title", "type": "string" }, { "description": "A callback invoked when the sidebar is created.", "name": "callback", "optional": true, "parameters": [ { "$ref": "ExtensionSidebarPane", "description": "An ExtensionSidebarPane object for created sidebar pane.", "name": "result" } ], "type": "function" } ], "type": "function", "unsupported": true } ], "id": "SourcesPanel", "type": "object" }, { "description": "Represents a panel created by extension.", "events": [ { "description": "Fired upon a search action (start of a new search, search result navigation, or search being canceled).", "name": "onSearch", "parameters": [ { "description": "Type of search action being performed.", "name": "action", "type": "string" }, { "description": "Query string (only for 'performSearch').", "name": "queryString", "optional": true, "type": "string" } ], "unsupported": true }, { "description": "Fired when the user switches to the panel.", "name": "onShown", "parameters": [ { "additionalProperties": { "type": "any" }, "description": "The JavaScript window object of panel's page.", "isInstanceOf": "global", "name": "window", "type": "object" } ], "type": "function" }, { "description": "Fired when the user switches away from the panel.", "name": "onHidden", "type": "function" } ], "functions": [ { "description": "Appends a button to the status bar of the panel.", "name": "createStatusBarButton", "parameters": [ { "description": "Path to the icon of the button. The file should contain a 64x24-pixel image composed of two 32x24 icons. The left icon is used when the button is inactive; the right icon is displayed when the button is pressed.", "name": "iconPath", "type": "string" }, { "description": "Text shown as a tooltip when user hovers the mouse over the button.", "name": "tooltipText", "type": "string" }, { "description": "Whether the button is disabled.", "name": "disabled", "type": "boolean" } ], "returns": { "$ref": "Button" }, "type": "function", "unsupported": true } ], "id": "ExtensionPanel", "type": "object" }, { "description": "A sidebar created by the extension.", "events": [ { "description": "Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.", "name": "onShown", "parameters": [ { "additionalProperties": { "type": "any" }, "description": "The JavaScript window object of the sidebar page, if one was set with the setPage() method.", "isInstanceOf": "global", "name": "window", "type": "object" } ], "type": "function" }, { "description": "Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar pane.", "name": "onHidden", "type": "function" } ], "functions": [ { "description": "Sets the height of the sidebar.", "name": "setHeight", "parameters": [ { "description": "A CSS-like size specification, such as '100px' or '12ex'.", "name": "height", "type": "string" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.", "name": "setExpression", "parameters": [ { "description": "An expression to be evaluated in context of the inspected page. JavaScript objects and DOM nodes are displayed in an expandable tree similar to the console/watch.", "name": "expression", "type": "string" }, { "description": "An optional title for the root of the expression tree.", "name": "rootTitle", "optional": true, "type": "string" }, { "description": "A callback invoked after the sidebar pane is updated with the expression evaluation results.", "name": "callback", "optional": true, "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets a JSON-compliant object to be displayed in the sidebar pane.", "name": "setObject", "parameters": [ { "description": "An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client).", "name": "jsonObject", "type": "string" }, { "description": "An optional title for the root of the expression tree.", "name": "rootTitle", "optional": true, "type": "string" }, { "description": "A callback invoked after the sidebar is updated with the object.", "name": "callback", "optional": true, "type": "function" } ], "type": "function" }, { "description": "Sets an HTML page to be displayed in the sidebar pane.", "name": "setPage", "parameters": [ { "description": "Relative path of an extension page to display within the sidebar.", "name": "path", "type": "string" } ], "type": "function", "unsupported": true } ], "id": "ExtensionSidebarPane", "type": "object" }, { "description": "A button created by the extension.", "events": [ { "description": "Fired when the button is clicked.", "name": "onClicked", "type": "function", "unsupported": true } ], "functions": [ { "description": "Updates the attributes of the button. If some of the arguments are omitted or null, the corresponding attributes are not updated.", "name": "update", "parameters": [ { "description": "Path to the new icon of the button.", "name": "iconPath", "optional": true, "type": "string" }, { "description": "Text shown as a tooltip when user hovers the mouse over the button.", "name": "tooltipText", "optional": true, "type": "string" }, { "description": "Whether the button is disabled.", "name": "disabled", "optional": true, "type": "boolean" } ], "type": "function", "unsupported": true } ], "id": "Button", "type": "object" } ] }, { "events": [ { "description": "This event fires with the DownloadItem object when a download begins.", "name": "onCreated", "parameters": [ { "$ref": "DownloadItem", "name": "downloadItem" } ], "type": "function" }, { "description": "Fires with the downloadId when a download is erased from history.", "name": "onErased", "parameters": [ { "description": "The id of the DownloadItem that was erased.", "name": "downloadId", "type": "integer" } ], "type": "function" }, { "description": "When any of a DownloadItem's properties except bytesReceived changes, this event fires with the downloadId and an object containing the properties that changed.", "name": "onChanged", "parameters": [ { "name": "downloadDelta", "properties": { "canResume": { "$ref": "BooleanDelta", "optional": true }, "danger": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's danger.", "optional": true }, "endTime": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's endTime.", "optional": true }, "error": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's error.", "optional": true }, "exists": { "$ref": "BooleanDelta", "optional": true }, "fileSize": { "$ref": "DoubleDelta", "description": "Describes a change in a DownloadItem's fileSize.", "optional": true }, "filename": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's filename.", "optional": true }, "id": { "description": "The id of the DownloadItem that changed.", "type": "integer" }, "mime": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's mime.", "optional": true }, "paused": { "$ref": "BooleanDelta", "description": "Describes a change in a DownloadItem's paused.", "optional": true }, "startTime": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's startTime.", "optional": true }, "state": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's state.", "optional": true }, "totalBytes": { "$ref": "DoubleDelta", "description": "Describes a change in a DownloadItem's totalBytes.", "optional": true }, "url": { "$ref": "StringDelta", "description": "Describes a change in a DownloadItem's url.", "optional": true } }, "type": "object" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Download a URL. If the URL uses the HTTP[S] protocol, then the request will include all cookies currently set for its hostname. If both filename and saveAs are specified, then the Save As dialog will be displayed, pre-populated with the specified filename. If the download started successfully, callback will be called with the new DownloadItem's downloadId. If there was an error starting the download, then callback will be called with downloadId=undefined and chrome.extension.lastError will contain a descriptive string. The error strings are not guaranteed to remain backwards compatible between releases. You must not parse it.", "name": "download", "parameters": [ { "description": "What to download and how.", "name": "options", "properties": { "body": { "description": "Post body.", "optional": true, "type": "string" }, "conflictAction": { "$ref": "FilenameConflictAction", "optional": true }, "filename": { "description": "A file path relative to the Downloads directory to contain the downloaded file.", "optional": true, "type": "string" }, "headers": { "description": "Extra HTTP headers to send with the request if the URL uses the HTTP[s] protocol. Each header is represented as a dictionary containing the keys name and either value or binaryValue, restricted to those allowed by XMLHttpRequest.", "items": { "properties": { "name": { "description": "Name of the HTTP header.", "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "type": "object" }, "optional": true, "type": "array" }, "incognito": { "default": false, "description": "Whether to associate the download with a private browsing session.", "optional": true, "type": "boolean" }, "method": { "description": "The HTTP method to use if the URL uses the HTTP[S] protocol.", "enum": [ "GET", "POST" ], "optional": true, "type": "string" }, "saveAs": { "description": "Use a file-chooser to allow the user to select a filename. If the option is not specified, the file chooser will be shown only if the Firefox \"Always ask you where to save files\" option is enabled (i.e. the pref browser.download.useDownloadDir is set to false).", "optional": true, "type": "boolean" }, "url": { "description": "The URL to download.", "format": "url", "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "name": "downloadId", "type": "integer" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Find DownloadItems. Set query to the empty object to get all DownloadItems. To get a specific DownloadItem, set only the id field.", "name": "search", "parameters": [ { "$ref": "DownloadQuery", "name": "query" }, { "name": "callback", "parameters": [ { "items": { "$ref": "DownloadItem" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Pause the download. If the request was successful the download is in a paused state. Otherwise chrome.extension.lastError contains an error message. The request will fail if the download is not active.", "name": "pause", "parameters": [ { "description": "The id of the download to pause.", "name": "downloadId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Resume a paused download. If the request was successful the download is in progress and unpaused. Otherwise chrome.extension.lastError contains an error message. The request will fail if the download is not active.", "name": "resume", "parameters": [ { "description": "The id of the download to resume.", "name": "downloadId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Cancel a download. When callback is run, the download is cancelled, completed, interrupted or doesn't exist anymore.", "name": "cancel", "parameters": [ { "description": "The id of the download to cancel.", "name": "downloadId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieve an icon for the specified download. For new downloads, file icons are available after the onCreated event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit depending on the platform. The icon that is returned will therefore depend on a number of factors including state of the download, platform, registered file types and visual theme. If a file icon cannot be determined, chrome.extension.lastError will contain an error message.", "name": "getFileIcon", "parameters": [ { "description": "The identifier for the download.", "name": "downloadId", "type": "integer" }, { "name": "options", "optional": true, "properties": { "size": { "description": "The size of the icon. The returned icon will be square with dimensions size * size pixels. The default size for the icon is 32x32 pixels.", "maximum": 127, "minimum": 1, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "name": "iconURL", "optional": true, "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Open the downloaded file.", "name": "open", "parameters": [ { "name": "downloadId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "permissions": [ "downloads.open" ], "requireUserInput": true, "type": "function" }, { "async": "callback", "description": "Show the downloaded file in its folder in a file manager.", "name": "show", "parameters": [ { "name": "downloadId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [ { "name": "success", "type": "boolean" } ], "type": "function" } ], "type": "function" }, { "name": "showDefaultFolder", "parameters": [], "type": "function" }, { "async": "callback", "description": "Erase matching DownloadItems from history", "name": "erase", "parameters": [ { "$ref": "DownloadQuery", "name": "query" }, { "name": "callback", "optional": true, "parameters": [ { "items": { "type": "integer" }, "name": "erasedIds", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "name": "removeFile", "parameters": [ { "name": "downloadId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "description": "Prompt the user to either accept or cancel a dangerous download. acceptDanger() does not automatically accept dangerous downloads.", "name": "acceptDanger", "parameters": [ { "name": "downloadId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true }, { "description": "Initiate dragging the file to another application.", "name": "drag", "parameters": [ { "name": "downloadId", "type": "integer" } ], "type": "function", "unsupported": true }, { "name": "setShelfEnabled", "parameters": [ { "name": "enabled", "type": "boolean" } ], "type": "function", "unsupported": true } ], "namespace": "downloads", "permissions": [ "downloads" ], "types": [ { "enum": [ "uniquify", "overwrite", "prompt" ], "id": "FilenameConflictAction", "type": "string" }, { "enum": [ "FILE_FAILED", "FILE_ACCESS_DENIED", "FILE_NO_SPACE", "FILE_NAME_TOO_LONG", "FILE_TOO_LARGE", "FILE_VIRUS_INFECTED", "FILE_TRANSIENT_ERROR", "FILE_BLOCKED", "FILE_SECURITY_CHECK_FAILED", "FILE_TOO_SHORT", "NETWORK_FAILED", "NETWORK_TIMEOUT", "NETWORK_DISCONNECTED", "NETWORK_SERVER_DOWN", "NETWORK_INVALID_REQUEST", "SERVER_FAILED", "SERVER_NO_RANGE", "SERVER_BAD_CONTENT", "SERVER_UNAUTHORIZED", "SERVER_CERT_PROBLEM", "SERVER_FORBIDDEN", "USER_CANCELED", "USER_SHUTDOWN", "CRASH" ], "id": "InterruptReason", "type": "string" }, { "description": "
file
The download's filename is suspicious.
url
The download's URL is known to be malicious.
content
The downloaded file is known to be malicious.
uncommon
The download's URL is not commonly downloaded and could be dangerous.
safe
The download presents no known danger to the user's computer.
These string constants will never change, however the set of DangerTypes may change.", "enum": [ "file", "url", "content", "uncommon", "host", "unwanted", "safe", "accepted" ], "id": "DangerType", "type": "string" }, { "description": "
in_progress
The download is currently receiving data from the server.
interrupted
An error broke the connection with the file host.
complete
The download completed successfully.
These string constants will never change, however the set of States may change.", "enum": [ "in_progress", "interrupted", "complete" ], "id": "State", "type": "string" }, { "id": "DownloadItem", "properties": { "byExtensionId": { "optional": true, "type": "string" }, "byExtensionName": { "optional": true, "type": "string" }, "bytesReceived": { "description": "Number of bytes received so far from the host, without considering file compression.", "type": "number" }, "canResume": { "type": "boolean" }, "danger": { "$ref": "DangerType", "description": "Indication of whether this download is thought to be safe or known to be suspicious." }, "endTime": { "description": "Number of milliseconds between the unix epoch and when this download ended.", "optional": true, "type": "string" }, "error": { "$ref": "InterruptReason", "description": "Number indicating why a download was interrupted.", "optional": true }, "estimatedEndTime": { "optional": true, "type": "string" }, "exists": { "type": "boolean" }, "fileSize": { "description": "Number of bytes in the whole file post-decompression, or -1 if unknown.", "type": "number" }, "filename": { "description": "Absolute local path.", "type": "string" }, "id": { "description": "An identifier that is persistent across browser sessions.", "type": "integer" }, "incognito": { "description": "False if this download is recorded in the history, true if it is not recorded.", "type": "boolean" }, "mime": { "description": "The file's MIME type.", "type": "string" }, "paused": { "description": "True if the download has stopped reading data from the host, but kept the connection open.", "type": "boolean" }, "referrer": { "optional": true, "type": "string" }, "startTime": { "description": "Number of milliseconds between the unix epoch and when this download began.", "type": "string" }, "state": { "$ref": "State", "description": "Indicates whether the download is progressing, interrupted, or complete." }, "totalBytes": { "description": "Number of bytes in the whole file, without considering file compression, or -1 if unknown.", "type": "number" }, "url": { "description": "Absolute URL.", "type": "string" } }, "type": "object" }, { "id": "StringDelta", "properties": { "current": { "optional": true, "type": "string" }, "previous": { "optional": true, "type": "string" } }, "type": "object" }, { "id": "DoubleDelta", "properties": { "current": { "optional": true, "type": "number" }, "previous": { "optional": true, "type": "number" } }, "type": "object" }, { "id": "BooleanDelta", "properties": { "current": { "optional": true, "type": "boolean" }, "previous": { "optional": true, "type": "boolean" } }, "type": "object" }, { "choices": [ { "pattern": "^[1-9]\\d*$", "type": "string" }, { "$ref": "extensionTypes.Date" } ], "description": "A time specified as a Date object, a number or string representing milliseconds since the epoch, or an ISO 8601 string", "id": "DownloadTime" }, { "description": "Parameters that combine to specify a predicate that can be used to select a set of downloads. Used for example in search() and erase()", "id": "DownloadQuery", "properties": { "bytesReceived": { "description": "Number of bytes received so far from the host, without considering file compression.", "optional": true, "type": "number" }, "danger": { "$ref": "DangerType", "description": "Indication of whether this download is thought to be safe or known to be suspicious.", "optional": true }, "endTime": { "optional": true, "type": "string" }, "endedAfter": { "$ref": "DownloadTime", "description": "Limits results to downloads that ended after the given ms since the epoch.", "optional": true }, "endedBefore": { "$ref": "DownloadTime", "description": "Limits results to downloads that ended before the given ms since the epoch.", "optional": true }, "error": { "$ref": "InterruptReason", "description": "Why a download was interrupted.", "optional": true }, "exists": { "optional": true, "type": "boolean" }, "fileSize": { "description": "Number of bytes in the whole file post-decompression, or -1 if unknown.", "optional": true, "type": "number" }, "filename": { "description": "Absolute local path.", "optional": true, "type": "string" }, "filenameRegex": { "description": "Limits results to DownloadItems whose filename matches the given regular expression.", "optional": true, "type": "string" }, "id": { "optional": true, "type": "integer" }, "limit": { "description": "Setting this integer limits the number of results. Otherwise, all matching DownloadItems will be returned.", "optional": true, "type": "integer" }, "mime": { "description": "The file's MIME type.", "optional": true, "type": "string" }, "orderBy": { "description": "Setting elements of this array to DownloadItem properties in order to sort the search results. For example, setting orderBy='startTime' sorts the DownloadItems by their start time in ascending order. To specify descending order, prefix orderBy with a hyphen: '-startTime'.", "items": { "type": "string" }, "optional": true, "type": "array" }, "paused": { "description": "True if the download has stopped reading data from the host, but kept the connection open.", "optional": true, "type": "boolean" }, "query": { "description": "This array of search terms limits results to DownloadItems whose filename or url contain all of the search terms that do not begin with a dash '-' and none of the search terms that do begin with a dash.", "items": { "type": "string" }, "optional": true, "type": "array" }, "startTime": { "optional": true, "type": "string" }, "startedAfter": { "$ref": "DownloadTime", "description": "Limits results to downloads that started after the given ms since the epoch.", "optional": true }, "startedBefore": { "$ref": "DownloadTime", "description": "Limits results to downloads that started before the given ms since the epoch.", "optional": true }, "state": { "$ref": "State", "description": "Indicates whether the download is progressing, interrupted, or complete.", "optional": true }, "totalBytes": { "description": "Number of bytes in the whole file, without considering file compression, or -1 if unknown.", "optional": true, "type": "number" }, "totalBytesGreater": { "description": "Limits results to downloads whose totalBytes is greater than the given integer.", "optional": true, "type": "number" }, "totalBytesLess": { "description": "Limits results to downloads whose totalBytes is less than the given integer.", "optional": true, "type": "number" }, "url": { "description": "Absolute URL.", "optional": true, "type": "string" }, "urlRegex": { "description": "Limits results to DownloadItems whose url matches the given regular expression.", "optional": true, "type": "string" } }, "type": "object" } ] }, { "description": "The chrome.events namespace contains common types used by APIs dispatching events to notify you when something interesting happens.", "namespace": "events", "types": [ { "description": "Description of a declarative rule for handling events.", "id": "Rule", "properties": { "actions": { "description": "List of actions that are triggered if one of the condtions is fulfilled.", "items": { "type": "any" }, "type": "array" }, "conditions": { "description": "List of conditions that can trigger the actions.", "items": { "type": "any" }, "type": "array" }, "id": { "description": "Optional identifier that allows referencing this rule.", "optional": true, "type": "string" }, "priority": { "description": "Optional priority of this rule. Defaults to 100.", "optional": true, "type": "integer" }, "tags": { "description": "Tags can be used to annotate rules and perform operations on sets of rules.", "items": { "type": "string" }, "optional": true, "type": "array" } }, "type": "object" }, { "description": "An object which allows the addition and removal of listeners for a Chrome event.", "functions": [ { "description": "Registers an event listener callback to an event.", "name": "addListener", "parameters": [ { "description": "Called when an event occurs. The parameters of this function depend on the type of event.", "name": "callback", "type": "function" } ], "type": "function" }, { "description": "Deregisters an event listener callback from an event.", "name": "removeListener", "parameters": [ { "description": "Listener that shall be unregistered.", "name": "callback", "type": "function" } ], "type": "function" }, { "name": "hasListener", "parameters": [ { "description": "Listener whose registration status shall be tested.", "name": "callback", "type": "function" } ], "returns": { "description": "True if callback is registered to the event.", "type": "boolean" }, "type": "function" }, { "name": "hasListeners", "parameters": [], "returns": { "description": "True if any event listeners are registered to the event.", "type": "boolean" }, "type": "function" }, { "description": "Registers rules to handle events.", "name": "addRules", "parameters": [ { "description": "Name of the event this function affects.", "name": "eventName", "type": "string" }, { "description": "If provided, this is an integer that uniquely identfies the associated with this function call.", "name": "webViewInstanceId", "type": "integer" }, { "description": "Rules to be registered. These do not replace previously registered rules.", "items": { "$ref": "Rule" }, "name": "rules", "type": "array" }, { "description": "Called with registered rules.", "name": "callback", "optional": true, "parameters": [ { "description": "Rules that were registered, the optional parameters are filled with values.", "items": { "$ref": "Rule" }, "name": "rules", "type": "array" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "description": "Returns currently registered rules.", "name": "getRules", "parameters": [ { "description": "Name of the event this function affects.", "name": "eventName", "type": "string" }, { "description": "If provided, this is an integer that uniquely identfies the associated with this function call.", "name": "webViewInstanceId", "type": "integer" }, { "description": "If an array is passed, only rules with identifiers contained in this array are returned.", "items": { "type": "string" }, "name": "ruleIdentifiers", "optional": true, "type": "array" }, { "description": "Called with registered rules.", "name": "callback", "parameters": [ { "description": "Rules that were registered, the optional parameters are filled with values.", "items": { "$ref": "Rule" }, "name": "rules", "type": "array" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "description": "Unregisters currently registered rules.", "name": "removeRules", "parameters": [ { "description": "Name of the event this function affects.", "name": "eventName", "type": "string" }, { "description": "If provided, this is an integer that uniquely identfies the associated with this function call.", "name": "webViewInstanceId", "type": "integer" }, { "description": "If an array is passed, only rules with identifiers contained in this array are unregistered.", "items": { "type": "string" }, "name": "ruleIdentifiers", "optional": true, "type": "array" }, { "description": "Called when rules were unregistered.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function", "unsupported": true } ], "id": "Event", "type": "object" }, { "description": "Filters URLs for various criteria. See event filtering. All criteria are case sensitive.", "id": "UrlFilter", "properties": { "hostContains": { "description": "Matches if the host name of the URL contains a specified string. To test whether a host name component has a prefix 'foo', use hostContains: '.foo'. This matches 'www.foobar.com' and 'foo.com', because an implicit dot is added at the beginning of the host name. Similarly, hostContains can be used to match against component suffix ('foo.') and to exactly match against components ('.foo.'). Suffix- and exact-matching for the last components need to be done separately using hostSuffix, because no implicit dot is added at the end of the host name.", "optional": true, "type": "string" }, "hostEquals": { "description": "Matches if the host name of the URL is equal to a specified string.", "optional": true, "type": "string" }, "hostPrefix": { "description": "Matches if the host name of the URL starts with a specified string.", "optional": true, "type": "string" }, "hostSuffix": { "description": "Matches if the host name of the URL ends with a specified string.", "optional": true, "type": "string" }, "originAndPathMatches": { "description": "Matches if the URL without query segment and fragment identifier matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number. The regular expressions use the RE2 syntax.", "optional": true, "type": "string" }, "pathContains": { "description": "Matches if the path segment of the URL contains a specified string.", "optional": true, "type": "string" }, "pathEquals": { "description": "Matches if the path segment of the URL is equal to a specified string.", "optional": true, "type": "string" }, "pathPrefix": { "description": "Matches if the path segment of the URL starts with a specified string.", "optional": true, "type": "string" }, "pathSuffix": { "description": "Matches if the path segment of the URL ends with a specified string.", "optional": true, "type": "string" }, "ports": { "description": "Matches if the port of the URL is contained in any of the specified port lists. For example [80, 443, [1000, 1200]] matches all requests on port 80, 443 and in the range 1000-1200.", "items": { "choices": [ { "description": "A specific port.", "type": "integer" }, { "description": "A pair of integers identiying the start and end (both inclusive) of a port range.", "items": { "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" } ] }, "optional": true, "type": "array" }, "queryContains": { "description": "Matches if the query segment of the URL contains a specified string.", "optional": true, "type": "string" }, "queryEquals": { "description": "Matches if the query segment of the URL is equal to a specified string.", "optional": true, "type": "string" }, "queryPrefix": { "description": "Matches if the query segment of the URL starts with a specified string.", "optional": true, "type": "string" }, "querySuffix": { "description": "Matches if the query segment of the URL ends with a specified string.", "optional": true, "type": "string" }, "schemes": { "description": "Matches if the scheme of the URL is equal to any of the schemes specified in the array.", "items": { "type": "string" }, "optional": true, "type": "array" }, "urlContains": { "description": "Matches if the URL (without fragment identifier) contains a specified string. Port numbers are stripped from the URL if they match the default port number.", "optional": true, "type": "string" }, "urlEquals": { "description": "Matches if the URL (without fragment identifier) is equal to a specified string. Port numbers are stripped from the URL if they match the default port number.", "optional": true, "type": "string" }, "urlMatches": { "description": "Matches if the URL (without fragment identifier) matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number. The regular expressions use the RE2 syntax.", "optional": true, "type": "string" }, "urlPrefix": { "description": "Matches if the URL (without fragment identifier) starts with a specified string. Port numbers are stripped from the URL if they match the default port number.", "optional": true, "type": "string" }, "urlSuffix": { "description": "Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if they match the default port number.", "optional": true, "type": "string" } }, "type": "object" } ] }, { "allowedContexts": [ "content", "devtools" ], "description": "The browser.extension API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in $(topic:messaging)[Message Passing].", "events": [ { "deprecated": "Please use $(ref:runtime.onMessage).", "description": "Fired when a request is sent from either an extension process or a content script.", "name": "onRequest", "parameters": [ { "description": "The request sent by the calling script.", "name": "request", "optional": true, "type": "any" }, { "$ref": "runtime.MessageSender", "name": "sender" }, { "description": "Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response. If you have more than one onRequest listener in the same document, then only one may send a response.", "name": "sendResponse", "type": "function" } ], "type": "function", "unsupported": true }, { "deprecated": "Please use $(ref:runtime.onMessageExternal).", "description": "Fired when a request is sent from another extension.", "name": "onRequestExternal", "parameters": [ { "description": "The request sent by the calling script.", "name": "request", "optional": true, "type": "any" }, { "$ref": "runtime.MessageSender", "name": "sender" }, { "description": "Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response.", "name": "sendResponse", "type": "function" } ], "type": "function", "unsupported": true } ], "functions": [ { "allowedContexts": [ "content", "devtools" ], "description": "Converts a relative path within an extension install directory to a fully-qualified URL.", "name": "getURL", "parameters": [ { "description": "A path to a resource within an extension expressed relative to its install directory.", "name": "path", "type": "string" } ], "returns": { "description": "The fully-qualified URL to the resource.", "type": "string" }, "type": "function" }, { "description": "Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.", "name": "getViews", "parameters": [ { "name": "fetchProperties", "optional": true, "properties": { "tabId": { "description": "Find a view according to a tab id. If this field is omitted, returns all views.", "optional": true, "type": "integer" }, "type": { "$ref": "ViewType", "description": "The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'popup', 'sidebar'.", "optional": true }, "windowId": { "description": "The window to restrict the search to. If omitted, returns all views.", "optional": true, "type": "integer" } }, "type": "object" } ], "returns": { "description": "Array of global objects", "items": { "additionalProperties": { "type": "any" }, "isInstanceOf": "Window", "type": "object" }, "type": "array" }, "type": "function" }, { "description": "Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.", "name": "getBackgroundPage", "parameters": [], "returns": { "additionalProperties": { "type": "any" }, "isInstanceOf": "Window", "optional": true, "type": "object" }, "type": "function" }, { "async": "callback", "description": "Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.", "name": "isAllowedIncognitoAccess", "parameters": [ { "name": "callback", "parameters": [ { "description": "True if the extension has access to Incognito mode, false otherwise.", "name": "isAllowedAccess", "type": "boolean" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.", "name": "isAllowedFileSchemeAccess", "parameters": [ { "name": "callback", "parameters": [ { "description": "True if the extension can access the 'file://' scheme, false otherwise.", "name": "isAllowedAccess", "type": "boolean" } ], "type": "function" } ], "type": "function" }, { "description": "Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the browser vendor's store.", "name": "setUpdateUrlData", "parameters": [ { "maxLength": 1024, "name": "data", "type": "string" } ], "type": "function", "unsupported": true } ], "namespace": "extension", "properties": { "inIncognitoContext": { "allowedContexts": [ "content", "devtools" ], "description": "True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior.", "optional": true, "type": "boolean" }, "lastError": { "additionalProperties": { "type": "any" }, "allowedContexts": [ "content", "devtools" ], "description": "Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be undefined.", "optional": true, "properties": { "message": { "description": "Description of the error that has taken place.", "type": "string" } }, "type": "object" } }, "types": [ { "description": "The type of extension view.", "enum": [ "tab", "popup", "sidebar" ], "id": "ViewType", "type": "string" } ] }, { "description": "The browser.extensionTypes API contains type declarations for WebExtensions.", "namespace": "extensionTypes", "types": [ { "description": "The format of an image.", "enum": [ "jpeg", "png" ], "id": "ImageFormat", "type": "string" }, { "description": "Details about the format and quality of an image.", "id": "ImageDetails", "properties": { "format": { "$ref": "ImageFormat", "description": "The format of the resulting image. Default is \"jpeg\".", "optional": true }, "quality": { "description": "When format is \"jpeg\", controls the quality of the resulting image. This value is ignored for PNG images. As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store it will decrease.", "maximum": 100, "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" }, { "description": "The soonest that the JavaScript or CSS will be injected into the tab.", "enum": [ "document_start", "document_end", "document_idle" ], "id": "RunAt", "type": "string" }, { "description": "The origin of the CSS to inject, this affects the cascading order (priority) of the stylesheet.", "enum": [ "user", "author" ], "id": "CSSOrigin", "type": "string" }, { "description": "Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.", "id": "InjectDetails", "properties": { "allFrames": { "description": "If allFrames is true, implies that the JavaScript or CSS should be injected into all frames of current page. By default, it's false and is only injected into the top frame.", "optional": true, "type": "boolean" }, "code": { "description": "JavaScript or CSS code to inject.

Warning:
Be careful using the code parameter. Incorrect use of it may open your extension to cross site scripting attacks.", "optional": true, "type": "string" }, "cssOrigin": { "$ref": "CSSOrigin", "description": "The css origin of the stylesheet to inject. Defaults to \"author\".", "optional": true }, "file": { "description": "JavaScript or CSS file to inject.", "optional": true, "type": "string" }, "frameId": { "description": "The ID of the frame to inject the script into. This may not be used in combination with allFrames.", "minimum": 0, "optional": true, "type": "integer" }, "matchAboutBlank": { "description": "If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is false.", "optional": true, "type": "boolean" }, "runAt": { "$ref": "RunAt", "default": "document_idle", "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\".", "optional": true } }, "type": "object" }, { "choices": [ { "format": "date", "type": "string" }, { "minimum": 0, "type": "integer" }, { "additionalProperties": { "type": "any" }, "isInstanceOf": "Date", "type": "object" } ], "id": "Date" } ] }, { "description": "Use the browser.find API to interact with the browser's Find interface.", "functions": [ { "async": true, "description": "Search for text in document and store found ranges in array, in document order.", "name": "find", "parameters": [ { "description": "The string to search for.", "name": "queryphrase", "type": "string" }, { "description": "Search parameters.", "name": "params", "optional": true, "properties": { "caseSensitive": { "description": "Find only ranges with case sensitive match.", "optional": true, "type": "boolean" }, "entireWord": { "description": "Find only ranges that match entire word.", "optional": true, "type": "boolean" }, "includeRangeData": { "description": "Return range data which provides range data in a serializable form.", "optional": true, "type": "boolean" }, "includeRectData": { "description": "Return rectangle data which describes visual position of search results.", "optional": true, "type": "boolean" }, "tabId": { "description": "Tab to query. Defaults to the active tab.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Highlight a range", "name": "highlightResults", "parameters": [ { "description": "highlightResults parameters", "name": "params", "optional": true, "properties": { "noScroll": { "description": "Don't scroll to highlighted item.", "optional": true, "type": "boolean" }, "rangeIndex": { "description": "Found range to be highlighted. Default highlights all ranges.", "minimum": 0, "optional": true, "type": "integer" }, "tabId": { "description": "Tab to highlight. Defaults to the active tab.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Remove all highlighting from previous searches.", "name": "removeHighlighting", "parameters": [ { "description": "Tab to highlight. Defaults to the active tab.", "name": "tabId", "optional": true, "type": "integer" } ], "type": "function" } ], "namespace": "find", "permissions": [ "find" ] }, { "description": "Exposes the browser's profiler.", "events": [ { "description": "Fires when the profiler starts/stops running.", "name": "onRunning", "parameters": [ { "description": "Whether the profiler is running or not. Pausing the profiler will not affect this value.", "name": "isRunning", "type": "boolean" } ], "type": "function" } ], "functions": [ { "async": true, "description": "Starts the profiler with the specified settings.", "name": "start", "parameters": [ { "name": "settings", "properties": { "bufferSize": { "description": "The size in bytes of the buffer used to store profiling data. A larger value allows capturing a profile that covers a greater amount of time.", "minimum": 0, "type": "integer" }, "features": { "description": "A list of active features for the profiler.", "items": { "$ref": "ProfilerFeature" }, "type": "array" }, "interval": { "description": "Interval in milliseconds between samples of profiling data. A smaller value will increase the detail of the profiles captured.", "type": "number" }, "threads": { "description": "A list of thread names for which to capture profiles.", "items": { "type": "string" }, "optional": true, "type": "array" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Stops the profiler and discards any captured profile data.", "name": "stop", "parameters": [], "type": "function" }, { "async": true, "description": "Pauses the profiler, keeping any profile data that is already written.", "name": "pause", "parameters": [], "type": "function" }, { "async": true, "description": "Resumes the profiler with the settings that were initially used to start it.", "name": "resume", "parameters": [], "type": "function" }, { "async": true, "description": "Gathers the profile data from the current profiling session.", "name": "getProfile", "parameters": [], "type": "function" }, { "async": true, "description": "Gathers the profile data from the current profiling session. The returned promise resolves to an array buffer that contains a JSON string.", "name": "getProfileAsArrayBuffer", "parameters": [], "type": "function" }, { "async": true, "description": "Gets the debug symbols for a particular library.", "name": "getSymbols", "parameters": [ { "description": "The name of the library's debug file. For example, 'xul.pdb", "name": "debugName", "type": "string" }, { "description": "The Breakpad ID of the library", "name": "breakpadId", "type": "string" } ], "type": "function" } ], "namespace": "geckoProfiler", "permissions": [ "geckoProfiler" ], "types": [ { "enum": [ "java", "js", "leaf", "mainthreadio", "memory", "privacy", "restyle", "stackwalk", "tasktracer", "threads" ], "id": "ProfilerFeature", "type": "string" } ] }, { "description": "Use the browser.history API to interact with the browser's record of visited pages. You can add, remove, and query for URLs in the browser's history. To override the history page with your own version, see $(topic:override)[Override Pages].", "events": [ { "description": "Fired when a URL is visited, providing the HistoryItem data for that URL. This event fires before the page has loaded.", "name": "onVisited", "parameters": [ { "$ref": "HistoryItem", "name": "result" } ], "type": "function" }, { "description": "Fired when one or more URLs are removed from the history service. When all visits have been removed the URL is purged from history.", "name": "onVisitRemoved", "parameters": [ { "name": "removed", "properties": { "allHistory": { "description": "True if all history was removed. If true, then urls will be empty.", "type": "boolean" }, "urls": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when the title of a URL is changed in the browser history.", "name": "onTitleChanged", "parameters": [ { "name": "changed", "properties": { "title": { "description": "The new title for the URL.", "type": "string" }, "url": { "description": "The URL for which the title has changed", "type": "string" } }, "type": "object" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Searches the history for the last visit time of each page matching the query.", "name": "search", "parameters": [ { "name": "query", "properties": { "endTime": { "$ref": "extensionTypes.Date", "description": "Limit results to those visited before this date.", "optional": true }, "maxResults": { "description": "The maximum number of results to retrieve. Defaults to 100.", "minimum": 1, "optional": true, "type": "integer" }, "startTime": { "$ref": "extensionTypes.Date", "description": "Limit results to those visited after this date. If not specified, this defaults to 24 hours in the past.", "optional": true }, "text": { "description": "A free-text query to the history service. Leave empty to retrieve all pages.", "type": "string" } }, "type": "object" }, { "name": "callback", "parameters": [ { "items": { "$ref": "HistoryItem" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves information about visits to a URL.", "name": "getVisits", "parameters": [ { "name": "details", "properties": { "url": { "description": "The URL for which to retrieve visit information. It must be in the format as returned from a call to history.search.", "type": "string" } }, "type": "object" }, { "name": "callback", "parameters": [ { "items": { "$ref": "VisitItem" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Adds a URL to the history with a default visitTime of the current time and a default $(topic:transition-types)[transition type] of \"link\".", "name": "addUrl", "parameters": [ { "name": "details", "properties": { "title": { "description": "The title of the page.", "optional": true, "type": "string" }, "transition": { "$ref": "TransitionType", "description": "The $(topic:transition-types)[transition type] for this visit from its referrer.", "optional": true }, "url": { "description": "The URL to add. Must be a valid URL that can be added to history.", "type": "string" }, "visitTime": { "$ref": "extensionTypes.Date", "description": "The date when this visit occurred.", "optional": true } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes all occurrences of the given URL from the history.", "name": "deleteUrl", "parameters": [ { "name": "details", "properties": { "url": { "description": "The URL to remove.", "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes all items within the specified date range from the history. Pages will not be removed from the history unless all visits fall within the range.", "name": "deleteRange", "parameters": [ { "name": "range", "properties": { "endTime": { "$ref": "extensionTypes.Date", "description": "Items added to history before this date." }, "startTime": { "$ref": "extensionTypes.Date", "description": "Items added to history after this date." } }, "type": "object" }, { "name": "callback", "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Deletes all items from the history.", "name": "deleteAll", "parameters": [ { "name": "callback", "parameters": [], "type": "function" } ], "type": "function" } ], "namespace": "history", "permissions": [ "history" ], "types": [ { "description": "The $(topic:transition-types)[transition type] for this visit from its referrer.", "enum": [ "link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "auto_toplevel", "form_submit", "reload", "keyword", "keyword_generated" ], "id": "TransitionType", "type": "string" }, { "description": "An object encapsulating one result of a history query.", "id": "HistoryItem", "properties": { "id": { "description": "The unique identifier for the item.", "type": "string" }, "lastVisitTime": { "description": "When this page was last loaded, represented in milliseconds since the epoch.", "optional": true, "type": "number" }, "title": { "description": "The title of the page when it was last loaded.", "optional": true, "type": "string" }, "typedCount": { "description": "The number of times the user has navigated to this page by typing in the address.", "optional": true, "type": "integer" }, "url": { "description": "The URL navigated to by a user.", "optional": true, "type": "string" }, "visitCount": { "description": "The number of times the user has navigated to this page.", "optional": true, "type": "integer" } }, "type": "object" }, { "description": "An object encapsulating one visit to a URL.", "id": "VisitItem", "properties": { "id": { "description": "The unique identifier for the item.", "type": "string" }, "referringVisitId": { "description": "The visit ID of the referrer.", "type": "string" }, "transition": { "$ref": "TransitionType", "description": "The $(topic:transition-types)[transition type] for this visit from its referrer." }, "visitId": { "description": "The unique identifier for this visit.", "type": "string" }, "visitTime": { "description": "When this visit occurred, represented in milliseconds since the epoch.", "optional": true, "type": "number" } }, "type": "object" } ] }, { "allowedContexts": [ "content", "devtools" ], "defaultContexts": [ "content", "devtools" ], "description": "Use the browser.i18n infrastructure to implement internationalization across your whole app or extension.", "events": [], "functions": [ { "async": "callback", "description": "Gets the accept-languages of the browser. This is different from the locale used by the browser; to get the locale, use $(ref:i18n.getUILanguage).", "name": "getAcceptLanguages", "parameters": [ { "name": "callback", "parameters": [ { "description": "Array of LanguageCode", "items": { "$ref": "LanguageCode" }, "name": "languages", "type": "array" } ], "type": "function" } ], "type": "function" }, { "description": "Gets the localized string for the specified message. If the message is missing, this method returns an empty string (''). If the format of the getMessage() call is wrong — for example, messageName is not a string or the substitutions array has more than 9 elements — this method returns undefined.", "name": "getMessage", "parameters": [ { "description": "The name of the message, as specified in the $(topic:i18n-messages)[messages.json] file.", "name": "messageName", "type": "string" }, { "description": "Substitution strings, if the message requires any.", "name": "substitutions", "optional": true, "type": "any" } ], "returns": { "description": "Message localized for current locale.", "type": "string" }, "type": "function" }, { "description": "Gets the browser UI language of the browser. This is different from $(ref:i18n.getAcceptLanguages) which returns the preferred user languages.", "name": "getUILanguage", "parameters": [], "returns": { "description": "The browser UI language code such as en-US or fr-FR.", "type": "string" }, "type": "function" }, { "async": "callback", "description": "Detects the language of the provided text using CLD.", "name": "detectLanguage", "parameters": [ { "description": "User input string to be translated.", "name": "text", "type": "string" }, { "name": "callback", "parameters": [ { "description": "LanguageDetectionResult object that holds detected langugae reliability and array of DetectedLanguage", "name": "result", "properties": { "isReliable": { "description": "CLD detected language reliability", "type": "boolean" }, "languages": { "description": "array of detectedLanguage", "items": { "description": "DetectedLanguage object that holds detected ISO language code and its percentage in the input string", "properties": { "language": { "$ref": "LanguageCode" }, "percentage": { "description": "The percentage of the detected language", "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" } ], "type": "function" } ], "type": "function" } ], "namespace": "i18n", "types": [ { "description": "An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. For an unknown language, und will be returned, which means that [percentage] of the text is unknown to CLD", "id": "LanguageCode", "type": "string" } ] }, { "description": "Use the chrome.identity API to get OAuth2 access tokens. ", "events": [ { "description": "Fired when signin state changes for an account on the user's profile.", "name": "onSignInChanged", "parameters": [ { "$ref": "AccountInfo", "name": "account" }, { "name": "signedIn", "type": "boolean" } ], "type": "function", "unsupported": true } ], "functions": [ { "async": "callback", "description": "Retrieves a list of AccountInfo objects describing the accounts present on the profile.", "name": "getAccounts", "parameters": [ { "name": "callback", "parameters": [ { "items": { "$ref": "AccountInfo" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Gets an OAuth2 access token using the client ID and scopes specified in the oauth2 section of manifest.json.", "name": "getAuthToken", "parameters": [ { "name": "details", "optional": true, "properties": { "account": { "$ref": "AccountInfo", "optional": true }, "interactive": { "optional": true, "type": "boolean" }, "scopes": { "items": { "type": "string" }, "optional": true, "type": "array" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "items": { "$ref": "AccountInfo" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Retrieves email address and obfuscated gaia id of the user signed into a profile.", "name": "getProfileUserInfo", "parameters": [ { "name": "callback", "parameters": [ { "name": "userinfo", "properties": { "email": { "type": "string" }, "id": { "type": "string" } }, "type": "object" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Removes an OAuth2 access token from the Identity API's token cache.", "name": "removeCachedAuthToken", "parameters": [ { "name": "details", "properties": { "token": { "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "name": "userinfo", "properties": { "email": { "type": "string" }, "id": { "type": "string" } }, "type": "object" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Starts an auth flow at the specified URL.", "name": "launchWebAuthFlow", "parameters": [ { "name": "details", "properties": { "interactive": { "optional": true, "type": "boolean" }, "url": { "$ref": "manifest.HttpURL" } }, "type": "object" }, { "name": "callback", "parameters": [ { "name": " responseUrl", "optional": true, "type": "string" } ], "type": "function" } ], "type": "function" }, { "description": "Generates a redirect URL to be used in |launchWebAuthFlow|.", "name": "getRedirectURL", "parameters": [ { "default": "", "description": "The path appended to the end of the generated URL. ", "name": "path", "optional": true, "type": "string" } ], "returns": { "type": "string" }, "type": "function" } ], "namespace": "identity", "permissions": [ "identity" ], "types": [ { "description": "An object encapsulating an OAuth account id.", "id": "AccountInfo", "properties": { "id": { "description": "A unique identifier for the account. This ID will not change for the lifetime of the account. ", "type": "string" } }, "type": "object" } ] }, { "description": "Use the browser.idle API to detect when the machine's idle state changes.", "events": [ { "description": "Fired when the system changes to an active or idle state. The event fires with \"idle\" if the the user has not generated any input for a specified number of seconds, and \"active\" when the user generates input on an idle system.", "name": "onStateChanged", "parameters": [ { "$ref": "IdleState", "name": "newState" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Returns \"idle\" if the user has not generated any input for a specified number of seconds, or \"active\" otherwise.", "name": "queryState", "parameters": [ { "description": "The system is considered idle if detectionIntervalInSeconds seconds have elapsed since the last user input detected.", "minimum": 15, "name": "detectionIntervalInSeconds", "type": "integer" }, { "name": "callback", "parameters": [ { "$ref": "IdleState", "name": "newState" } ], "type": "function" } ], "type": "function" }, { "description": "Sets the interval, in seconds, used to determine when the system is in an idle state for onStateChanged events. The default interval is 60 seconds.", "name": "setDetectionInterval", "parameters": [ { "description": "Threshold, in seconds, used to determine when the system is in an idle state.", "minimum": 15, "name": "intervalInSeconds", "type": "integer" } ], "type": "function" } ], "namespace": "idle", "permissions": [ "idle" ], "types": [ { "enum": [ "active", "idle" ], "id": "IdleState", "type": "string" } ] }, { "description": "The browser.management API provides ways to manage the list of extensions that are installed and running.", "events": [ { "description": "Fired when an addon has been disabled.", "name": "onDisabled", "parameters": [ { "$ref": "ExtensionInfo", "name": "info" } ], "permissions": [ "management" ], "type": "function" }, { "description": "Fired when an addon has been enabled.", "name": "onEnabled", "parameters": [ { "$ref": "ExtensionInfo", "name": "info" } ], "permissions": [ "management" ], "type": "function" }, { "description": "Fired when an addon has been installed.", "name": "onInstalled", "parameters": [ { "$ref": "ExtensionInfo", "name": "info" } ], "permissions": [ "management" ], "type": "function" }, { "description": "Fired when an addon has been uninstalled.", "name": "onUninstalled", "parameters": [ { "$ref": "ExtensionInfo", "name": "info" } ], "permissions": [ "management" ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Returns a list of information about installed extensions.", "name": "getAll", "parameters": [ { "name": "callback", "optional": true, "parameters": [ { "items": { "$ref": "ExtensionInfo" }, "name": "result", "type": "array" } ], "type": "function" } ], "permissions": [ "management" ], "type": "function" }, { "async": "callback", "description": "Returns information about the installed extension that has the given ID.", "name": "get", "parameters": [ { "$ref": "manifest.ExtensionID", "description": "The ID from an item of $(ref:management.ExtensionInfo).", "name": "id" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "ExtensionInfo", "name": "result" } ], "type": "function" } ], "permissions": [ "management" ], "type": "function" }, { "async": "callback", "description": "Returns information about the calling extension. Note: This function can be used without requesting the 'management' permission in the manifest.", "name": "getSelf", "parameters": [ { "name": "callback", "optional": true, "parameters": [ { "$ref": "ExtensionInfo", "name": "result" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Uninstalls the calling extension. Note: This function can be used without requesting the 'management' permission in the manifest.", "name": "uninstallSelf", "parameters": [ { "name": "options", "optional": true, "properties": { "dialogMessage": { "description": "The message to display to a user when being asked to confirm removal of the extension.", "optional": true, "type": "string" }, "showConfirmDialog": { "description": "Whether or not a confirm-uninstall dialog should prompt the user. Defaults to false.", "optional": true, "type": "boolean" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Enables or disables the given add-on.", "name": "setEnabled", "parameters": [ { "description": "ID of the add-on to enable/disable.", "name": "id", "type": "string" }, { "description": "Whether to enable or disable the add-on.", "name": "enabled", "type": "boolean" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "permissions": [ "management" ], "type": "function" } ], "namespace": "management", "types": [ { "description": "Information about an icon belonging to an extension.", "id": "IconInfo", "properties": { "size": { "description": "A number representing the width and height of the icon. Likely values include (but are not limited to) 128, 48, 24, and 16.", "type": "integer" }, "url": { "description": "The URL for this icon image. To display a grayscale version of the icon (to indicate that an extension is disabled, for example), append ?grayscale=true to the URL.", "type": "string" } }, "type": "object" }, { "description": "A reason the item is disabled.", "enum": [ "unknown", "permissions_increase" ], "id": "ExtensionDisabledReason", "type": "string" }, { "description": "The type of this extension. Will always be 'extension'.", "enum": [ "extension", "theme" ], "id": "ExtensionType", "type": "string" }, { "description": "How the extension was installed. One of
development: The extension was loaded unpacked in developer mode,
normal: The extension was installed normally via an .xpi file,
sideload: The extension was installed by other software on the machine,
other: The extension was installed by other means.", "enum": [ "development", "normal", "sideload", "other" ], "id": "ExtensionInstallType", "type": "string" }, { "description": "Information about an installed extension.", "id": "ExtensionInfo", "properties": { "description": { "description": "The description of this extension.", "type": "string" }, "disabledReason": { "$ref": "ExtensionDisabledReason", "description": "A reason the item is disabled.", "optional": true }, "enabled": { "description": "Whether it is currently enabled or disabled.", "type": "boolean" }, "homepageUrl": { "description": "The URL of the homepage of this extension.", "optional": true, "type": "string" }, "hostPermissions": { "description": "Returns a list of host based permissions.", "items": { "type": "string" }, "optional": true, "type": "array" }, "icons": { "description": "A list of icon information. Note that this just reflects what was declared in the manifest, and the actual image at that url may be larger or smaller than what was declared, so you might consider using explicit width and height attributes on img tags referencing these images. See the manifest documentation on icons for more details.", "items": { "$ref": "IconInfo" }, "optional": true, "type": "array" }, "id": { "description": "The extension's unique identifier.", "type": "string" }, "installType": { "$ref": "ExtensionInstallType", "description": "How the extension was installed." }, "mayDisable": { "description": "Whether this extension can be disabled or uninstalled by the user.", "type": "boolean" }, "name": { "description": "The name of this extension.", "type": "string" }, "optionsUrl": { "description": "The url for the item's options page, if it has one.", "type": "string" }, "permissions": { "description": "Returns a list of API based permissions.", "items": { "type": "string" }, "optional": true, "type": "array" }, "shortName": { "description": "A short version of the name of this extension.", "optional": true, "type": "string" }, "type": { "$ref": "ExtensionType", "description": "The type of this extension. Will always return 'extension'." }, "updateUrl": { "description": "The update URL of this extension.", "optional": true, "type": "string" }, "version": { "description": "The version of this extension.", "type": "string" }, "versionName": { "description": "The version name of this extension if the manifest specified one.", "optional": true, "type": "string" } }, "type": "object" } ] }, { "namespace": "manifest", "permissions": [], "types": [ { "additionalProperties": { "$ref": "UnrecognizedProperty" }, "description": "Represents a WebExtension manifest.json file", "id": "WebExtensionManifest", "properties": { "applications": { "optional": true, "properties": { "gecko": { "$ref": "FirefoxSpecificProperties", "optional": true } }, "type": "object" }, "author": { "onError": "warn", "optional": true, "preprocess": "localize", "type": "string" }, "background": { "choices": [ { "additionalProperties": { "$ref": "UnrecognizedProperty" }, "properties": { "page": { "$ref": "ExtensionURL" }, "persistent": { "$ref": "PersistentBackgroundProperty", "optional": true } }, "type": "object" }, { "additionalProperties": { "$ref": "UnrecognizedProperty" }, "properties": { "persistent": { "$ref": "PersistentBackgroundProperty", "optional": true }, "scripts": { "items": { "$ref": "ExtensionURL" }, "type": "array" } }, "type": "object" } ], "optional": true }, "browser_specific_settings": { "optional": true, "properties": { "gecko": { "$ref": "FirefoxSpecificProperties", "optional": true } }, "type": "object" }, "content_scripts": { "items": { "$ref": "ContentScript" }, "optional": true, "type": "array" }, "content_security_policy": { "format": "contentSecurityPolicy", "onError": "warn", "optional": true, "type": "string" }, "description": { "optional": true, "preprocess": "localize", "type": "string" }, "developer": { "optional": true, "properties": { "name": { "optional": true, "preprocess": "localize", "type": "string" }, "url": { "optional": true, "preprocess": "localize", "type": "string" } }, "type": "object" }, "homepage_url": { "format": "url", "optional": true, "preprocess": "localize", "type": "string" }, "icons": { "optional": true, "patternProperties": { "^[1-9]\\d*$": { "type": "string" } }, "type": "object" }, "incognito": { "enum": [ "spanning" ], "onError": "warn", "optional": true, "type": "string" }, "manifest_version": { "maximum": 2, "minimum": 2, "type": "integer" }, "minimum_chrome_version": { "optional": true, "type": "string" }, "minimum_opera_version": { "optional": true, "type": "string" }, "name": { "optional": false, "preprocess": "localize", "type": "string" }, "optional_permissions": { "default": [], "items": { "$ref": "OptionalPermissionOrOrigin", "onError": "warn" }, "optional": true, "type": "array" }, "options_ui": { "additionalProperties": { "deprecated": "An unexpected property was found in the WebExtension manifest", "type": "any" }, "optional": true, "properties": { "browser_style": { "optional": true, "type": "boolean" }, "chrome_style": { "optional": true, "type": "boolean" }, "open_in_tab": { "optional": true, "type": "boolean" }, "page": { "$ref": "ExtensionURL" } }, "type": "object" }, "permissions": { "default": [], "items": { "$ref": "PermissionOrOrigin", "onError": "warn" }, "optional": true, "type": "array" }, "short_name": { "optional": true, "preprocess": "localize", "type": "string" }, "version": { "optional": false, "type": "string" }, "web_accessible_resources": { "items": { "type": "string" }, "optional": true, "type": "array" } }, "type": "object" }, { "description": "Represents a WebExtension language pack manifest.json file", "id": "WebExtensionLangpackManifest", "properties": { "applications": { "optional": true, "properties": { "gecko": { "$ref": "FirefoxSpecificProperties", "optional": true } }, "type": "object" }, "author": { "onError": "warn", "optional": true, "preprocess": "localize", "type": "string" }, "browser_specific_settings": { "optional": true, "properties": { "gecko": { "$ref": "FirefoxSpecificProperties", "optional": true } }, "type": "object" }, "description": { "optional": true, "preprocess": "localize", "type": "string" }, "homepage_url": { "format": "url", "optional": true, "preprocess": "localize", "type": "string" }, "langpack_id": { "pattern": "^[a-zA-Z][a-zA-Z-]+$", "type": "string" }, "languages": { "patternProperties": { "^[a-z]{2}[a-zA-Z-]*$": { "properties": { "chrome_resources": { "patternProperties": { "^[a-zA-Z-.]+$": { "choices": [ { "$ref": "ExtensionURL" }, { "patternProperties": { "^[a-z]+$": { "$ref": "ExtensionURL" } }, "type": "object" } ] } }, "type": "object" }, "version": { "type": "string" } }, "type": "object" } }, "type": "object" }, "manifest_version": { "maximum": 2, "minimum": 2, "type": "integer" }, "name": { "optional": false, "preprocess": "localize", "type": "string" }, "short_name": { "optional": true, "preprocess": "localize", "type": "string" }, "sources": { "optional": true, "patternProperties": { "^[a-z]+$": { "properties": { "base_path": { "$ref": "ExtensionURL" }, "paths": { "items": { "format": "strictRelativeUrl", "type": "string" }, "optional": true, "type": "array" } }, "type": "object" } }, "type": "object" }, "version": { "optional": false, "type": "string" } }, "type": "object" }, { "additionalProperties": { "$ref": "UnrecognizedProperty" }, "id": "ThemeIcons", "properties": { "dark": { "$ref": "ExtensionURL", "description": "The dark icon to use for light themes" }, "light": { "$ref": "ExtensionURL", "description": "A light icon to use for dark themes" }, "size": { "description": "The size of the icons", "type": "integer" } }, "type": "object" }, { "choices": [ { "enum": [ "clipboardRead", "clipboardWrite", "geolocation", "idle", "notifications" ], "type": "string" } ], "id": "OptionalPermission" }, { "choices": [ { "$ref": "OptionalPermission" }, { "$ref": "MatchPattern" } ], "id": "OptionalPermissionOrOrigin" }, { "choices": [ { "$ref": "OptionalPermission" }, { "enum": [ "alarms", "mozillaAddons", "storage", "unlimitedStorage" ], "type": "string" } ], "id": "Permission" }, { "choices": [ { "$ref": "Permission" }, { "$ref": "MatchPattern" } ], "id": "PermissionOrOrigin" }, { "format": "url", "id": "HttpURL", "pattern": "^https?://.*$", "type": "string" }, { "format": "strictRelativeUrl", "id": "ExtensionURL", "type": "string" }, { "format": "imageDataOrStrictRelativeUrl", "id": "ImageDataOrExtensionURL", "type": "string" }, { "choices": [ { "pattern": "(?i)^\\{[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\}$", "type": "string" }, { "pattern": "(?i)^[a-z0-9-._]*@[a-z0-9-._]+$", "type": "string" } ], "id": "ExtensionID" }, { "id": "FirefoxSpecificProperties", "properties": { "id": { "$ref": "ExtensionID", "optional": true }, "strict_max_version": { "optional": true, "type": "string" }, "strict_min_version": { "optional": true, "type": "string" }, "update_url": { "format": "url", "optional": true, "type": "string" } }, "type": "object" }, { "choices": [ { "enum": [ "" ], "type": "string" }, { "pattern": "^(https?|wss?|file|ftp|\\*)://(\\*|\\*\\.[^*/]+|[^*/]+)/.*$", "type": "string" }, { "pattern": "^file:///.*$", "type": "string" } ], "id": "MatchPattern" }, { "choices": [ { "enum": [ "" ], "type": "string" }, { "pattern": "^(https?|wss?|file|ftp|moz-extension|\\*)://(\\*|\\*\\.[^*/]+|[^*/]+)/.*$", "type": "string" }, { "pattern": "^file:///.*$", "type": "string" } ], "description": "Same as MatchPattern above, but includes moz-extension protocol", "id": "MatchPatternInternal" }, { "additionalProperties": { "$ref": "UnrecognizedProperty" }, "description": "Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time. Based on InjectDetails, but using underscore rather than camel case naming conventions.", "id": "ContentScript", "properties": { "all_frames": { "description": "If allFrames is true, implies that the JavaScript or CSS should be injected into all frames of current page. By default, it's false and is only injected into the top frame.", "optional": true, "type": "boolean" }, "css": { "description": "The list of CSS files to inject", "items": { "$ref": "ExtensionURL" }, "optional": true, "type": "array" }, "exclude_globs": { "items": { "type": "string" }, "optional": true, "type": "array" }, "exclude_matches": { "items": { "$ref": "MatchPattern" }, "minItems": 1, "optional": true, "type": "array" }, "include_globs": { "items": { "type": "string" }, "optional": true, "type": "array" }, "js": { "description": "The list of CSS files to inject", "items": { "$ref": "ExtensionURL" }, "optional": true, "type": "array" }, "match_about_blank": { "description": "If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is false.", "optional": true, "type": "boolean" }, "matches": { "items": { "$ref": "MatchPattern" }, "minItems": 1, "optional": false, "type": "array" }, "run_at": { "$ref": "extensionTypes.RunAt", "default": "document_idle", "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\".", "optional": true } }, "type": "object" }, { "choices": [ { "additionalProperties": false, "patternProperties": { "^[1-9]\\d*$": { "$ref": "ExtensionURL" } }, "type": "object" }, { "$ref": "ExtensionURL" } ], "id": "IconPath" }, { "choices": [ { "additionalProperties": false, "patternProperties": { "^[1-9]\\d*$": { "$ref": "ImageData" } }, "type": "object" }, { "$ref": "ImageData" } ], "id": "IconImageData" }, { "id": "ImageData", "isInstanceOf": "ImageData", "postprocess": "convertImageDataToURL", "type": "object" }, { "deprecated": "An unexpected property was found in the WebExtension manifest.", "id": "UnrecognizedProperty", "type": "any" }, { "deprecated": "Event pages are not currently supported. This will run as a persistent background page.", "id": "PersistentBackgroundProperty", "type": "boolean" } ] }, { "$import": "menus", "description": "Use the browser.contextMenus API to add items to the browser's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages.", "namespace": "contextMenus", "permissions": [ "contextMenus" ], "types": [ { "description": "The different contexts a menu can appear in. Specifying 'all' is equivalent to the combination of all other contexts except for 'tab' and 'tools_menu'.", "enum": [ "all", "page", "frame", "selection", "link", "editable", "password", "image", "video", "audio", "launcher", "browser_action", "page_action", "tab" ], "id": "ContextType", "type": "string" } ] }, { "description": "Use the browser.menus API to add items to the browser's menus. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages.", "events": [ { "description": "Fired when a context menu item is clicked.", "name": "onClicked", "parameters": [ { "$ref": "OnClickData", "description": "Information about the item clicked and the context where the click happened.", "name": "info" }, { "$ref": "tabs.Tab", "description": "The details of the tab where the click took place. If the click did not take place in a tab, this parameter will be missing.", "name": "tab", "optional": true } ], "type": "function" } ], "functions": [ { "description": "Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in $(ref:runtime.lastError)).", "name": "create", "parameters": [ { "name": "createProperties", "properties": { "checked": { "description": "The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items.", "optional": true, "type": "boolean" }, "command": { "description": "Specifies a command to issue for the context click. Currently supports internal commands _execute_page_action, _execute_browser_action and _execute_sidebar_action.", "optional": true, "type": "string" }, "contexts": { "description": "List of contexts this menu item will appear in. Defaults to ['page'] if not specified.", "items": { "$ref": "ContextType" }, "minItems": 1, "optional": true, "type": "array" }, "documentUrlPatterns": { "description": "Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see $(topic:match_patterns)[Match Patterns].", "items": { "type": "string" }, "optional": true, "type": "array" }, "enabled": { "description": "Whether this context menu item is enabled or disabled. Defaults to true.", "optional": true, "type": "boolean" }, "icons": { "optional": true, "patternProperties": { "^[1-9]\\d*$": { "type": "string" } }, "type": "object" }, "id": { "description": "The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.", "optional": true, "type": "string" }, "onclick": { "description": "A function that will be called back when the menu item is clicked. Event pages cannot use this; instead, they should register a listener for $(ref:contextMenus.onClicked).", "optional": true, "parameters": [ { "$ref": "contextMenusInternal.OnClickData", "description": "Information about the item clicked and the context where the click happened.", "name": "info" }, { "$ref": "tabs.Tab", "description": "The details of the tab where the click took place. Note: this parameter only present for extensions.", "name": "tab" } ], "type": "function" }, "parentId": { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The ID of a parent menu item; this makes the item a child of a previously added item.", "optional": true }, "targetUrlPatterns": { "description": "Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.", "items": { "type": "string" }, "optional": true, "type": "array" }, "title": { "description": "The text to be displayed in the item; this is required unless type is 'separator'. When the context is 'selection', you can use %s within the string to show the selected text. For example, if this parameter's value is \"Translate '%s' to Pig Latin\" and the user selects the word \"cool\", the context menu item for the selection is \"Translate 'cool' to Pig Latin\".", "optional": true, "type": "string" }, "type": { "$ref": "ItemType", "description": "The type of menu item. Defaults to 'normal' if not specified.", "optional": true } }, "type": "object" }, { "description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in $(ref:runtime.lastError).", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "returns": { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The ID of the newly created item." }, "type": "function" }, { "async": "callback", "description": "Updates a previously created context menu item.", "name": "update", "parameters": [ { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The ID of the item to update.", "name": "id" }, { "description": "The properties to update. Accepts the same values as the create function.", "name": "updateProperties", "properties": { "checked": { "optional": true, "type": "boolean" }, "contexts": { "items": { "$ref": "ContextType" }, "minItems": 1, "optional": true, "type": "array" }, "documentUrlPatterns": { "items": { "type": "string" }, "optional": true, "type": "array" }, "enabled": { "optional": true, "type": "boolean" }, "onclick": { "optional": "omit-key-if-missing", "parameters": [ { "$ref": "menusInternal.OnClickData", "name": "info" }, { "$ref": "tabs.Tab", "description": "The details of the tab where the click took place. Note: this parameter only present for extensions.", "name": "tab" } ], "type": "function" }, "parentId": { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "Note: You cannot change an item to be a child of one of its own descendants.", "optional": true }, "targetUrlPatterns": { "items": { "type": "string" }, "optional": true, "type": "array" }, "title": { "optional": true, "type": "string" }, "type": { "$ref": "ItemType", "optional": true } }, "type": "object" }, { "description": "Called when the context menu has been updated.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes a context menu item.", "name": "remove", "parameters": [ { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The ID of the context menu item to remove.", "name": "menuItemId" }, { "description": "Called when the context menu has been removed.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes all context menu items added by this extension.", "name": "removeAll", "parameters": [ { "description": "Called when removal is complete.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" } ], "namespace": "menus", "permissions": [ "menus" ], "properties": { "ACTION_MENU_TOP_LEVEL_LIMIT": { "description": "The maximum number of top level extension items that can be added to an extension action context menu. Any items beyond this limit will be ignored.", "value": 6 } }, "types": [ { "description": "The different contexts a menu can appear in. Specifying 'all' is equivalent to the combination of all other contexts except for 'tab' and 'tools_menu'.", "enum": [ "all", "page", "frame", "selection", "link", "editable", "password", "image", "video", "audio", "launcher", "browser_action", "page_action", "tab", "tools_menu" ], "id": "ContextType", "type": "string" }, { "description": "The type of menu item.", "enum": [ "normal", "checkbox", "radio", "separator" ], "id": "ItemType", "type": "string" }, { "description": "Information sent when a context menu item is clicked.", "id": "OnClickData", "properties": { "checked": { "description": "A flag indicating the state of a checkbox or radio item after it is clicked.", "optional": true, "type": "boolean" }, "editable": { "description": "A flag indicating whether the element is editable (text input, textarea, etc.).", "type": "boolean" }, "frameUrl": { "description": " The URL of the frame of the element where the context menu was clicked, if it was in a frame.", "optional": true, "type": "string" }, "linkText": { "description": "If the element is a link, the text of that link.", "optional": true, "type": "string" }, "linkUrl": { "description": "If the element is a link, the URL it points to.", "optional": true, "type": "string" }, "mediaType": { "description": "One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements.", "optional": true, "type": "string" }, "menuItemId": { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The ID of the menu item that was clicked." }, "modifiers": { "description": "An array of keyboard modifiers that were held while the menu item was clicked.", "items": { "enum": [ "Shift", "Alt", "Command", "Ctrl", "MacCtrl" ], "type": "string" }, "type": "array" }, "pageUrl": { "description": "The URL of the page where the menu item was clicked. This property is not set if the click occured in a context where there is no current page, such as in a launcher context menu.", "optional": true, "type": "string" }, "parentMenuItemId": { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The parent ID, if any, for the item clicked.", "optional": true }, "selectionText": { "description": "The text for the context selection, if any.", "optional": true, "type": "string" }, "srcUrl": { "description": "Will be present for elements with a 'src' URL.", "optional": true, "type": "string" }, "wasChecked": { "description": "A flag indicating the state of a checkbox or radio item before it was clicked.", "optional": true, "type": "boolean" } }, "type": "object" } ] }, { "allowedContexts": [ "addon_parent_only" ], "description": "Use the browser.contextMenus API to add items to the browser's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages.", "namespace": "menusInternal", "types": [ { "description": "Information sent when a context menu item is clicked.", "id": "OnClickData", "properties": { "checked": { "description": "A flag indicating the state of a checkbox or radio item after it is clicked.", "optional": true, "type": "boolean" }, "editable": { "description": "A flag indicating whether the element is editable (text input, textarea, etc.).", "type": "boolean" }, "frameUrl": { "description": " The URL of the frame of the element where the context menu was clicked, if it was in a frame.", "optional": true, "type": "string" }, "linkUrl": { "description": "If the element is a link, the URL it points to.", "optional": true, "type": "string" }, "mediaType": { "description": "One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements.", "optional": true, "type": "string" }, "menuItemId": { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The ID of the menu item that was clicked." }, "pageUrl": { "description": "The URL of the page where the menu item was clicked. This property is not set if the click occured in a context where there is no current page, such as in a launcher context menu.", "optional": true, "type": "string" }, "parentMenuItemId": { "choices": [ { "type": "integer" }, { "type": "string" } ], "description": "The parent ID, if any, for the item clicked.", "optional": true }, "selectionText": { "description": "The text for the context selection, if any.", "optional": true, "type": "string" }, "srcUrl": { "description": "Will be present for elements with a 'src' URL.", "optional": true, "type": "string" }, "wasChecked": { "description": "A flag indicating the state of a checkbox or radio item before it was clicked.", "optional": true, "type": "boolean" } }, "type": "object" } ] }, { "events": [ { "description": "Fired when the notification closed, either by the system or by user action.", "name": "onClosed", "parameters": [ { "description": "The notificationId of the closed notification.", "name": "notificationId", "type": "string" }, { "description": "True if the notification was closed by the user.", "name": "byUser", "type": "boolean" } ], "type": "function" }, { "description": "Fired when the user clicked in a non-button area of the notification.", "name": "onClicked", "parameters": [ { "description": "The notificationId of the clicked notification.", "name": "notificationId", "type": "string" } ], "type": "function" }, { "description": "Fired when the user pressed a button in the notification.", "name": "onButtonClicked", "parameters": [ { "description": "The notificationId of the clicked notification.", "name": "notificationId", "type": "string" }, { "description": "The index of the button clicked by the user.", "name": "buttonIndex", "type": "number" } ], "type": "function" }, { "description": "Fired when the user changes the permission level.", "name": "onPermissionLevelChanged", "parameters": [ { "$ref": "PermissionLevel", "description": "The new permission level.", "name": "level" } ], "type": "function", "unsupported": true }, { "description": "Fired when the user clicked on a link for the app's notification settings.", "name": "onShowSettings", "parameters": [], "type": "function", "unsupported": true }, { "description": "Fired when the notification is shown.", "name": "onShown", "parameters": [ { "description": "The notificationId of the shown notification.", "name": "notificationId", "type": "string" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Creates and displays a notification.", "name": "create", "parameters": [ { "description": "Identifier of the notification. If it is empty, this method generates an id. If it matches an existing notification, this method first clears that notification before proceeding with the create operation.", "name": "notificationId", "optional": true, "type": "string" }, { "$ref": "CreateNotificationOptions", "description": "Contents of the notification.", "name": "options" }, { "name": "callback", "optional": true, "parameters": [ { "description": "The notification id (either supplied or generated) that represents the created notification.", "name": "notificationId", "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Updates an existing notification.", "name": "update", "parameters": [ { "description": "The id of the notification to be updated.", "name": "notificationId", "type": "string" }, { "$ref": "UpdateNotificationOptions", "description": "Contents of the notification to update to.", "name": "options" }, { "name": "callback", "optional": true, "parameters": [ { "description": "Indicates whether a matching notification existed.", "name": "wasUpdated", "type": "boolean" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Clears an existing notification.", "name": "clear", "parameters": [ { "description": "The id of the notification to be updated.", "name": "notificationId", "type": "string" }, { "name": "callback", "optional": true, "parameters": [ { "description": "Indicates whether a matching notification existed.", "name": "wasCleared", "type": "boolean" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves all the notifications.", "name": "getAll", "parameters": [ { "name": "callback", "parameters": [ { "additionalProperties": { "$ref": "CreateNotificationOptions" }, "description": "The set of notifications currently in the system.", "name": "notifications", "type": "object" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves whether the user has enabled notifications from this app or extension.", "name": "getPermissionLevel", "parameters": [ { "name": "callback", "parameters": [ { "$ref": "PermissionLevel", "description": "The current permission level.", "name": "level" } ], "type": "function" } ], "type": "function", "unsupported": true } ], "namespace": "notifications", "permissions": [ "notifications" ], "types": [ { "enum": [ "basic", "image", "list", "progress" ], "id": "TemplateType", "type": "string" }, { "enum": [ "granted", "denied" ], "id": "PermissionLevel", "type": "string" }, { "id": "NotificationItem", "properties": { "message": { "description": "Additional details about this item.", "type": "string" }, "title": { "description": "Title of one item of a list notification.", "type": "string" } }, "type": "object" }, { "id": "CreateNotificationOptions", "properties": { "appIconMaskUrl": { "description": "A URL to the app icon mask.", "optional": true, "type": "string" }, "buttons": { "description": "Text and icons for up to two notification action buttons.", "items": { "properties": { "iconUrl": { "optional": true, "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "optional": true, "type": "array", "unsupported": true }, "contextMessage": { "description": "Alternate notification content with a lower-weight font.", "optional": true, "type": "string" }, "eventTime": { "description": "A timestamp associated with the notification, in milliseconds past the epoch.", "optional": true, "type": "number" }, "iconUrl": { "description": "A URL to the sender's avatar, app icon, or a thumbnail for image notifications.", "optional": true, "type": "string" }, "imageUrl": { "description": "A URL to the image thumbnail for image-type notifications.", "optional": true, "type": "string" }, "isClickable": { "description": "Whether to show UI indicating that the app will visibly respond to clicks on the body of a notification.", "optional": true, "type": "boolean" }, "items": { "description": "Items for multi-item notifications.", "items": { "$ref": "NotificationItem" }, "optional": true, "type": "array" }, "message": { "description": "Main notification content.", "type": "string" }, "priority": { "description": "Priority ranges from -2 to 2. -2 is lowest priority. 2 is highest. Zero is default.", "maximum": 2, "minimum": -2, "optional": true, "type": "integer" }, "progress": { "description": "Current progress ranges from 0 to 100.", "maximum": 100, "minimum": 0, "optional": true, "type": "integer" }, "title": { "description": "Title of the notification (e.g. sender name for email).", "type": "string" }, "type": { "$ref": "TemplateType", "description": "Which type of notification to display." } }, "type": "object" }, { "id": "UpdateNotificationOptions", "properties": { "appIconMaskUrl": { "description": "A URL to the app icon mask.", "optional": true, "type": "string" }, "buttons": { "description": "Text and icons for up to two notification action buttons.", "items": { "properties": { "iconUrl": { "optional": true, "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "optional": true, "type": "array", "unsupported": true }, "contextMessage": { "description": "Alternate notification content with a lower-weight font.", "optional": true, "type": "string" }, "eventTime": { "description": "A timestamp associated with the notification, in milliseconds past the epoch.", "optional": true, "type": "number" }, "iconUrl": { "description": "A URL to the sender's avatar, app icon, or a thumbnail for image notifications.", "optional": true, "type": "string" }, "imageUrl": { "description": "A URL to the image thumbnail for image-type notifications.", "optional": true, "type": "string" }, "isClickable": { "description": "Whether to show UI indicating that the app will visibly respond to clicks on the body of a notification.", "optional": true, "type": "boolean" }, "items": { "description": "Items for multi-item notifications.", "items": { "$ref": "NotificationItem" }, "optional": true, "type": "array" }, "message": { "description": "Main notification content.", "optional": true, "type": "string" }, "priority": { "description": "Priority ranges from -2 to 2. -2 is lowest priority. 2 is highest. Zero is default.", "maximum": 2, "minimum": -2, "optional": true, "type": "integer" }, "progress": { "description": "Current progress ranges from 0 to 100.", "maximum": 100, "minimum": 0, "optional": true, "type": "integer" }, "title": { "description": "Title of the notification (e.g. sender name for email).", "optional": true, "type": "string" }, "type": { "$ref": "TemplateType", "description": "Which type of notification to display.", "optional": true } }, "type": "object" } ] }, { "description": "The omnibox API allows you to register a keyword with Firefox's address bar.", "events": [ { "description": "User has started a keyword input session by typing the extension's keyword. This is guaranteed to be sent exactly once per input session, and before any onInputChanged events.", "name": "onInputStarted", "parameters": [], "type": "function" }, { "description": "User has changed what is typed into the omnibox.", "name": "onInputChanged", "parameters": [ { "name": "text", "type": "string" }, { "description": "A callback passed to the onInputChanged event used for sending suggestions back to the browser.", "name": "suggest", "parameters": [ { "description": "Array of suggest results", "items": { "$ref": "SuggestResult" }, "name": "suggestResults", "type": "array" } ], "type": "function" } ], "type": "function" }, { "description": "User has accepted what is typed into the omnibox.", "name": "onInputEntered", "parameters": [ { "name": "text", "type": "string" }, { "$ref": "OnInputEnteredDisposition", "name": "disposition" } ], "type": "function" }, { "description": "User has ended the keyword input session without accepting the input.", "name": "onInputCancelled", "parameters": [], "type": "function" } ], "functions": [ { "description": "Sets the description and styling for the default suggestion. The default suggestion is the text that is displayed in the first suggestion row underneath the URL bar.", "name": "setDefaultSuggestion", "parameters": [ { "$ref": "DefaultSuggestResult", "description": "A partial SuggestResult object, without the 'content' parameter.", "name": "suggestion" } ], "type": "function" } ], "namespace": "omnibox", "permissions": [ "manifest:omnibox" ], "types": [ { "description": "The style type.", "enum": [ "url", "match", "dim" ], "id": "DescriptionStyleType", "type": "string" }, { "description": "The window disposition for the omnibox query. This is the recommended context to display results. For example, if the omnibox command is to navigate to a certain URL, a disposition of 'newForegroundTab' means the navigation should take place in a new selected tab.", "enum": [ "currentTab", "newForegroundTab", "newBackgroundTab" ], "id": "OnInputEnteredDisposition", "type": "string" }, { "description": "A suggest result.", "id": "SuggestResult", "properties": { "content": { "description": "The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry.", "minLength": 1, "type": "string" }, "description": { "description": "The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. dimmed match. You must escape the five predefined entities to display them as text: stackoverflow.com/a/1091953/89484 ", "minLength": 1, "type": "string" }, "descriptionStyles": { "description": "An array of style ranges for the description, as provided by the extension.", "items": { "description": "The style ranges for the description, as provided by the extension.", "properties": { "length": { "optional": true, "type": "integer" }, "offset": { "type": "integer" }, "type": { "$ref": "DescriptionStyleType", "description": "The style type" } }, "type": "object" }, "optional": true, "type": "array", "unsupported": true }, "descriptionStylesRaw": { "description": "An array of style ranges for the description, as provided by ToValue().", "items": { "description": "The style ranges for the description, as provided by ToValue().", "properties": { "offset": { "type": "integer" }, "type": { "type": "integer" } }, "type": "object" }, "optional": true, "type": "array", "unsupported": true } }, "type": "object" }, { "description": "A suggest result.", "id": "DefaultSuggestResult", "properties": { "description": { "description": "The text that is displayed in the URL dropdown.", "minLength": 1, "type": "string" }, "descriptionStyles": { "description": "An array of style ranges for the description, as provided by the extension.", "items": { "description": "The style ranges for the description, as provided by the extension.", "properties": { "length": { "optional": true, "type": "integer" }, "offset": { "type": "integer" }, "type": { "$ref": "DescriptionStyleType", "description": "The style type" } }, "type": "object" }, "optional": true, "type": "array", "unsupported": true }, "descriptionStylesRaw": { "description": "An array of style ranges for the description, as provided by ToValue().", "items": { "description": "The style ranges for the description, as provided by ToValue().", "properties": { "offset": { "type": "integer" }, "type": { "type": "integer" } }, "type": "object" }, "optional": true, "type": "array", "unsupported": true } }, "type": "object" } ] }, { "description": "Use the browser.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages.", "events": [ { "description": "Fired when a page action icon is clicked. This event will not fire if the page action has a popup.", "name": "onClicked", "parameters": [ { "$ref": "tabs.Tab", "name": "tab" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Shows the page action. The page action is shown whenever the tab is selected.", "name": "show", "parameters": [ { "description": "The id of the tab for which you want to modify the page action.", "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Hides the page action.", "name": "hide", "parameters": [ { "description": "The id of the tab for which you want to modify the page action.", "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "description": "Sets the title of the page action. This is displayed in a tooltip over the page action.", "name": "setTitle", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "The id of the tab for which you want to modify the page action.", "minimum": 0, "type": "integer" }, "title": { "description": "The tooltip string.", "type": "string" } }, "type": "object" } ], "type": "function" }, { "async": "callback", "description": "Gets the title of the page action.", "name": "getTitle", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the title from.", "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "name": "result", "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets the icon for the page action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the path or the imageData property must be specified.", "name": "setIcon", "parameters": [ { "name": "details", "properties": { "imageData": { "choices": [ { "$ref": "ImageDataType" }, { "patternProperties": { "^[1-9]\\d*$": { "$ref": "ImageDataType" } }, "type": "object" } ], "description": "Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}'", "optional": true }, "path": { "choices": [ { "type": "string" }, { "patternProperties": { "^[1-9]\\d*$": { "type": "string" } }, "type": "object" } ], "description": "Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'", "optional": true }, "tabId": { "description": "The id of the tab for which you want to modify the page action.", "minimum": 0, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": true, "description": "Sets the html document to be opened as a popup when the user clicks on the page action's icon.", "name": "setPopup", "parameters": [ { "name": "details", "properties": { "popup": { "description": "The html file to show in a popup. If set to the empty string (''), no popup is shown.", "type": "string" }, "tabId": { "description": "The id of the tab for which you want to modify the page action.", "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "async": "callback", "description": "Gets the html document set as the popup for this page action.", "name": "getPopup", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the popup from.", "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "name": "result", "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": true, "description": "Opens the extension page action in the active window.", "name": "openPopup", "parameters": [], "requireUserInput": true, "type": "function" } ], "namespace": "pageAction", "permissions": [ "manifest:page_action" ], "types": [ { "additionalProperties": { "type": "any" }, "description": "Pixel data for an image. Must be an ImageData object (for example, from a canvas element).", "id": "ImageDataType", "isInstanceOf": "ImageData", "postprocess": "convertImageDataToURL", "type": "object" } ] }, { "events": [ { "description": "Fired when the extension acquires new permissions.", "name": "onAdded", "parameters": [ { "$ref": "Permissions", "name": "permissions" } ], "type": "function", "unsupported": true }, { "description": "Fired when permissions are removed from the extension.", "name": "onRemoved", "parameters": [ { "$ref": "Permissions", "name": "permissions" } ], "type": "function", "unsupported": true } ], "functions": [ { "async": "callback", "description": "Get a list of all the extension's permissions.", "name": "getAll", "parameters": [ { "name": "callback", "parameters": [ { "$ref": "AnyPermissions", "name": "permissions" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Check if the extension has the given permissions.", "name": "contains", "parameters": [ { "$ref": "AnyPermissions", "name": "permissions" }, { "name": "callback", "parameters": [ { "name": "result", "type": "boolean" } ], "type": "function" } ], "type": "function" }, { "allowedContexts": [ "content" ], "async": "callback", "description": "Request the given permissions.", "name": "request", "parameters": [ { "$ref": "Permissions", "name": "permissions" }, { "name": "callback", "parameters": [ { "name": "granted", "type": "boolean" } ], "type": "function" } ], "requireUserInput": true, "type": "function" }, { "async": "callback", "description": "Relinquish the given permissions.", "name": "remove", "parameters": [ { "$ref": "Permissions", "name": "permissions" }, { "name": "callback", "parameters": [], "type": "function" } ], "type": "function" } ], "namespace": "permissions", "permissions": [ "manifest:optional_permissions" ], "types": [ { "id": "Permissions", "properties": { "origins": { "default": [], "items": { "$ref": "manifest.MatchPattern" }, "optional": true, "type": "array" }, "permissions": { "default": [], "items": { "$ref": "manifest.OptionalPermission" }, "optional": true, "type": "array" } }, "type": "object" }, { "id": "AnyPermissions", "properties": { "origins": { "default": [], "items": { "$ref": "manifest.MatchPatternInternal" }, "optional": true, "type": "array" }, "permissions": { "default": [], "items": { "$ref": "manifest.Permission" }, "optional": true, "type": "array" } }, "type": "object" } ] }, { "description": "PKCS#11 module management API", "functions": [ { "async": true, "description": "checks whether a PKCS#11 module, given by name, is installed", "name": "isModuleInstalled", "parameters": [ { "name": "name", "type": "string" } ], "type": "function" }, { "async": true, "description": "Install a PKCS#11 module with a given name", "name": "installModule", "parameters": [ { "name": "name", "type": "string" }, { "name": "flags", "optional": true, "type": "integer" } ], "type": "function" }, { "async": true, "description": "Remove an installed PKCS#11 module from firefox", "name": "uninstallModule", "parameters": [ { "name": "name", "type": "string" } ], "type": "function" }, { "async": true, "description": "Enumerate a module's slots, each with their name and whether a token is present", "name": "getModuleSlots", "parameters": [ { "name": "name", "type": "string" } ], "type": "function" } ], "namespace": "pkcs11", "permissions": [ "pkcs11" ] }, { "namespace": "privacy", "permissions": [ "privacy" ] }, { "description": "Use the browser.privacy API to control usage of the features in the browser that can affect a user's privacy.", "namespace": "privacy.network", "permissions": [ "privacy" ], "properties": { "networkPredictionEnabled": { "$ref": "types.Setting", "description": "If enabled, the browser attempts to speed up your web browsing experience by pre-resolving DNS entries, prerendering sites (<link rel='prefetch' ...>), and preemptively opening TCP and SSL connections to servers. This preference's value is a boolean, defaulting to true." }, "peerConnectionEnabled": { "$ref": "types.Setting", "description": "Allow users to enable and disable RTCPeerConnections (aka WebRTC)." }, "webRTCIPHandlingPolicy": { "$ref": "types.Setting", "description": "Allow users to specify the media performance/privacy tradeoffs which impacts how WebRTC traffic will be routed and how much local address information is exposed. This preference's value is of type IPHandlingPolicy, defaulting to default." } }, "types": [ { "description": "The IP handling policy of WebRTC.", "enum": [ "default", "default_public_and_private_interfaces", "default_public_interface_only", "disable_non_proxied_udp" ], "id": "IPHandlingPolicy", "type": "string" } ] }, { "description": "Use the browser.privacy API to control usage of the features in the browser that can affect a user's privacy.", "namespace": "privacy.services", "permissions": [ "privacy" ], "properties": { "passwordSavingEnabled": { "$ref": "types.Setting", "description": "If enabled, the password manager will ask if you want to save passwords. This preference's value is a boolean, defaulting to true." } } }, { "description": "Use the browser.privacy API to control usage of the features in the browser that can affect a user's privacy.", "namespace": "privacy.websites", "permissions": [ "privacy" ], "properties": { "firstPartyIsolate": { "$ref": "types.Setting", "description": "If enabled, the browser will associate all data (including cookies, HSTS data, cached images, and more) for any third party domains with the domain in the address bar. This prevents third party trackers from using directly stored information to identify you across different websites, but may break websites where you login with a third party account (such as a Facebook or Google login.) The value of this preference is of type boolean, and the default value is false." }, "hyperlinkAuditingEnabled": { "$ref": "types.Setting", "description": "If enabled, the browser sends auditing pings when requested by a website (<a ping>). The value of this preference is of type boolean, and the default value is true." }, "protectedContentEnabled": { "$ref": "types.Setting", "description": "Available on Windows and ChromeOS only: If enabled, the browser provides a unique ID to plugins in order to run protected content. The value of this preference is of type boolean, and the default value is true.", "unsupported": true }, "referrersEnabled": { "$ref": "types.Setting", "description": "If enabled, the browser sends referer headers with your requests. Yes, the name of this preference doesn't match the misspelled header. No, we're not going to change it. The value of this preference is of type boolean, and the default value is true." }, "resistFingerprinting": { "$ref": "types.Setting", "description": "If enabled, the browser attempts to appear similar to other users by reporting generic information to websites. This can prevent websites from uniquely identifying users. Examples of data that is spoofed include number of CPU cores, precision of JavaScript timers, the local timezone, and disabling features such as GamePad support, and the WebSpeech and Navigator APIs. The value of this preference is of type boolean, and the default value is false." }, "thirdPartyCookiesAllowed": { "$ref": "types.Setting", "description": "If disabled, the browser blocks third-party sites from setting cookies. The value of this preference is of type boolean, and the default value is true.", "unsupported": true }, "trackingProtectionMode": { "$ref": "types.Setting", "description": "Allow users to specify the mode for tracking protection. This setting's value is of type TrackingProtectionModeOption, defaulting to private_browsing_only." } }, "types": [ { "description": "The mode for tracking protection.", "enum": [ "always", "never", "private_browsing" ], "id": "TrackingProtectionModeOption", "type": "string" } ] }, { "description": "Use the browser.proxy API to register proxy scripts in Firefox. Proxy scripts in Firefox are proxy auto-config files with extra contextual information and support for additional return types.", "events": [ { "description": "Notifies about proxy script errors.", "name": "onProxyError", "parameters": [ { "name": "error", "type": "object" } ], "type": "function" } ], "functions": [ { "async": true, "description": "Registers the proxy script for the extension.", "name": "register", "parameters": [ { "format": "strictRelativeUrl", "name": "url", "type": "string" } ], "type": "function" }, { "async": true, "description": "Unregisters the proxy script for the extension.", "name": "unregister", "parameters": [], "type": "function" }, { "async": true, "deprecated": "Please use $(ref:proxy.register)", "description": "Registers the proxy script for the extension.", "name": "registerProxyScript", "parameters": [ { "format": "strictRelativeUrl", "name": "url", "type": "string" } ], "type": "function" } ], "namespace": "proxy", "permissions": [ "proxy" ] }, { "allowedContexts": [ "content", "devtools", "proxy" ], "description": "Use the browser.runtime API to retrieve the background page, return details about the manifest, and listen for and respond to events in the app or extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs.", "events": [ { "description": "Fired when a profile that has this extension installed first starts up. This event is not fired for incognito profiles.", "name": "onStartup", "type": "function" }, { "description": "Fired when the extension is first installed, when the extension is updated to a new version, and when the browser is updated to a new version.", "name": "onInstalled", "parameters": [ { "name": "details", "properties": { "id": { "description": "Indicates the ID of the imported shared module extension which updated. This is present only if 'reason' is 'shared_module_update'.", "optional": true, "type": "string", "unsupported": true }, "previousVersion": { "description": "Indicates the previous version of the extension, which has just been updated. This is present only if 'reason' is 'update'.", "optional": true, "type": "string" }, "reason": { "$ref": "OnInstalledReason", "description": "The reason that this event is being dispatched." }, "temporary": { "description": "Indicates whether the addon is installed as a temporary extension.", "type": "boolean" } }, "type": "object" } ], "type": "function" }, { "description": "Sent to the event page just before it is unloaded. This gives the extension opportunity to do some clean up. Note that since the page is unloading, any asynchronous operations started while handling this event are not guaranteed to complete. If more activity for the event page occurs before it gets unloaded the onSuspendCanceled event will be sent and the page won't be unloaded. ", "name": "onSuspend", "type": "function", "unsupported": true }, { "description": "Sent after onSuspend to indicate that the app won't be unloaded after all.", "name": "onSuspendCanceled", "type": "function", "unsupported": true }, { "description": "Fired when an update is available, but isn't installed immediately because the app is currently running. If you do nothing, the update will be installed the next time the background page gets unloaded, if you want it to be installed sooner you can explicitly call $(ref:runtime.reload). If your extension is using a persistent background page, the background page of course never gets unloaded, so unless you call $(ref:runtime.reload) manually in response to this event the update will not get installed until the next time the browser itself restarts. If no handlers are listening for this event, and your extension has a persistent background page, it behaves as if $(ref:runtime.reload) is called in response to this event.", "name": "onUpdateAvailable", "parameters": [ { "additionalProperties": { "type": "any" }, "description": "The manifest details of the available update.", "name": "details", "properties": { "version": { "description": "The version number of the available update.", "type": "string" } }, "type": "object" } ], "type": "function" }, { "deprecated": "Please use $(ref:runtime.onRestartRequired).", "description": "Fired when an update for the browser is available, but isn't installed immediately because a browser restart is required.", "name": "onBrowserUpdateAvailable", "parameters": [], "type": "function", "unsupported": true }, { "allowedContexts": [ "content", "devtools" ], "description": "Fired when a connection is made from either an extension process or a content script.", "name": "onConnect", "parameters": [ { "$ref": "Port", "name": "port" } ], "type": "function" }, { "description": "Fired when a connection is made from another extension.", "name": "onConnectExternal", "parameters": [ { "$ref": "Port", "name": "port" } ], "type": "function" }, { "allowedContexts": [ "content", "devtools", "proxy" ], "description": "Fired when a message is sent from either an extension process or a content script.", "name": "onMessage", "parameters": [ { "description": "The message sent by the calling script.", "name": "message", "optional": true, "type": "any" }, { "$ref": "MessageSender", "name": "sender" }, { "description": "Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object. If you have more than one onMessage listener in the same document, then only one may send a response. This function becomes invalid when the event listener returns, unless you return true from the event listener to indicate you wish to send a response asynchronously (this will keep the message channel open to the other end until sendResponse is called).", "name": "sendResponse", "type": "function" } ], "returns": { "description": "Return true from the event listener if you wish to call sendResponse after the event listener returns.", "optional": true, "type": "boolean" }, "type": "function" }, { "description": "Fired when a message is sent from another extension/app. Cannot be used in a content script.", "name": "onMessageExternal", "parameters": [ { "description": "The message sent by the calling script.", "name": "message", "optional": true, "type": "any" }, { "$ref": "MessageSender", "name": "sender" }, { "description": "Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object. If you have more than one onMessage listener in the same document, then only one may send a response. This function becomes invalid when the event listener returns, unless you return true from the event listener to indicate you wish to send a response asynchronously (this will keep the message channel open to the other end until sendResponse is called).", "name": "sendResponse", "type": "function" } ], "returns": { "description": "Return true from the event listener if you wish to call sendResponse after the event listener returns.", "optional": true, "type": "boolean" }, "type": "function" }, { "description": "Fired when an app or the device that it runs on needs to be restarted. The app should close all its windows at its earliest convenient time to let the restart to happen. If the app does nothing, a restart will be enforced after a 24-hour grace period has passed. Currently, this event is only fired for Chrome OS kiosk apps.", "name": "onRestartRequired", "parameters": [ { "$ref": "OnRestartRequiredReason", "description": "The reason that the event is being dispatched.", "name": "reason" } ], "type": "function", "unsupported": true } ], "functions": [ { "async": "callback", "description": "Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.", "name": "getBackgroundPage", "parameters": [ { "name": "callback", "parameters": [ { "additionalProperties": { "type": "any" }, "description": "The JavaScript 'window' object for the background page.", "isInstanceOf": "Window", "name": "backgroundPage", "optional": true, "type": "object" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "

Open your Extension's options page, if possible.

The precise behavior may depend on your manifest's $(topic:optionsV2)[options_ui] or $(topic:options)[options_page] key, or what the browser happens to support at the time.

If your Extension does not declare an options page, or the browser failed to create one for some other reason, the callback will set $(ref:lastError).

", "name": "openOptionsPage", "parameters": [ { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "allowedContexts": [ "content", "devtools" ], "description": "Returns details about the app or extension from the manifest. The object returned is a serialization of the full $(topic:manifest)[manifest file].", "name": "getManifest", "parameters": [], "returns": { "additionalProperties": { "type": "any" }, "description": "The manifest details.", "properties": {}, "type": "object" }, "type": "function" }, { "allowedContexts": [ "content", "devtools" ], "description": "Converts a relative path within an app/extension install directory to a fully-qualified URL.", "name": "getURL", "parameters": [ { "description": "A path to a resource within an app/extension expressed relative to its install directory.", "name": "path", "type": "string" } ], "returns": { "description": "The fully-qualified URL to the resource.", "type": "string" }, "type": "function" }, { "async": "callback", "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.", "name": "setUninstallURL", "parameters": [ { "description": "URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation.", "maxLength": 255, "name": "url", "type": "string" }, { "description": "Called when the uninstall URL is set. If the given URL is invalid, $(ref:runtime.lastError) will be set.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "description": "Reloads the app or extension.", "name": "reload", "parameters": [], "type": "function" }, { "async": "callback", "description": "Requests an update check for this app/extension.", "name": "requestUpdateCheck", "parameters": [ { "name": "callback", "parameters": [ { "$ref": "RequestUpdateCheckStatus", "description": "Result of the update check.", "name": "status" }, { "description": "If an update is available, this contains more information about the available update.", "name": "details", "optional": true, "properties": { "version": { "description": "The version of the available update.", "type": "string" } }, "type": "object" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "description": "Restart the device when the app runs in kiosk mode. Otherwise, it's no-op.", "name": "restart", "parameters": [], "type": "function", "unsupported": true }, { "allowedContexts": [ "content", "devtools" ], "description": "Attempts to connect to connect listeners within an extension/app (such as the background page), or other extensions/apps. This is useful for content scripts connecting to their extension processes, inter-app/extension communication, and $(topic:manifest/externally_connectable)[web messaging]. Note that this does not connect to any listeners in a content script. Extensions may connect to content scripts embedded in tabs via $(ref:tabs.connect).", "name": "connect", "parameters": [ { "description": "The ID of the extension or app to connect to. If omitted, a connection will be attempted with your own extension. Required if sending messages from a web page for $(topic:manifest/externally_connectable)[web messaging].", "name": "extensionId", "optional": true, "type": "string" }, { "name": "connectInfo", "optional": true, "properties": { "includeTlsChannelId": { "description": "Whether the TLS channel ID will be passed into onConnectExternal for processes that are listening for the connection event.", "optional": true, "type": "boolean" }, "name": { "description": "Will be passed into onConnect for processes that are listening for the connection event.", "optional": true, "type": "string" } }, "type": "object" } ], "returns": { "$ref": "Port", "description": "Port through which messages can be sent and received. The port's $(ref:runtime.Port onDisconnect) event is fired if the extension/app does not exist. " }, "type": "function" }, { "description": "Connects to a native application in the host machine.", "name": "connectNative", "parameters": [ { "description": "The name of the registered application to connect to.", "name": "application", "pattern": "^\\w+(\\.\\w+)*$", "type": "string" } ], "permissions": [ "nativeMessaging" ], "returns": { "$ref": "Port", "description": "Port through which messages can be sent and received with the application" }, "type": "function" }, { "allowAmbiguousOptionalArguments": true, "allowedContexts": [ "content", "devtools", "proxy" ], "async": "responseCallback", "description": "Sends a single message to event listeners within your extension/app or a different extension/app. Similar to $(ref:runtime.connect) but only sends a single message, with an optional response. If sending to your extension, the $(ref:runtime.onMessage) event will be fired in each page, or $(ref:runtime.onMessageExternal), if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use $(ref:tabs.sendMessage).", "name": "sendMessage", "parameters": [ { "description": "The ID of the extension/app to send the message to. If omitted, the message will be sent to your own extension/app. Required if sending messages from a web page for $(topic:manifest/externally_connectable)[web messaging].", "name": "extensionId", "optional": true, "type": "string" }, { "name": "message", "type": "any" }, { "name": "options", "optional": true, "properties": { "includeTlsChannelId": { "description": "Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event.", "optional": true, "type": "boolean", "unsupported": true }, "toProxyScript": { "description": "If true, the message will be directed to the extension's proxy sandbox.", "optional": true, "type": "boolean" } }, "type": "object" }, { "name": "responseCallback", "optional": true, "parameters": [ { "description": "The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and $(ref:runtime.lastError) will be set to the error message.", "name": "response", "type": "any" } ], "type": "function" } ], "type": "function" }, { "async": "responseCallback", "description": "Send a single message to a native application.", "name": "sendNativeMessage", "parameters": [ { "description": "The name of the native messaging host.", "name": "application", "pattern": "^\\w+(\\.\\w+)*$", "type": "string" }, { "description": "The message that will be passed to the native messaging host.", "name": "message", "type": "any" }, { "name": "responseCallback", "optional": true, "parameters": [ { "description": "The response message sent by the native messaging host. If an error occurs while connecting to the native messaging host, the callback will be called with no arguments and $(ref:runtime.lastError) will be set to the error message.", "name": "response", "type": "any" } ], "type": "function" } ], "permissions": [ "nativeMessaging" ], "type": "function" }, { "async": "callback", "description": "Returns information about the current browser.", "name": "getBrowserInfo", "parameters": [ { "description": "Called with results", "name": "callback", "parameters": [ { "$ref": "BrowserInfo", "name": "browserInfo" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Returns information about the current platform.", "name": "getPlatformInfo", "parameters": [ { "description": "Called with results", "name": "callback", "parameters": [ { "$ref": "PlatformInfo", "name": "platformInfo" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Returns a DirectoryEntry for the package directory.", "name": "getPackageDirectoryEntry", "parameters": [ { "name": "callback", "parameters": [ { "additionalProperties": { "type": "any" }, "isInstanceOf": "DirectoryEntry", "name": "directoryEntry", "type": "object" } ], "type": "function" } ], "type": "function", "unsupported": true } ], "namespace": "runtime", "properties": { "id": { "allowedContexts": [ "content", "devtools" ], "description": "The ID of the extension/app.", "type": "string" }, "lastError": { "additionalProperties": { "type": "any" }, "allowedContexts": [ "content", "devtools" ], "description": "This will be defined during an API method callback if there was an error", "optional": true, "properties": { "message": { "description": "Details about the error which occurred.", "optional": true, "type": "string" } }, "type": "object" } }, "types": [ { "additionalProperties": { "type": "any" }, "allowedContexts": [ "content", "devtools" ], "description": "An object which allows two way communication with other pages.", "id": "Port", "properties": { "disconnect": { "type": "function" }, "name": { "type": "string" }, "onDisconnect": { "$ref": "events.Event" }, "onMessage": { "$ref": "events.Event" }, "postMessage": { "type": "function" }, "sender": { "$ref": "MessageSender", "description": "This property will only be present on ports passed to onConnect/onConnectExternal listeners.", "optional": true } }, "type": "object" }, { "allowedContexts": [ "content", "devtools" ], "description": "An object containing information about the script context that sent a message or request.", "id": "MessageSender", "properties": { "frameId": { "description": "The $(topic:frame_ids)[frame] that opened the connection. 0 for top-level frames, positive for child frames. This will only be set when tab is set.", "optional": true, "type": "integer" }, "id": { "description": "The ID of the extension or app that opened the connection, if any.", "optional": true, "type": "string" }, "tab": { "$ref": "tabs.Tab", "description": "The $(ref:tabs.Tab) which opened the connection, if any. This property will only be present when the connection was opened from a tab (including content scripts), and only if the receiver is an extension, not an app.", "optional": true }, "tlsChannelId": { "description": "The TLS channel ID of the page or frame that opened the connection, if requested by the extension or app, and if available.", "optional": true, "type": "string", "unsupported": true }, "url": { "description": "The URL of the page or frame that opened the connection. If the sender is in an iframe, it will be iframe's URL not the URL of the page which hosts it.", "optional": true, "type": "string" } }, "type": "object" }, { "allowedContexts": [ "content", "devtools" ], "description": "The operating system the browser is running on.", "enum": [ "mac", "win", "android", "cros", "linux", "openbsd" ], "id": "PlatformOs", "type": "string" }, { "allowedContexts": [ "content", "devtools" ], "description": "The machine's processor architecture.", "enum": [ "arm", "x86-32", "x86-64" ], "id": "PlatformArch", "type": "string" }, { "allowedContexts": [ "content", "devtools" ], "description": "An object containing information about the current platform.", "id": "PlatformInfo", "properties": { "arch": { "$ref": "PlatformArch", "description": "The machine's processor architecture." }, "nacl_arch": { "$ref": "PlatformNaclArch", "description": "The native client architecture. This may be different from arch on some platforms.", "unsupported": true }, "os": { "$ref": "PlatformOs", "description": "The operating system the browser is running on." } }, "type": "object" }, { "description": "An object containing information about the current browser.", "id": "BrowserInfo", "properties": { "buildID": { "description": "The browser's build ID/date, for example '20160101'.", "type": "string" }, "name": { "description": "The name of the browser, for example 'Firefox'.", "type": "string" }, "vendor": { "description": "The name of the browser vendor, for example 'Mozilla'.", "type": "string" }, "version": { "description": "The browser's version, for example '42.0.0' or '0.8.1pre'.", "type": "string" } }, "type": "object" }, { "allowedContexts": [ "content", "devtools" ], "description": "Result of the update check.", "enum": [ "throttled", "no_update", "update_available" ], "id": "RequestUpdateCheckStatus", "type": "string" }, { "allowedContexts": [ "content", "devtools" ], "description": "The reason that this event is being dispatched.", "enum": [ "install", "update", "browser_update" ], "id": "OnInstalledReason", "type": "string" }, { "allowedContexts": [ "content", "devtools" ], "description": "The reason that the event is being dispatched. 'app_update' is used when the restart is needed because the application is updated to a newer version. 'os_update' is used when the restart is needed because the browser/OS is updated to a newer version. 'periodic' is used when the system runs for more than the permitted uptime set in the enterprise policy.", "enum": [ "app_update", "os_update", "periodic" ], "id": "OnRestartRequiredReason", "type": "string" } ] }, { "description": "Use the chrome.sessions API to query and restore tabs and windows from a browsing session.", "events": [ { "description": "Fired when recently closed tabs and/or windows are changed. This event does not monitor synced sessions changes.", "name": "onChanged", "type": "function" } ], "functions": [ { "async": true, "description": "Forget a recently closed tab.", "name": "forgetClosedTab", "parameters": [ { "description": "The windowId of the window to which the recently closed tab to be forgotten belongs.", "name": "windowId", "type": "integer" }, { "description": "The sessionId (closedId) of the recently closed tab to be forgotten.", "name": "sessionId", "type": "string" } ], "type": "function" }, { "async": true, "description": "Forget a recently closed window.", "name": "forgetClosedWindow", "parameters": [ { "description": "The sessionId (closedId) of the recently closed window to be forgotten.", "name": "sessionId", "type": "string" } ], "type": "function" }, { "async": "callback", "description": "Gets the list of recently closed tabs and/or windows.", "name": "getRecentlyClosed", "parameters": [ { "$ref": "Filter", "default": {}, "name": "filter", "optional": true }, { "name": "callback", "parameters": [ { "description": "The list of closed entries in reverse order that they were closed (the most recently closed tab or window will be at index 0). The entries may contain either tabs or windows.", "items": { "$ref": "Session" }, "name": "sessions", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves all devices with synced sessions.", "name": "getDevices", "parameters": [ { "$ref": "Filter", "name": "filter", "optional": true }, { "name": "callback", "parameters": [ { "description": "The list of $(ref:sessions.Device) objects for each synced session, sorted in order from device with most recently modified session to device with least recently modified session. $(ref:tabs.Tab) objects are sorted by recency in the $(ref:windows.Window) of the $(ref:sessions.Session) objects.", "items": { "$ref": "Device" }, "name": "devices", "type": "array" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Reopens a $(ref:windows.Window) or $(ref:tabs.Tab), with an optional callback to run when the entry has been restored.", "name": "restore", "parameters": [ { "description": "The $(ref:windows.Window.sessionId), or $(ref:tabs.Tab.sessionId) to restore. If this parameter is not specified, the most recently closed session is restored.", "name": "sessionId", "optional": true, "type": "string" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "Session", "description": "A $(ref:sessions.Session) containing the restored $(ref:windows.Window) or $(ref:tabs.Tab) object.", "name": "restoredSession" } ], "type": "function" } ], "type": "function" }, { "async": true, "description": "Set a key/value pair on a given tab.", "name": "setTabValue", "parameters": [ { "description": "The id of the tab that the key/value pair is being set on.", "minimum": 0, "name": "tabId", "type": "integer" }, { "description": "The key which corresponds to the value being set.", "name": "key", "type": "string" }, { "description": "The value being set.", "name": "value", "type": "any" } ], "type": "function" }, { "async": true, "description": "Retrieve a value that was set for a given key on a given tab.", "name": "getTabValue", "parameters": [ { "description": "The id of the tab whose value is being retrieved from.", "minimum": 0, "name": "tabId", "type": "integer" }, { "description": "The key which corresponds to the value.", "name": "key", "type": "string" } ], "type": "function" }, { "async": true, "description": "Remove a key/value pair that was set on a given tab.", "name": "removeTabValue", "parameters": [ { "description": "The id of the tab whose key/value pair is being removed.", "minimum": 0, "name": "tabId", "type": "integer" }, { "description": "The key which corresponds to the value.", "name": "key", "type": "string" } ], "type": "function" }, { "async": true, "description": "Set a key/value pair on a given window.", "name": "setWindowValue", "parameters": [ { "description": "The id of the window that the key/value pair is being set on.", "minimum": -2, "name": "windowId", "type": "integer" }, { "description": "The key which corresponds to the value being set.", "name": "key", "type": "string" }, { "description": "The value being set.", "name": "value", "type": "any" } ], "type": "function" }, { "async": true, "description": "Retrieve a value that was set for a given key on a given window.", "name": "getWindowValue", "parameters": [ { "description": "The id of the window whose value is being retrieved from.", "minimum": -2, "name": "windowId", "type": "integer" }, { "description": "The key which corresponds to the value.", "name": "key", "type": "string" } ], "type": "function" }, { "async": true, "description": "Remove a key/value pair that was set on a given window.", "name": "removeWindowValue", "parameters": [ { "description": "The id of the window whose key/value pair is being removed.", "minimum": -2, "name": "windowId", "type": "integer" }, { "description": "The key which corresponds to the value.", "name": "key", "type": "string" } ], "type": "function" } ], "namespace": "sessions", "permissions": [ "sessions" ], "properties": { "MAX_SESSION_RESULTS": { "description": "The maximum number of $(ref:sessions.Session) that will be included in a requested list.", "value": 25 } }, "types": [ { "id": "Filter", "properties": { "maxResults": { "description": "The maximum number of entries to be fetched in the requested list. Omit this parameter to fetch the maximum number of entries ($(ref:sessions.MAX_SESSION_RESULTS)).", "maximum": 25, "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" }, { "id": "Session", "properties": { "lastModified": { "description": "The time when the window or tab was closed or modified, represented in milliseconds since the epoch.", "type": "integer" }, "tab": { "$ref": "tabs.Tab", "description": "The $(ref:tabs.Tab), if this entry describes a tab. Either this or $(ref:sessions.Session.window) will be set.", "optional": true }, "window": { "$ref": "windows.Window", "description": "The $(ref:windows.Window), if this entry describes a window. Either this or $(ref:sessions.Session.tab) will be set.", "optional": true } }, "type": "object" }, { "id": "Device", "properties": { "deviceName": { "description": "The name of the foreign device.", "type": "string" }, "info": { "type": "string" }, "sessions": { "description": "A list of open window sessions for the foreign device, sorted from most recently to least recently modified session.", "items": { "$ref": "Session" }, "type": "array" } }, "type": "object" } ] }, { "description": "Use sidebar actions to add a sidebar to Firefox.", "functions": [ { "async": true, "description": "Sets the title of the sidebar action. This shows up in the tooltip.", "name": "setTitle", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Sets the sidebar title for the tab specified by tabId. Automatically resets when the tab is closed.", "optional": true, "type": "integer" }, "title": { "description": "The string the sidebar action should display when moused over.", "type": "string" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Gets the title of the sidebar action.", "name": "getTitle", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the title from. If no tab is specified, the non-tab-specific title is returned.", "optional": true, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Sets the icon for the sidebar action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the path or the imageData property must be specified.", "name": "setIcon", "parameters": [ { "name": "details", "properties": { "imageData": { "choices": [ { "$ref": "ImageDataType" }, { "additionalProperties": false, "patternProperties": { "^[1-9]\\d*$": { "$ref": "ImageDataType" } }, "type": "object" } ], "description": "Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}'", "optional": true }, "path": { "choices": [ { "type": "string" }, { "additionalProperties": { "type": "string" }, "type": "object" } ], "description": "Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'", "optional": true }, "tabId": { "description": "Sets the sidebar icon for the tab specified by tabId. Automatically resets when the tab is closed.", "optional": true, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Sets the url to the html document to be opened in the sidebar when the user clicks on the sidebar action's icon.", "name": "setPanel", "parameters": [ { "name": "details", "properties": { "panel": { "description": "The url to the html file to show in a sidebar. If set to the empty string (''), no sidebar is shown.", "type": "string" }, "tabId": { "description": "Sets the sidebar url for the tab specified by tabId. Automatically resets when the tab is closed.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Gets the url to the html document set as the panel for this sidebar action.", "name": "getPanel", "parameters": [ { "name": "details", "properties": { "tabId": { "description": "Specify the tab to get the sidebar from. If no tab is specified, the non-tab-specific sidebar is returned.", "optional": true, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "async": true, "description": "Opens the extension sidebar in the active window.", "name": "open", "parameters": [], "requireUserInput": true, "type": "function" }, { "async": true, "description": "Closes the extension sidebar in the active window if the sidebar belongs to the extension.", "name": "close", "parameters": [], "requireUserInput": true, "type": "function" } ], "namespace": "sidebarAction", "permissions": [ "manifest:sidebar_action" ], "types": [ { "additionalProperties": { "type": "any" }, "description": "Pixel data for an image. Must be an ImageData object (for example, from a canvas element).", "id": "ImageDataType", "isInstanceOf": "ImageData", "postprocess": "convertImageDataToURL", "type": "object" } ] }, { "allowedContexts": [ "content", "devtools" ], "defaultContexts": [ "content", "devtools" ], "description": "Use the browser.storage API to store, retrieve, and track changes to user data.", "events": [ { "description": "Fired when one or more items change.", "name": "onChanged", "parameters": [ { "additionalProperties": { "$ref": "StorageChange" }, "description": "Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item.", "name": "changes", "type": "object" }, { "description": "The name of the storage area (\"sync\", \"local\" or \"managed\") the changes are for.", "name": "areaName", "type": "string" } ], "type": "function" } ], "namespace": "storage", "permissions": [ "storage" ], "properties": { "local": { "$ref": "StorageArea", "description": "Items in the local storage area are local to each machine.", "properties": { "QUOTA_BYTES": { "description": "The maximum amount (in bytes) of data that can be stored in local storage, as measured by the JSON stringification of every value plus every key's length. This value will be ignored if the extension has the unlimitedStorage permission. Updates that would cause this limit to be exceeded fail immediately and set $(ref:runtime.lastError).", "value": 5242880 } } }, "managed": { "$ref": "StorageArea", "description": "Items in the managed storage area are set by administrators or native applications, and are read-only for the extension; trying to modify this namespace results in an error.", "properties": { "QUOTA_BYTES": { "description": "The maximum size (in bytes) of the managed storage JSON manifest file. Files larger than this limit will fail to load.", "value": 5242880 } } }, "sync": { "$ref": "StorageArea", "description": "Items in the sync storage area are synced by the browser.", "properties": { "MAX_ITEMS": { "description": "The maximum number of items that can be stored in sync storage. Updates that would cause this limit to be exceeded will fail immediately and set $(ref:runtime.lastError).", "value": 512 }, "MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE": { "deprecated": "The storage.sync API no longer has a sustained write operation quota.", "description": "", "value": 1000000 }, "MAX_WRITE_OPERATIONS_PER_HOUR": { "description": "

The maximum number of set, remove, or clear operations that can be performed each hour. This is 1 every 2 seconds, a lower ceiling than the short term higher writes-per-minute limit.

Updates that would cause this limit to be exceeded fail immediately and set $(ref:runtime.lastError).

", "value": 1800 }, "MAX_WRITE_OPERATIONS_PER_MINUTE": { "description": "

The maximum number of set, remove, or clear operations that can be performed each minute. This is 2 per second, providing higher throughput than writes-per-hour over a shorter period of time.

Updates that would cause this limit to be exceeded fail immediately and set $(ref:runtime.lastError).

", "value": 120 }, "QUOTA_BYTES": { "description": "The maximum total amount (in bytes) of data that can be stored in sync storage, as measured by the JSON stringification of every value plus every key's length. Updates that would cause this limit to be exceeded fail immediately and set $(ref:runtime.lastError).", "value": 102400 }, "QUOTA_BYTES_PER_ITEM": { "description": "The maximum size (in bytes) of each individual item in sync storage, as measured by the JSON stringification of its value plus its key length. Updates containing items larger than this limit will fail immediately and set $(ref:runtime.lastError).", "value": 8192 } } } }, "types": [ { "id": "StorageChange", "properties": { "newValue": { "description": "The new value of the item, if there is a new value.", "optional": true, "type": "any" }, "oldValue": { "description": "The old value of the item, if there was an old value.", "optional": true, "type": "any" } }, "type": "object" }, { "functions": [ { "async": "callback", "description": "Gets one or more items from storage.", "name": "get", "parameters": [ { "choices": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "additionalProperties": { "type": "any" }, "description": "Storage items to return in the callback, where the values are replaced with those from storage if they exist.", "type": "object" } ], "description": "A single key to get, list of keys to get, or a dictionary specifying default values (see description of the object). An empty list or object will return an empty result object. Pass in null to get the entire contents of storage.", "name": "keys", "optional": true }, { "description": "Callback with storage items, or on failure (in which case $(ref:runtime.lastError) will be set).", "name": "callback", "parameters": [ { "additionalProperties": { "type": "any" }, "description": "Object with items in their key-value mappings.", "name": "items", "type": "object" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the amount of space (in bytes) being used by one or more items.", "name": "getBytesInUse", "parameters": [ { "choices": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "description": "A single key or list of keys to get the total usage for. An empty list will return 0. Pass in null to get the total usage of all of storage.", "name": "keys", "optional": true }, { "description": "Callback with the amount of space being used by storage, or on failure (in which case $(ref:runtime.lastError) will be set).", "name": "callback", "parameters": [ { "description": "Amount of space being used in storage, in bytes.", "name": "bytesInUse", "type": "integer" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Sets multiple items.", "name": "set", "parameters": [ { "additionalProperties": { "type": "any" }, "description": "

An object which gives each key/value pair to update storage with. Any other key/value pairs in storage will not be affected.

Primitive values such as numbers will serialize as expected. Values with a typeof \"object\" and \"function\" will typically serialize to {}, with the exception of Array (serializes as expected), Date, and Regex (serialize using their String representation).

", "name": "items", "type": "object" }, { "description": "Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes one or more items from storage.", "name": "remove", "parameters": [ { "choices": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "description": "A single key or a list of keys for items to remove.", "name": "keys" }, { "description": "Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes all items from storage.", "name": "clear", "parameters": [ { "description": "Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" } ], "id": "StorageArea", "type": "object" } ] }, { "description": "Use the browser.tabs API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser.", "events": [ { "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.", "name": "onCreated", "parameters": [ { "$ref": "Tab", "description": "Details of the tab that was created.", "name": "tab" } ], "type": "function" }, { "description": "Fired when a tab is updated.", "name": "onUpdated", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "description": "Lists the changes to the state of the tab that was updated.", "name": "changeInfo", "properties": { "audible": { "description": "The tab's new audible state.", "optional": true, "type": "boolean" }, "discarded": { "description": "True while the tab is not loaded with content.", "optional": true, "type": "boolean" }, "favIconUrl": { "description": "The tab's new favicon URL.", "optional": true, "type": "string" }, "mutedInfo": { "$ref": "MutedInfo", "description": "The tab's new muted state and the reason for the change.", "optional": true }, "pinned": { "description": "The tab's new pinned state.", "optional": true, "type": "boolean" }, "status": { "description": "The status of the tab. Can be either loading or complete.", "optional": true, "type": "string" }, "url": { "description": "The tab's URL if it has changed.", "optional": true, "type": "string" } }, "type": "object" }, { "$ref": "Tab", "description": "Gives the state of the tab that was updated.", "name": "tab" } ], "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).", "name": "onMoved", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "moveInfo", "properties": { "fromIndex": { "minimum": 0, "type": "integer" }, "toIndex": { "minimum": 0, "type": "integer" }, "windowId": { "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "deprecated": "Please use $(ref:tabs.onActivated).", "description": "Fires when the selected tab in a window changes.", "name": "onSelectionChanged", "parameters": [ { "description": "The ID of the tab that has become active.", "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "selectInfo", "properties": { "windowId": { "description": "The ID of the window the selected tab changed inside of.", "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function", "unsupported": true }, { "deprecated": "Please use $(ref:tabs.onActivated).", "description": "Fires when the selected 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 $(ref:tabs.onUpdated) events to be notified when a URL is set.", "name": "onActiveChanged", "parameters": [ { "description": "The ID of the tab that has become active.", "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "selectInfo", "properties": { "windowId": { "description": "The ID of the window the selected tab changed inside of.", "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function", "unsupported": true }, { "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.", "name": "onActivated", "parameters": [ { "name": "activeInfo", "properties": { "tabId": { "description": "The ID of the tab that has become active.", "minimum": 0, "type": "integer" }, "windowId": { "description": "The ID of the window the active tab changed inside of.", "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "deprecated": "Please use $(ref:tabs.onHighlighted).", "description": "Fired when the highlighted or selected tabs in a window changes.", "name": "onHighlightChanged", "parameters": [ { "name": "selectInfo", "properties": { "tabIds": { "description": "All highlighted tabs in the window.", "items": { "minimum": 0, "type": "integer" }, "type": "array" }, "windowId": { "description": "The window whose tabs changed.", "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function", "unsupported": true }, { "description": "Fired when the highlighted or selected tabs in a window changes.", "name": "onHighlighted", "parameters": [ { "name": "highlightInfo", "properties": { "tabIds": { "description": "All highlighted tabs in the window.", "items": { "minimum": 0, "type": "integer" }, "type": "array" }, "windowId": { "description": "The window whose tabs changed.", "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a tab is detached from a window, for example because it is being moved between windows.", "name": "onDetached", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "detachInfo", "properties": { "oldPosition": { "minimum": 0, "type": "integer" }, "oldWindowId": { "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a tab is attached to a window, for example because it was moved between windows.", "name": "onAttached", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "attachInfo", "properties": { "newPosition": { "minimum": 0, "type": "integer" }, "newWindowId": { "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a tab is closed.", "name": "onRemoved", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "removeInfo", "properties": { "isWindowClosing": { "description": "True when the tab is being closed because its window is being closed.", "type": "boolean" }, "windowId": { "description": "The window whose tab is closed.", "minimum": 0, "type": "integer" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a tab is replaced with another tab due to prerendering or instant.", "name": "onReplaced", "parameters": [ { "minimum": 0, "name": "addedTabId", "type": "integer" }, { "minimum": 0, "name": "removedTabId", "type": "integer" } ], "type": "function" }, { "description": "Fired when a tab is zoomed.", "name": "onZoomChange", "parameters": [ { "name": "ZoomChangeInfo", "properties": { "newZoomFactor": { "type": "number" }, "oldZoomFactor": { "type": "number" }, "tabId": { "minimum": 0, "type": "integer" }, "zoomSettings": { "$ref": "ZoomSettings" } }, "type": "object" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Retrieves details about the specified tab.", "name": "get", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "callback", "parameters": [ { "$ref": "Tab", "name": "tab" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "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).", "name": "getCurrent", "parameters": [ { "name": "callback", "parameters": [ { "$ref": "Tab", "name": "tab", "optional": true } ], "type": "function" } ], "type": "function" }, { "description": "Connects to the content script(s) in the specified tab. The $(ref:runtime.onConnect) event is fired in each content script running in the specified tab for the current extension. For more details, see $(topic:messaging)[Content Script Messaging].", "name": "connect", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "connectInfo", "optional": true, "properties": { "frameId": { "description": "Open a port to a specific $(topic:frame_ids)[frame] identified by frameId instead of all frames in the tab.", "minimum": 0, "optional": true, "type": "integer" }, "name": { "description": "Will be passed into onConnect for content scripts that are listening for the connection event.", "optional": true, "type": "string" } }, "type": "object" } ], "returns": { "$ref": "runtime.Port", "description": "A port that can be used to communicate with the content scripts running in the specified tab. The port's $(ref:runtime.Port) event is fired if the tab closes or does not exist. " }, "type": "function" }, { "deprecated": "Please use $(ref:runtime.sendMessage).", "description": "Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The $(ref:extension.onRequest) event is fired in each content script running in the specified tab for the current extension.", "name": "sendRequest", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "request", "type": "any" }, { "name": "responseCallback", "optional": true, "parameters": [ { "description": "The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and $(ref:runtime.lastError) will be set to the error message.", "name": "response", "type": "any" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "responseCallback", "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 $(ref:runtime.onMessage) event is fired in each content script running in the specified tab for the current extension.", "name": "sendMessage", "parameters": [ { "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "message", "type": "any" }, { "name": "options", "optional": true, "properties": { "frameId": { "description": "Send a message to a specific $(topic:frame_ids)[frame] identified by frameId instead of all frames in the tab.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "responseCallback", "optional": true, "parameters": [ { "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 $(ref:runtime.lastError) will be set to the error message.", "name": "response", "type": "any" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "deprecated": "Please use $(ref:tabs.query) {active: true}.", "description": "Gets the tab that is selected in the specified window.", "name": "getSelected", "parameters": [ { "description": "Defaults to the $(topic:current-window)[current window].", "minimum": -2, "name": "windowId", "optional": true, "type": "integer" }, { "name": "callback", "parameters": [ { "$ref": "Tab", "name": "tab" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "deprecated": "Please use $(ref:tabs.query) {windowId: windowId}.", "description": "Gets details about all tabs in the specified window.", "name": "getAllInWindow", "parameters": [ { "description": "Defaults to the $(topic:current-window)[current window].", "minimum": -2, "name": "windowId", "optional": true, "type": "integer" }, { "name": "callback", "parameters": [ { "items": { "$ref": "Tab" }, "name": "tabs", "type": "array" } ], "type": "function" } ], "type": "function", "unsupported": true }, { "async": "callback", "description": "Creates a new tab.", "name": "create", "parameters": [ { "name": "createProperties", "properties": { "active": { "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 true.", "optional": true, "type": "boolean" }, "cookieStoreId": { "description": "The CookieStoreId for the tab that opened this tab.", "optional": true, "type": "string" }, "index": { "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.", "minimum": 0, "optional": true, "type": "integer" }, "openInReaderMode": { "description": "Whether the document in the tab should be opened in reader mode.", "optional": true, "type": "boolean" }, "openerTabId": { "description": "The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as the newly created tab.", "minimum": 0, "optional": true, "type": "integer" }, "pinned": { "description": "Whether the tab should be pinned. Defaults to false", "optional": true, "type": "boolean" }, "selected": { "deprecated": "Please use active.", "description": "Whether the tab should become the selected tab in the window. Defaults to true", "optional": true, "type": "boolean", "unsupported": true }, "url": { "description": "The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.", "optional": true, "type": "string" }, "windowId": { "description": "The window to create the new tab in. Defaults to the $(topic:current-window)[current window].", "minimum": -2, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "Tab", "description": "Details about the created tab. Will contain the ID of the new tab.", "name": "tab", "optional": true } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Duplicates a tab.", "name": "duplicate", "parameters": [ { "description": "The ID of the tab which is to be duplicated.", "minimum": 0, "name": "tabId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "Tab", "description": "Details about the duplicated tab. The $(ref:tabs.Tab) object doesn't contain url, title and favIconUrl if the \"tabs\" permission has not been requested.", "name": "tab", "optional": true } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets all tabs that have the specified properties, or all tabs if no properties are specified.", "name": "query", "parameters": [ { "name": "queryInfo", "properties": { "active": { "description": "Whether the tabs are active in their windows.", "optional": true, "type": "boolean" }, "audible": { "description": "Whether the tabs are audible.", "optional": true, "type": "boolean" }, "cookieStoreId": { "description": "The CookieStoreId used for the tab.", "optional": true, "type": "string" }, "currentWindow": { "description": "Whether the tabs are in the $(topic:current-window)[current window].", "optional": true, "type": "boolean" }, "discarded": { "description": "True while the tabs are not loaded with content.", "optional": true, "type": "boolean" }, "highlighted": { "description": "Whether the tabs are highlighted. Works as an alias of active.", "optional": true, "type": "boolean" }, "index": { "description": "The position of the tabs within their windows.", "minimum": 0, "optional": true, "type": "integer" }, "lastFocusedWindow": { "description": "Whether the tabs are in the last focused window.", "optional": true, "type": "boolean" }, "muted": { "description": "Whether the tabs are muted.", "optional": true, "type": "boolean" }, "openerTabId": { "description": "The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as this tab.", "minimum": 0, "optional": true, "type": "integer" }, "pinned": { "description": "Whether the tabs are pinned.", "optional": true, "type": "boolean" }, "status": { "$ref": "TabStatus", "description": "Whether the tabs have completed loading.", "optional": true }, "title": { "description": "Match page titles against a pattern.", "optional": true, "type": "string" }, "url": { "choices": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "description": "Match tabs against one or more $(topic:match_patterns)[URL patterns]. Note that fragment identifiers are not matched.", "optional": true }, "windowId": { "description": "The ID of the parent window, or $(ref:windows.WINDOW_ID_CURRENT) for the $(topic:current-window)[current window].", "minimum": -2, "optional": true, "type": "integer" }, "windowType": { "$ref": "WindowType", "description": "The type of window the tabs are in.", "optional": true } }, "type": "object" }, { "name": "callback", "parameters": [ { "items": { "$ref": "Tab" }, "name": "result", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Highlights the given tabs.", "name": "highlight", "parameters": [ { "name": "highlightInfo", "properties": { "tabs": { "choices": [ { "items": { "minimum": 0, "type": "integer" }, "type": "array" }, { "type": "integer" } ], "description": "One or more tab indices to highlight." }, "windowId": { "description": "The window that contains the tabs.", "minimum": -2, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "windows.Window", "description": "Contains details about the window whose tabs were highlighted.", "name": "window" } ], "type": "function" } ], "type": "function", "unsupported": "true" }, { "async": "callback", "description": "Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.", "name": "update", "parameters": [ { "description": "Defaults to the selected tab of the $(topic:current-window)[current window].", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "name": "updateProperties", "properties": { "active": { "description": "Whether the tab should be active. Does not affect whether the window is focused (see $(ref:windows.update)).", "optional": true, "type": "boolean" }, "highlighted": { "description": "Adds or removes the tab from the current selection.", "optional": true, "type": "boolean", "unsupported": true }, "loadReplace": { "description": "Whether the load should replace the current history entry for the tab.", "optional": true, "type": "boolean" }, "muted": { "description": "Whether the tab should be muted.", "optional": true, "type": "boolean" }, "openerTabId": { "description": "The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as this tab.", "minimum": 0, "optional": true, "type": "integer" }, "pinned": { "description": "Whether the tab should be pinned.", "optional": true, "type": "boolean" }, "selected": { "deprecated": "Please use highlighted.", "description": "Whether the tab should be selected.", "optional": true, "type": "boolean", "unsupported": true }, "url": { "description": "A URL to navigate the tab to.", "optional": true, "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "Tab", "description": "Details about the updated tab. The $(ref:tabs.Tab) object doesn't contain url, title and favIconUrl if the \"tabs\" permission has not been requested.", "name": "tab", "optional": true } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === \"normal\") windows.", "name": "move", "parameters": [ { "choices": [ { "minimum": 0, "type": "integer" }, { "items": { "minimum": 0, "type": "integer" }, "type": "array" } ], "description": "The tab or list of tabs to move.", "name": "tabIds" }, { "name": "moveProperties", "properties": { "index": { "description": "The position to move the window to. -1 will place the tab at the end of the window.", "minimum": -1, "type": "integer" }, "windowId": { "description": "Defaults to the window the tab is currently in.", "minimum": -2, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "choices": [ { "$ref": "Tab" }, { "items": { "$ref": "Tab" }, "type": "array" } ], "description": "Details about the moved tabs.", "name": "tabs" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Reload a tab.", "name": "reload", "parameters": [ { "description": "The ID of the tab to reload; defaults to the selected tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "name": "reloadProperties", "optional": true, "properties": { "bypassCache": { "description": "Whether using any local cache. Default is false.", "optional": true, "type": "boolean" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Closes one or more tabs.", "name": "remove", "parameters": [ { "choices": [ { "minimum": 0, "type": "integer" }, { "items": { "minimum": 0, "type": "integer" }, "type": "array" } ], "description": "The tab or list of tabs to close.", "name": "tabIds" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": true, "description": "discards one or more tabs.", "name": "discard", "parameters": [ { "choices": [ { "minimum": 0, "type": "integer" }, { "items": { "minimum": 0, "type": "integer" }, "type": "array" } ], "description": "The tab or list of tabs to discard.", "name": "tabIds" } ], "type": "function" }, { "async": "callback", "description": "Detects the primary language of the content in a tab.", "name": "detectLanguage", "parameters": [ { "description": "Defaults to the active tab of the $(topic:current-window)[current window].", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "name": "callback", "parameters": [ { "description": "An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. The 2nd to 4th columns will be checked and the first non-NULL value will be returned except for Simplified Chinese for which zh-CN will be returned. For an unknown language, und will be returned.", "name": "language", "type": "string" } ], "type": "function" } ], "type": "function" }, { "async": true, "description": "Toggles reader mode for the document in the tab.", "name": "toggleReaderMode", "parameters": [ { "description": "Defaults to the active tab of the $(topic:current-window)[current window].", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" } ], "type": "function" }, { "async": "callback", "description": "Captures the visible area of the currently active tab in the specified window. You must have $(topic:declare_permissions)[<all_urls>] permission to use this method.", "name": "captureVisibleTab", "parameters": [ { "description": "The target window. Defaults to the $(topic:current-window)[current window].", "minimum": -2, "name": "windowId", "optional": true, "type": "integer" }, { "$ref": "extensionTypes.ImageDetails", "name": "options", "optional": true }, { "name": "callback", "parameters": [ { "description": "A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.", "name": "dataUrl", "type": "string" } ], "type": "function" } ], "permissions": [ "" ], "type": "function" }, { "async": "callback", "description": "Injects JavaScript code into a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.", "name": "executeScript", "parameters": [ { "description": "The ID of the tab in which to run the script; defaults to the active tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "$ref": "extensionTypes.InjectDetails", "description": "Details of the script to run.", "name": "details" }, { "description": "Called after all the JavaScript has been executed.", "name": "callback", "optional": true, "parameters": [ { "description": "The result of the script in every injected frame.", "items": { "type": "any" }, "name": "result", "optional": true, "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Injects CSS into a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.", "name": "insertCSS", "parameters": [ { "description": "The ID of the tab in which to insert the CSS; defaults to the active tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "$ref": "extensionTypes.InjectDetails", "description": "Details of the CSS text to insert.", "name": "details" }, { "description": "Called when all the CSS has been inserted.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes injected CSS from a page. For details, see the $(topic:content_scripts)[programmatic injection] section of the content scripts doc.", "name": "removeCSS", "parameters": [ { "description": "The ID of the tab from which to remove the injected CSS; defaults to the active tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "$ref": "extensionTypes.InjectDetails", "description": "Details of the CSS text to remove.", "name": "details" }, { "description": "Called when all the CSS has been removed.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Zooms a specified tab.", "name": "setZoom", "parameters": [ { "description": "The ID of the tab to zoom; defaults to the active tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "description": "The new zoom factor. Use a value of 0 here to set the tab to its current default zoom factor. Values greater than zero specify a (possibly non-default) zoom factor for the tab.", "name": "zoomFactor", "type": "number" }, { "description": "Called after the zoom factor has been changed.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the current zoom factor of a specified tab.", "name": "getZoom", "parameters": [ { "description": "The ID of the tab to get the current zoom factor from; defaults to the active tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "description": "Called with the tab's current zoom factor after it has been fetched.", "name": "callback", "parameters": [ { "description": "The tab's current zoom factor.", "name": "zoomFactor", "type": "number" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets the zoom settings for a specified tab, which define how zoom changes are handled. These settings are reset to defaults upon navigating the tab.", "name": "setZoomSettings", "parameters": [ { "description": "The ID of the tab to change the zoom settings for; defaults to the active tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "$ref": "ZoomSettings", "description": "Defines how zoom changes are handled and at what scope.", "name": "zoomSettings" }, { "description": "Called after the zoom settings have been changed.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the current zoom settings of a specified tab.", "name": "getZoomSettings", "parameters": [ { "description": "The ID of the tab to get the current zoom settings from; defaults to the active tab of the current window.", "minimum": 0, "name": "tabId", "optional": true, "type": "integer" }, { "description": "Called with the tab's current zoom settings.", "name": "callback", "parameters": [ { "$ref": "ZoomSettings", "description": "The tab's current zoom settings.", "name": "zoomSettings" } ], "type": "function" } ], "type": "function" }, { "description": "Prints page in active tab.", "name": "print", "parameters": [], "type": "function" }, { "async": "callback", "description": "Shows print preview for page in active tab.", "name": "printPreview", "parameters": [ { "description": "Called after print preview entered.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Saves page in active tab as a PDF file.", "name": "saveAsPDF", "parameters": [ { "$ref": "PageSettings", "description": "The page settings used to save the PDF file.", "name": "pageSettings" }, { "description": "Called after save as dialog closed.", "name": "callback", "optional": true, "parameters": [ { "description": "Save status: saved, replaced, canceled, not_saved, not_replaced.", "name": "status", "type": "string" } ], "type": "function" } ], "type": "function" } ], "namespace": "tabs", "properties": { "TAB_ID_NONE": { "description": "An ID which represents the absence of a browser tab.", "value": -1 } }, "types": [ { "description": "An event that caused a muted state change.", "enum": [ { "description": "A user input action has set/overridden the muted state.", "name": "user" }, { "description": "Tab capture started, forcing a muted state change.", "name": "capture" }, { "description": "An extension, identified by the extensionId field, set the muted state.", "name": "extension" } ], "id": "MutedInfoReason", "type": "string" }, { "description": "Tab muted state and the reason for the last state change.", "id": "MutedInfo", "properties": { "extensionId": { "description": "The ID of the extension that changed the muted state. Not set if an extension was not the reason the muted state last changed.", "optional": true, "type": "string" }, "muted": { "description": "Whether the tab is prevented from playing sound (but hasn't necessarily recently produced sound). Equivalent to whether the muted audio indicator is showing.", "type": "boolean" }, "reason": { "$ref": "MutedInfoReason", "description": "The reason the tab was muted or unmuted. Not set if the tab's mute state has never been changed.", "optional": true } }, "type": "object" }, { "id": "Tab", "properties": { "active": { "description": "Whether the tab is active in its window. (Does not necessarily mean the window is focused.)", "type": "boolean" }, "audible": { "description": "Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted). Equivalent to whether the speaker audio indicator is showing.", "optional": true, "type": "boolean" }, "cookieStoreId": { "description": "The CookieStoreId used for the tab.", "optional": true, "type": "string" }, "discarded": { "description": "True while the tab is not loaded with content.", "optional": true, "type": "boolean" }, "favIconUrl": { "description": "The URL of the tab's favicon. This property is only present if the extension's manifest includes the \"tabs\" permission. It may also be an empty string if the tab is loading.", "optional": true, "permissions": [ "tabs" ], "type": "string" }, "height": { "description": "The height of the tab in pixels.", "optional": true, "type": "integer" }, "highlighted": { "description": "Whether the tab is highlighted. Works as an alias of active", "type": "boolean" }, "id": { "description": "The ID of the tab. Tab IDs are unique within a browser session. Under some circumstances a Tab may not be assigned an ID, for example when querying foreign tabs using the $(ref:sessions) API, in which case a session ID may be present. Tab ID can also be set to $(ref:tabs.TAB_ID_NONE) for apps and devtools windows.", "minimum": -1, "optional": true, "type": "integer" }, "incognito": { "description": "Whether the tab is in an incognito window.", "type": "boolean" }, "index": { "description": "The zero-based index of the tab within its window.", "minimum": -1, "type": "integer" }, "isArticle": { "description": "Whether the document in the tab can be rendered in reader mode.", "optional": true, "type": "boolean" }, "isInReaderMode": { "description": "Whether the document in the tab is being rendered in reader mode.", "optional": true, "type": "boolean" }, "lastAccessed": { "description": "The last time the tab was accessed as the number of milliseconds since epoch.", "optional": true, "type": "integer" }, "mutedInfo": { "$ref": "MutedInfo", "description": "Current tab muted state and the reason for the last state change.", "optional": true }, "openerTabId": { "description": "The ID of the tab that opened this tab, if any. This property is only present if the opener tab still exists.", "minimum": 0, "optional": true, "type": "integer" }, "pinned": { "description": "Whether the tab is pinned.", "type": "boolean" }, "selected": { "deprecated": "Please use $(ref:tabs.Tab.highlighted).", "description": "Whether the tab is selected.", "type": "boolean", "unsupported": true }, "sessionId": { "description": "The session ID used to uniquely identify a Tab obtained from the $(ref:sessions) API.", "optional": true, "type": "string" }, "status": { "description": "Either loading or complete.", "optional": true, "type": "string" }, "title": { "description": "The title of the tab. This property is only present if the extension's manifest includes the \"tabs\" permission.", "optional": true, "permissions": [ "tabs" ], "type": "string" }, "url": { "description": "The URL the tab is displaying. This property is only present if the extension's manifest includes the \"tabs\" permission.", "optional": true, "permissions": [ "tabs" ], "type": "string" }, "width": { "description": "The width of the tab in pixels.", "optional": true, "type": "integer" }, "windowId": { "description": "The ID of the window the tab is contained within.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" }, { "description": "Defines how zoom changes are handled, i.e. which entity is responsible for the actual scaling of the page; defaults to automatic.", "enum": [ { "description": "Zoom changes are handled automatically by the browser.", "name": "automatic" }, { "description": "Overrides the automatic handling of zoom changes. The onZoomChange event will still be dispatched, and it is the responsibility of the extension to listen for this event and manually scale the page. This mode does not support per-origin zooming, and will thus ignore the scope zoom setting and assume per-tab.", "name": "manual" }, { "description": "Disables all zooming in the tab. The tab will revert to the default zoom level, and all attempted zoom changes will be ignored.", "name": "disabled" } ], "id": "ZoomSettingsMode", "type": "string" }, { "description": "Defines whether zoom changes will persist for the page's origin, or only take effect in this tab; defaults to per-origin when in automatic mode, and per-tab otherwise.", "enum": [ { "description": "Zoom changes will persist in the zoomed page's origin, i.e. all other tabs navigated to that same origin will be zoomed as well. Moreover, per-origin zoom changes are saved with the origin, meaning that when navigating to other pages in the same origin, they will all be zoomed to the same zoom factor. The per-origin scope is only available in the automatic mode.", "name": "per-origin" }, { "description": "Zoom changes only take effect in this tab, and zoom changes in other tabs will not affect the zooming of this tab. Also, per-tab zoom changes are reset on navigation; navigating a tab will always load pages with their per-origin zoom factors.", "name": "per-tab" } ], "id": "ZoomSettingsScope", "type": "string" }, { "description": "Defines how zoom changes in a tab are handled and at what scope.", "id": "ZoomSettings", "properties": { "defaultZoomFactor": { "description": "Used to return the default zoom level for the current tab in calls to tabs.getZoomSettings.", "optional": true, "type": "number" }, "mode": { "$ref": "ZoomSettingsMode", "description": "Defines how zoom changes are handled, i.e. which entity is responsible for the actual scaling of the page; defaults to automatic.", "optional": true }, "scope": { "$ref": "ZoomSettingsScope", "description": "Defines whether zoom changes will persist for the page's origin, or only take effect in this tab; defaults to per-origin when in automatic mode, and per-tab otherwise.", "optional": true } }, "type": "object" }, { "description": "The page settings including: orientation, scale, background, margins, headers, footers.", "id": "PageSettings", "properties": { "footerCenter": { "description": "The text for the page's center footer. Default: ''.", "optional": true, "type": "string" }, "footerLeft": { "description": "The text for the page's left footer. Default: '&PT'.", "optional": true, "type": "string" }, "footerRight": { "description": "The text for the page's right footer. Default: '&D'.", "optional": true, "type": "string" }, "headerCenter": { "description": "The text for the page's center header. Default: ''.", "optional": true, "type": "string" }, "headerLeft": { "description": "The text for the page's left header. Default: '&T'.", "optional": true, "type": "string" }, "headerRight": { "description": "The text for the page's right header. Default: '&U'.", "optional": true, "type": "string" }, "marginBottom": { "description": "The margin between the page content and the bottom edge of the paper (inches). Default: 0.5.", "optional": true, "type": "number" }, "marginLeft": { "description": "The margin between the page content and the left edge of the paper (inches). Default: 0.5.", "optional": true, "type": "number" }, "marginRight": { "description": "The margin between the page content and the right edge of the paper (inches). Default: 0.5.", "optional": true, "type": "number" }, "marginTop": { "description": "The margin between the page content and the top edge of the paper (inches). Default: 0.5.", "optional": true, "type": "number" }, "orientation": { "description": "The page content orientation: 0 = portrait, 1 = landscape. Default: 0.", "optional": true, "type": "integer" }, "paperHeight": { "description": "The paper height in paper size units. Default: 11.0.", "optional": true, "type": "number" }, "paperSizeUnit": { "description": "The page size unit: 0 = inches, 1 = millimeters. Default: 0.", "optional": true, "type": "integer" }, "paperWidth": { "description": "The paper width in paper size units. Default: 8.5.", "optional": true, "type": "number" }, "scaling": { "description": "The page content scaling factor: 1.0 = 100% = normal size. Default: 1.0.", "optional": true, "type": "number" }, "showBackgroundColors": { "description": "Whether the page background colors should be shown. Default: false.", "optional": true, "type": "boolean" }, "showBackgroundImages": { "description": "Whether the page background images should be shown. Default: false.", "optional": true, "type": "boolean" }, "shrinkToFit": { "description": "Whether the page content should shrink to fit the page width (overrides scaling). Default: true.", "optional": true, "type": "boolean" } }, "type": "object" }, { "description": "Whether the tabs have completed loading.", "enum": [ "loading", "complete" ], "id": "TabStatus", "type": "string" }, { "description": "The type of window.", "enum": [ "normal", "popup", "panel", "app", "devtools" ], "id": "WindowType", "type": "string" } ] }, { "allowedContexts": [ "content", "devtools" ], "defaultContexts": [ "content", "devtools" ], "description": "none", "events": [ { "description": "Used to test sending messages to extensions.", "name": "onMessage", "parameters": [ { "name": "message", "type": "string" }, { "name": "argument", "type": "any" } ], "type": "function" } ], "functions": [ { "description": "Notifies the browser process that test code running in the extension failed. This is only used for internal unit testing.", "name": "notifyFail", "parameters": [ { "name": "message", "type": "string" } ], "type": "function" }, { "description": "Notifies the browser process that test code running in the extension passed. This is only used for internal unit testing.", "name": "notifyPass", "parameters": [ { "name": "message", "optional": true, "type": "string" } ], "type": "function" }, { "description": "Logs a message during internal unit testing.", "name": "log", "parameters": [ { "name": "message", "type": "string" } ], "type": "function" }, { "allowAmbiguousOptionalArguments": true, "description": "Sends a string message to the browser process, generating a Notification that C++ test code can wait for.", "name": "sendMessage", "parameters": [ { "name": "arg1", "optional": true, "type": "any" }, { "name": "arg2", "optional": true, "type": "any" } ], "type": "function" }, { "name": "fail", "parameters": [ { "name": "message", "optional": true, "type": "any" } ], "type": "function" }, { "name": "succeed", "parameters": [ { "name": "message", "optional": true, "type": "any" } ], "type": "function" }, { "allowAmbiguousOptionalArguments": true, "name": "assertTrue", "parameters": [ { "name": "test", "optional": true, "type": "any" }, { "name": "message", "optional": true, "type": "string" } ], "type": "function" }, { "allowAmbiguousOptionalArguments": true, "name": "assertFalse", "parameters": [ { "name": "test", "optional": true, "type": "any" }, { "name": "message", "optional": true, "type": "string" } ], "type": "function" }, { "name": "assertBool", "parameters": [ { "choices": [ { "type": "string" }, { "type": "boolean" } ], "name": "test" }, { "name": "expected", "type": "boolean" }, { "name": "message", "optional": true, "type": "string" } ], "type": "function", "unsupported": true }, { "allowAmbiguousOptionalArguments": true, "name": "checkDeepEq", "parameters": [ { "name": "expected", "type": "any" }, { "name": "actual", "type": "any" } ], "type": "function", "unsupported": true }, { "allowAmbiguousOptionalArguments": true, "name": "assertEq", "parameters": [ { "name": "expected", "optional": true, "type": "any" }, { "name": "actual", "optional": true, "type": "any" }, { "name": "message", "optional": true, "type": "string" } ], "type": "function" }, { "name": "assertNoLastError", "parameters": [], "type": "function", "unsupported": true }, { "name": "assertLastError", "parameters": [ { "name": "expectedError", "type": "string" } ], "type": "function", "unsupported": true }, { "async": true, "name": "assertRejects", "parameters": [ { "$ref": "Promise", "name": "promise" }, { "$ref": "ExpectedError", "name": "expectedError", "optional": true }, { "name": "message", "optional": true, "type": "string" } ], "type": "function" }, { "name": "assertThrows", "parameters": [ { "name": "func", "type": "function" }, { "$ref": "ExpectedError", "name": "expectedError", "optional": true }, { "name": "message", "optional": true, "type": "string" } ], "type": "function" } ], "namespace": "test", "types": [ { "choices": [ { "type": "string" }, { "additionalProperties": true, "isInstanceOf": "RegExp", "type": "object" }, { "type": "function" } ], "id": "ExpectedError" }, { "choices": [ { "additionalProperties": true, "properties": { "then": { "type": "function" } }, "type": "object" }, { "additionalProperties": true, "isInstanceOf": "Promise", "type": "object" } ], "id": "Promise" } ] }, { "description": "The theme API allows customizing of visual elements of the browser.", "events": [ { "description": "Fired when a new theme has been applied", "name": "onUpdated", "parameters": [ { "$ref": "ThemeUpdateInfo", "description": "Details of the theme update", "name": "updateInfo" } ], "type": "function" } ], "functions": [ { "async": true, "description": "Returns the current theme for the specified window or the last focused window.", "name": "getCurrent", "parameters": [ { "description": "The window for which we want the theme.", "name": "windowId", "optional": true, "type": "integer" } ], "type": "function" }, { "async": true, "description": "Make complete updates to the theme. Resolves when the update has completed.", "name": "update", "parameters": [ { "description": "The id of the window to update. No id updates all windows.", "name": "windowId", "optional": true, "type": "integer" }, { "$ref": "manifest.ThemeType", "description": "The properties of the theme to update.", "name": "details" } ], "type": "function" }, { "async": true, "description": "Removes the updates made to the theme.", "name": "reset", "parameters": [ { "description": "The id of the window to reset. No id resets all windows.", "name": "windowId", "optional": true, "type": "integer" } ], "type": "function" } ], "namespace": "theme", "permissions": [ "theme" ], "types": [ { "description": "Info provided in the onUpdated listener.", "id": "ThemeUpdateInfo", "properties": { "theme": { "description": "The new theme after update", "type": "object" }, "windowId": { "description": "The id of the window the theme has been applied to", "optional": true, "type": "integer" } }, "type": "object" } ] }, { "description": "Use the chrome.topSites API to access the top sites that are displayed on the new tab page. ", "functions": [ { "async": "callback", "description": "Gets a list of top sites.", "name": "get", "parameters": [ { "name": "options", "optional": true, "properties": { "providers": { "description": "Which providers to get top sites from. Possible values are \"places\" and \"activityStream\".", "items": { "type": "string" }, "optional": true, "type": "array" } }, "type": "object" }, { "name": "callback", "parameters": [ { "items": { "$ref": "MostVisitedURL" }, "name": "results", "type": "array" } ], "type": "function" } ], "type": "function" } ], "namespace": "topSites", "permissions": [ "topSites" ], "types": [ { "description": "An object encapsulating a most visited URL, such as the URLs on the new tab page.", "id": "MostVisitedURL", "properties": { "title": { "description": "The title of the page.", "optional": true, "type": "string" }, "url": { "description": "The most visited URL.", "type": "string" } }, "type": "object" } ] }, { "description": "Contains types used by other schemas.", "namespace": "types", "types": [ { "description": "The scope of the Setting. One of
  • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
  • regular_only: setting for the regular profile only (not inherited by the incognito profile),
  • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
  • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
Only regular is supported by Firefox at this time.", "enum": [ "regular", "regular_only", "incognito_persistent", "incognito_session_only" ], "id": "SettingScope", "type": "string" }, { "description": "One of
  • not_controllable: cannot be controlled by any extension
  • controlled_by_other_extensions: controlled by extensions with higher precedence
  • controllable_by_this_extension: can be controlled by this extension
  • controlled_by_this_extension: controlled by this extension
", "enum": [ "not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", "controlled_by_this_extension" ], "id": "LevelOfControl", "type": "string" }, { "events": [ { "description": "Fired after the setting changes.", "name": "onChange", "parameters": [ { "name": "details", "properties": { "incognitoSpecific": { "description": "Whether the value that has changed is specific to the incognito session.
This property will only be present if the user has enabled the extension in incognito mode.", "optional": true, "type": "boolean" }, "levelOfControl": { "$ref": "LevelOfControl", "description": "The level of control of the setting." }, "value": { "description": "The value of the setting after the change.", "type": "any" } }, "type": "object" } ], "type": "function", "unsupported": true } ], "functions": [ { "async": "callback", "description": "Gets the value of a setting.", "name": "get", "parameters": [ { "description": "Which setting to consider.", "name": "details", "properties": { "incognito": { "description": "Whether to return the value that applies to the incognito session (default false).", "optional": true, "type": "boolean" } }, "type": "object" }, { "name": "callback", "parameters": [ { "description": "Details of the currently effective value.", "name": "details", "properties": { "incognitoSpecific": { "description": "Whether the effective value is specific to the incognito session.
This property will only be present if the incognito property in the details parameter of get() was true.", "optional": true, "type": "boolean" }, "levelOfControl": { "$ref": "LevelOfControl", "description": "The level of control of the setting." }, "value": { "description": "The value of the setting.", "type": "any" } }, "type": "object" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Sets the value of a setting.", "name": "set", "parameters": [ { "description": "Which setting to change.", "name": "details", "properties": { "scope": { "$ref": "SettingScope", "description": "Where to set the setting (default: regular).", "optional": true }, "value": { "description": "The value of the setting.
Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.", "type": "any" } }, "type": "object" }, { "description": "Called at the completion of the set operation.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Clears the setting, restoring any default value.", "name": "clear", "parameters": [ { "description": "Which setting to clear.", "name": "details", "properties": { "scope": { "$ref": "SettingScope", "description": "Where to clear the setting (default: regular).", "optional": true } }, "type": "object" }, { "description": "Called at the completion of the clear operation.", "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" } ], "id": "Setting", "type": "object" } ] }, { "description": "Use the browser.webNavigation API to receive notifications about the status of navigation requests in-flight.", "events": [ { "description": "Fired when a navigation is about to occur.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onBeforeNavigate", "parameters": [ { "name": "details", "properties": { "frameId": { "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique for a given tab and process.", "type": "integer" }, "parentFrameId": { "description": "ID of frame that wraps the frame. Set to -1 of no parent frame exists.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the navigation is about to occur.", "type": "integer" }, "timeStamp": { "description": "The time when the browser was about to start the navigation, in milliseconds since the epoch.", "type": "number" }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a navigation is committed. The document (and the resources it refers to, such as images and subframes) might still be downloading, but at least part of the document has been received from the server and the browser has decided to switch to the new document.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onCommitted", "parameters": [ { "name": "details", "properties": { "frameId": { "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the navigation occurs.", "type": "integer" }, "timeStamp": { "description": "The time when the navigation was committed, in milliseconds since the epoch.", "type": "number" }, "transitionQualifiers": { "description": "A list of transition qualifiers.", "items": { "$ref": "TransitionQualifier" }, "type": "array", "unsupported": true }, "transitionType": { "$ref": "TransitionType", "description": "Cause of the navigation.", "unsupported": true }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onDOMContentLoaded", "parameters": [ { "name": "details", "properties": { "frameId": { "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the navigation occurs.", "type": "integer" }, "timeStamp": { "description": "The time when the page's DOM was fully constructed, in milliseconds since the epoch.", "type": "number" }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a document, including the resources it refers to, is completely loaded and initialized.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onCompleted", "parameters": [ { "name": "details", "properties": { "frameId": { "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the navigation occurs.", "type": "integer" }, "timeStamp": { "description": "The time when the document finished loading, in milliseconds since the epoch.", "type": "number" }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onErrorOccurred", "parameters": [ { "name": "details", "properties": { "error": { "description": "The error description.", "type": "string", "unsupported": true }, "frameId": { "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the navigation occurs.", "type": "integer" }, "timeStamp": { "description": "The time when the error occurred, in milliseconds since the epoch.", "type": "number" }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a new window, or a new tab in an existing window, is created to host a navigation.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onCreatedNavigationTarget", "parameters": [ { "name": "details", "properties": { "sourceFrameId": { "description": "The ID of the frame with sourceTabId in which the navigation is triggered. 0 indicates the main frame.", "type": "integer" }, "sourceProcessId": { "description": "The ID of the process runs the renderer for the source tab.", "type": "integer" }, "sourceTabId": { "description": "The ID of the tab in which the navigation is triggered.", "type": "integer" }, "tabId": { "description": "The ID of the tab in which the url is opened", "type": "integer" }, "timeStamp": { "description": "The time when the browser was about to create a new view, in milliseconds since the epoch.", "type": "number" }, "url": { "description": "The URL to be opened in the new window.", "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onReferenceFragmentUpdated", "parameters": [ { "name": "details", "properties": { "frameId": { "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the navigation occurs.", "type": "integer" }, "timeStamp": { "description": "The time when the navigation was committed, in milliseconds since the epoch.", "type": "number" }, "transitionQualifiers": { "description": "A list of transition qualifiers.", "items": { "$ref": "TransitionQualifier" }, "type": "array", "unsupported": true }, "transitionType": { "$ref": "TransitionType", "description": "Cause of the navigation.", "unsupported": true }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.", "name": "onTabReplaced", "parameters": [ { "name": "details", "properties": { "replacedTabId": { "description": "The ID of the tab that was replaced.", "type": "integer" }, "tabId": { "description": "The ID of the tab that replaced the old tab.", "type": "integer" }, "timeStamp": { "description": "The time when the replacement happened, in milliseconds since the epoch.", "type": "number" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.", "extraParameters": [ { "$ref": "EventUrlFilters", "description": "Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event.", "name": "filters", "optional": true } ], "name": "onHistoryStateUpdated", "parameters": [ { "name": "details", "properties": { "frameId": { "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the navigation occurs.", "type": "integer" }, "timeStamp": { "description": "The time when the navigation was committed, in milliseconds since the epoch.", "type": "number" }, "transitionQualifiers": { "description": "A list of transition qualifiers.", "items": { "$ref": "TransitionQualifier" }, "type": "array", "unsupported": true }, "transitionType": { "$ref": "TransitionType", "description": "Cause of the navigation.", "unsupported": true }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Retrieves information about the given frame. A frame refers to an <iframe> or a <frame> of a web page and is identified by a tab ID and a frame ID.", "name": "getFrame", "parameters": [ { "description": "Information about the frame to retrieve information about.", "name": "details", "properties": { "frameId": { "description": "The ID of the frame in the given tab.", "minimum": 0, "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "optional": true, "type": "integer" }, "tabId": { "description": "The ID of the tab in which the frame is.", "minimum": 0, "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "description": "Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.", "name": "details", "optional": true, "properties": { "errorOccurred": { "description": "True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired.", "optional": true, "type": "boolean" }, "frameId": { "description": "The ID of the frame. 0 indicates that this is the main frame; a positive value indicates the ID of a subframe.", "type": "integer" }, "parentFrameId": { "description": "ID of frame that wraps the frame. Set to -1 of no parent frame exists.", "type": "integer" }, "tabId": { "description": "The ID of the tab in which the frame is.", "type": "integer" }, "url": { "description": "The URL currently associated with this frame, if the frame identified by the frameId existed at one point in the given tab. The fact that an URL is associated with a given frameId does not imply that the corresponding frame still exists.", "type": "string" } }, "type": "object" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Retrieves information about all frames of a given tab.", "name": "getAllFrames", "parameters": [ { "description": "Information about the tab to retrieve all frames from.", "name": "details", "properties": { "tabId": { "description": "The ID of the tab.", "minimum": 0, "type": "integer" } }, "type": "object" }, { "name": "callback", "parameters": [ { "description": "A list of frames in the given tab, null if the specified tab ID is invalid.", "items": { "properties": { "errorOccurred": { "description": "True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired.", "optional": true, "type": "boolean" }, "frameId": { "description": "The ID of the frame. 0 indicates that this is the main frame; a positive value indicates the ID of a subframe.", "type": "integer" }, "parentFrameId": { "description": "ID of frame that wraps the frame. Set to -1 of no parent frame exists.", "type": "integer" }, "processId": { "description": "The ID of the process runs the renderer for this tab.", "type": "integer", "unsupported": true }, "tabId": { "description": "The ID of the tab in which the frame is.", "type": "integer" }, "url": { "description": "The URL currently associated with this frame.", "type": "string" } }, "type": "object" }, "name": "details", "optional": true, "type": "array" } ], "type": "function" } ], "type": "function" } ], "namespace": "webNavigation", "permissions": [ "webNavigation" ], "types": [ { "description": "Cause of the navigation. The same transition types as defined in the history API are used. These are the same transition types as defined in the $(topic:transition_types)[history API] except with \"start_page\" in place of \"auto_toplevel\" (for backwards compatibility).", "enum": [ "link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated" ], "id": "TransitionType", "type": "string" }, { "enum": [ "client_redirect", "server_redirect", "forward_back", "from_address_bar" ], "id": "TransitionQualifier", "type": "string" }, { "id": "EventUrlFilters", "properties": { "url": { "items": { "$ref": "events.UrlFilter" }, "minItems": 1, "type": "array" } }, "type": "object" } ] }, { "description": "Use the browser.webRequest API to observe and analyze traffic and to intercept, block, or modify requests in-flight.", "events": [ { "description": "Fired when a request is about to occur.", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnBeforeRequestOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onBeforeRequest", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "requestBody": { "description": "Contains the HTTP request body data. Only provided if extraInfoSpec contains 'requestBody'.", "optional": true, "properties": { "error": { "description": "Errors when obtaining request body data.", "optional": true, "type": "string" }, "formData": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "If the request method is POST and the body is a sequence of key-value pairs encoded in UTF8, encoded as either multipart/form-data, or application/x-www-form-urlencoded, this dictionary is present and for each key contains the list of all values for that key. If the data is of another media type, or if it is malformed, the dictionary is not present. An example value of this dictionary is {'key': ['value1', 'value2']}.", "optional": true, "properties": {}, "type": "object" }, "raw": { "description": "If the request method is PUT or POST, and the body is not already parsed in formData, then the unparsed request body elements are contained in this array.", "items": { "$ref": "UploadData" }, "optional": true, "type": "array" } }, "type": "object" }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "returns": { "$ref": "BlockingResponse", "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", "optional": true }, "type": "function" }, { "description": "Fired before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent. ", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnBeforeSendHeadersOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onBeforeSendHeaders", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "requestHeaders": { "$ref": "HttpHeaders", "description": "The HTTP request headers that are going to be sent out with this request.", "optional": true }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "returns": { "$ref": "BlockingResponse", "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", "optional": true }, "type": "function" }, { "description": "Fired just before a request is going to be sent to the server (modifications of previous onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnSendHeadersOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onSendHeaders", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "requestHeaders": { "$ref": "HttpHeaders", "description": "The HTTP request headers that have been sent out with this request.", "optional": true }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when HTTP response headers of a request have been received.", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnHeadersReceivedOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onHeadersReceived", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "responseHeaders": { "$ref": "HttpHeaders", "description": "The HTTP response headers that have been received with this response.", "optional": true }, "statusCode": { "description": "Standard HTTP status code returned by the server.", "type": "integer" }, "statusLine": { "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line).", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "returns": { "$ref": "BlockingResponse", "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", "optional": true }, "type": "function" }, { "description": "Fired when an authentication failure is received. The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge. If bad user credentials are provided, this may be called multiple times for the same request.", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnAuthRequiredOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onAuthRequired", "parameters": [ { "name": "details", "properties": { "challenger": { "description": "The server requesting authentication.", "properties": { "host": { "type": "string" }, "port": { "type": "integer" } }, "type": "object" }, "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "isProxy": { "description": "True for Proxy-Authenticate, false for WWW-Authenticate.", "type": "boolean" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "realm": { "description": "The authentication realm provided by the server, if there is one.", "optional": true, "type": "string" }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "responseHeaders": { "$ref": "HttpHeaders", "description": "The HTTP response headers that were received along with this response.", "optional": true }, "scheme": { "description": "The authentication scheme, e.g. Basic or Digest.", "type": "string" }, "statusCode": { "description": "Standard HTTP status code returned by the server.", "type": "integer" }, "statusLine": { "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line) or an empty string if there are no headers.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "BlockingResponse", "name": "response" } ], "type": "function" } ], "returns": { "$ref": "BlockingResponse", "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", "optional": true }, "type": "function" }, { "description": "Fired when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available.", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnResponseStartedOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onResponseStarted", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "fromCache": { "description": "Indicates if this response was fetched from disk cache.", "type": "boolean" }, "ip": { "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.", "optional": true, "type": "string" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "responseHeaders": { "$ref": "HttpHeaders", "description": "The HTTP response headers that were received along with this response.", "optional": true }, "statusCode": { "description": "Standard HTTP status code returned by the server.", "type": "integer" }, "statusLine": { "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line) or an empty string if there are no headers.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a server-initiated redirect is about to occur.", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnBeforeRedirectOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onBeforeRedirect", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "fromCache": { "description": "Indicates if this response was fetched from disk cache.", "type": "boolean" }, "ip": { "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.", "optional": true, "type": "string" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "redirectUrl": { "description": "The new URL.", "type": "string" }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "responseHeaders": { "$ref": "HttpHeaders", "description": "The HTTP response headers that were received along with this redirect.", "optional": true }, "statusCode": { "description": "Standard HTTP status code returned by the server.", "type": "integer" }, "statusLine": { "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line) or an empty string if there are no headers.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when a request is completed.", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" }, { "description": "Array of extra information that should be passed to the listener function.", "items": { "$ref": "OnCompletedOptions" }, "name": "extraInfoSpec", "optional": true, "type": "array" } ], "name": "onCompleted", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "fromCache": { "description": "Indicates if this response was fetched from disk cache.", "type": "boolean" }, "ip": { "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.", "optional": true, "type": "string" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "responseHeaders": { "$ref": "HttpHeaders", "description": "The HTTP response headers that were received along with this response.", "optional": true }, "statusCode": { "description": "Standard HTTP status code returned by the server.", "type": "integer" }, "statusLine": { "description": "HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line) or an empty string if there are no headers.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" }, { "description": "Fired when an error occurs.", "extraParameters": [ { "$ref": "RequestFilter", "description": "A set of filters that restricts the events that will be sent to this listener.", "name": "filter" } ], "name": "onErrorOccurred", "parameters": [ { "name": "details", "properties": { "documentUrl": { "description": "URL of the page into which the requested resource will be loaded.", "optional": true, "type": "string" }, "error": { "description": "The error description. This string is not guaranteed to remain backwards compatible between releases. You must not parse and act based upon its content.", "type": "string" }, "frameId": { "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.", "type": "integer" }, "fromCache": { "description": "Indicates if this response was fetched from disk cache.", "type": "boolean" }, "ip": { "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.", "optional": true, "type": "string" }, "method": { "description": "Standard HTTP method.", "type": "string" }, "originUrl": { "description": "URL of the resource that triggered this request.", "optional": true, "type": "string" }, "parentFrameId": { "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.", "type": "integer" }, "requestId": { "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.", "type": "string" }, "tabId": { "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.", "type": "integer" }, "timeStamp": { "description": "The time when this signal is triggered, in milliseconds since the epoch.", "type": "number" }, "type": { "$ref": "ResourceType", "description": "How the requested resource will be used." }, "url": { "type": "string" } }, "type": "object" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.", "name": "handlerBehaviorChanged", "parameters": [ { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" }, { "description": "...", "name": "filterResponseData", "parameters": [ { "name": "requestId", "type": "string" } ], "permissions": [ "webRequestBlocking" ], "returns": { "additionalProperties": { "type": "any" }, "isInstanceOf": "StreamFilter", "type": "object" }, "type": "function" } ], "namespace": "webRequest", "permissions": [ "webRequest" ], "properties": { "MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES": { "description": "The maximum number of times that handlerBehaviorChanged can be called per 10 minute sustained interval. handlerBehaviorChanged is an expensive function call that shouldn't be called often.", "value": 20 } }, "types": [ { "enum": [ "main_frame", "sub_frame", "stylesheet", "script", "image", "object", "object_subrequest", "xmlhttprequest", "xbl", "xslt", "ping", "beacon", "xml_dtd", "font", "media", "websocket", "csp_report", "imageset", "web_manifest", "other" ], "id": "ResourceType", "type": "string" }, { "enum": [ "blocking", "requestBody" ], "id": "OnBeforeRequestOptions", "type": "string" }, { "enum": [ "requestHeaders", "blocking" ], "id": "OnBeforeSendHeadersOptions", "type": "string" }, { "enum": [ "requestHeaders" ], "id": "OnSendHeadersOptions", "type": "string" }, { "enum": [ "blocking", "responseHeaders" ], "id": "OnHeadersReceivedOptions", "type": "string" }, { "enum": [ "responseHeaders", "blocking", "asyncBlocking" ], "id": "OnAuthRequiredOptions", "type": "string" }, { "enum": [ "responseHeaders" ], "id": "OnResponseStartedOptions", "type": "string" }, { "enum": [ "responseHeaders" ], "id": "OnBeforeRedirectOptions", "type": "string" }, { "enum": [ "responseHeaders" ], "id": "OnCompletedOptions", "type": "string" }, { "description": "An object describing filters to apply to webRequest events.", "id": "RequestFilter", "properties": { "tabId": { "optional": true, "type": "integer" }, "types": { "description": "A list of request types. Requests that cannot match any of the types will be filtered out.", "items": { "$ref": "ResourceType" }, "minItems": 1, "optional": true, "type": "array" }, "urls": { "description": "A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "windowId": { "optional": true, "type": "integer" } }, "type": "object" }, { "description": "An array of HTTP headers. Each header is represented as a dictionary containing the keys name and either value or binaryValue.", "id": "HttpHeaders", "items": { "properties": { "binaryValue": { "description": "Value of the HTTP header if it cannot be represented by UTF-8, stored as individual byte values (0..255).", "items": { "type": "integer" }, "optional": true, "type": "array" }, "name": { "description": "Name of the HTTP header.", "type": "string" }, "value": { "description": "Value of the HTTP header if it can be represented by UTF-8.", "optional": true, "type": "string" } }, "type": "object" }, "type": "array" }, { "description": "Returns value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests.", "id": "BlockingResponse", "properties": { "authCredentials": { "description": "Only used as a response to the onAuthRequired event. If set, the request is made using the supplied credentials.", "optional": true, "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "cancel": { "description": "If true, the request is cancelled. Used in onBeforeRequest, this prevents the request from being sent.", "optional": true, "type": "boolean" }, "redirectUrl": { "description": "Only used as a response to the onBeforeRequest and onHeadersReceived events. If set, the original request is prevented from being sent/completed and is instead redirected to the given URL. Redirections to non-HTTP schemes such as data: are allowed. Redirects initiated by a redirect action use the original request method for the redirect, with one exception: If the redirect is initiated at the onHeadersReceived stage, then the redirect will be issued using the GET method.", "optional": true, "type": "string" }, "requestHeaders": { "$ref": "HttpHeaders", "description": "Only used as a response to the onBeforeSendHeaders event. If set, the request is made with these request headers instead.", "optional": true }, "responseHeaders": { "$ref": "HttpHeaders", "description": "Only used as a response to the onHeadersReceived event. If set, the server is assumed to have responded with these response headers instead. Only return responseHeaders if you really want to modify the headers in order to limit the number of conflicts (only one extension may modify responseHeaders for each request).", "optional": true } }, "type": "object" }, { "description": "Contains data uploaded in a URL request.", "id": "UploadData", "properties": { "bytes": { "description": "An ArrayBuffer with a copy of the data.", "optional": true, "type": "any" }, "file": { "description": "A string with the file's path and name.", "optional": true, "type": "string" } }, "type": "object" } ] }, { "description": "Use the browser.windows API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser.", "events": [ { "description": "Fired when a window is created.", "filters": [ { "description": "Conditions that the window's type being created must satisfy. By default it will satisfy ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.", "items": { "$ref": "WindowType" }, "name": "windowTypes", "type": "array" } ], "name": "onCreated", "parameters": [ { "$ref": "Window", "description": "Details of the window that was created.", "name": "window" } ], "type": "function" }, { "description": "Fired when a window is removed (closed).", "filters": [ { "description": "Conditions that the window's type being removed must satisfy. By default it will satisfy ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.", "items": { "$ref": "WindowType" }, "name": "windowTypes", "type": "array" } ], "name": "onRemoved", "parameters": [ { "description": "ID of the removed window.", "minimum": 0, "name": "windowId", "type": "integer" } ], "type": "function" }, { "description": "Fired when the currently focused window changes. Will be $(ref:windows.WINDOW_ID_NONE) if all browser windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one browser window to another.", "filters": [ { "description": "Conditions that the window's type being removed must satisfy. By default it will satisfy ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.", "items": { "$ref": "WindowType" }, "name": "windowTypes", "type": "array" } ], "name": "onFocusChanged", "parameters": [ { "description": "ID of the newly focused window.", "minimum": -1, "name": "windowId", "type": "integer" } ], "type": "function" } ], "functions": [ { "async": "callback", "description": "Gets details about a window.", "name": "get", "parameters": [ { "minimum": -2, "name": "windowId", "type": "integer" }, { "description": "", "name": "getInfo", "optional": true, "properties": { "populate": { "description": "If true, the $(ref:windows.Window) object will have a tabs property that contains a list of the $(ref:tabs.Tab) objects. The Tab objects only contain the url, title and favIconUrl properties if the extension's manifest file includes the \"tabs\" permission.", "optional": true, "type": "boolean" }, "windowTypes": { "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.", "items": { "$ref": "WindowType" }, "optional": true, "type": "array" } }, "type": "object" }, { "name": "callback", "parameters": [ { "$ref": "Window", "name": "window" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the $(topic:current-window)[current window].", "name": "getCurrent", "parameters": [ { "description": "", "name": "getInfo", "optional": true, "properties": { "populate": { "description": "If true, the $(ref:windows.Window) object will have a tabs property that contains a list of the $(ref:tabs.Tab) objects. The Tab objects only contain the url, title and favIconUrl properties if the extension's manifest file includes the \"tabs\" permission.", "optional": true, "type": "boolean" }, "windowTypes": { "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.", "items": { "$ref": "WindowType" }, "optional": true, "type": "array" } }, "type": "object" }, { "name": "callback", "parameters": [ { "$ref": "Window", "name": "window" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets the window that was most recently focused — typically the window 'on top'.", "name": "getLastFocused", "parameters": [ { "description": "", "name": "getInfo", "optional": true, "properties": { "populate": { "description": "If true, the $(ref:windows.Window) object will have a tabs property that contains a list of the $(ref:tabs.Tab) objects. The Tab objects only contain the url, title and favIconUrl properties if the extension's manifest file includes the \"tabs\" permission.", "optional": true, "type": "boolean" }, "windowTypes": { "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.", "items": { "$ref": "WindowType" }, "optional": true, "type": "array" } }, "type": "object" }, { "name": "callback", "parameters": [ { "$ref": "Window", "name": "window" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Gets all windows.", "name": "getAll", "parameters": [ { "description": "", "name": "getInfo", "optional": true, "properties": { "populate": { "description": "If true, each $(ref:windows.Window) object will have a tabs property that contains a list of the $(ref:tabs.Tab) objects for that window. The Tab objects only contain the url, title and favIconUrl properties if the extension's manifest file includes the \"tabs\" permission.", "optional": true, "type": "boolean" }, "windowTypes": { "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.", "items": { "$ref": "WindowType" }, "optional": true, "type": "array" } }, "type": "object" }, { "name": "callback", "parameters": [ { "items": { "$ref": "Window" }, "name": "windows", "type": "array" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Creates (opens) a new browser with any optional sizing, position or default URL provided.", "name": "create", "parameters": [ { "default": {}, "name": "createData", "optional": true, "properties": { "allowScriptsToClose": { "description": "Allow scripts to close the window.", "optional": true, "type": "boolean" }, "focused": { "description": "If true, opens an active window. If false, opens an inactive window.", "optional": true, "type": "boolean", "unsupported": true }, "height": { "description": "The height in pixels of the new window, including the frame. If not specified defaults to a natural height.", "minimum": 0, "optional": true, "type": "integer" }, "incognito": { "description": "Whether the new window should be an incognito window.", "optional": true, "type": "boolean" }, "left": { "description": "The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels.", "optional": true, "type": "integer" }, "state": { "$ref": "WindowState", "description": "The initial state of the window. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'.", "optional": true }, "tabId": { "description": "The id of the tab for which you want to adopt to the new window.", "minimum": 0, "optional": true, "type": "integer" }, "titlePreface": { "description": "A string to add to the beginning of the window title.", "optional": true, "type": "string" }, "top": { "description": "The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels.", "optional": true, "type": "integer" }, "type": { "$ref": "CreateType", "description": "Specifies what type of browser window to create. The 'panel' and 'detached_panel' types create a popup unless the '--enable-panels' flag is set.", "optional": true }, "url": { "choices": [ { "format": "relativeUrl", "type": "string" }, { "items": { "format": "relativeUrl", "type": "string" }, "type": "array" } ], "description": "A URL or array of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.", "optional": true }, "width": { "description": "The width in pixels of the new window, including the frame. If not specified defaults to a natural width.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "Window", "description": "Contains details about the created window.", "name": "window", "optional": true } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Updates the properties of a window. Specify only the properties that you want to change; unspecified properties will be left unchanged.", "name": "update", "parameters": [ { "minimum": -2, "name": "windowId", "type": "integer" }, { "name": "updateInfo", "properties": { "drawAttention": { "description": "If true, causes the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The effect lasts until the user changes focus to the window. This option has no effect if the window already has focus. Set to false to cancel a previous draw attention request.", "optional": true, "type": "boolean" }, "focused": { "description": "If true, brings the window to the front. If false, brings the next window in the z-order to the front.", "optional": true, "type": "boolean" }, "height": { "description": "The height to resize the window to in pixels. This value is ignored for panels.", "minimum": 0, "optional": true, "type": "integer" }, "left": { "description": "The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels.", "optional": true, "type": "integer" }, "state": { "$ref": "WindowState", "description": "The new state of the window. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'.", "optional": true }, "titlePreface": { "description": "A string to add to the beginning of the window title.", "optional": true, "type": "string" }, "top": { "description": "The offset from the top edge of the screen to move the window to in pixels. This value is ignored for panels.", "optional": true, "type": "integer" }, "width": { "description": "The width to resize the window to in pixels. This value is ignored for panels.", "minimum": 0, "optional": true, "type": "integer" } }, "type": "object" }, { "name": "callback", "optional": true, "parameters": [ { "$ref": "Window", "name": "window" } ], "type": "function" } ], "type": "function" }, { "async": "callback", "description": "Removes (closes) a window, and all the tabs inside it.", "name": "remove", "parameters": [ { "minimum": 0, "name": "windowId", "type": "integer" }, { "name": "callback", "optional": true, "parameters": [], "type": "function" } ], "type": "function" } ], "namespace": "windows", "properties": { "WINDOW_ID_CURRENT": { "description": "The windowId value that represents the $(topic:current-window)[current window].", "value": -2 }, "WINDOW_ID_NONE": { "description": "The windowId value that represents the absence of a browser window.", "value": -1 } }, "types": [ { "description": "The type of browser window this is. Under some circumstances a Window may not be assigned type property, for example when querying closed windows from the $(ref:sessions) API.", "enum": [ "normal", "popup", "panel", "app", "devtools" ], "id": "WindowType", "type": "string" }, { "description": "The state of this browser window. Under some circumstances a Window may not be assigned state property, for example when querying closed windows from the $(ref:sessions) API.", "enum": [ "normal", "minimized", "maximized", "fullscreen", "docked" ], "id": "WindowState", "type": "string" }, { "id": "Window", "properties": { "alwaysOnTop": { "description": "Whether the window is set to be always on top.", "type": "boolean" }, "focused": { "description": "Whether the window is currently the focused window.", "type": "boolean" }, "height": { "description": "The height of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned height property, for example when querying closed windows from the $(ref:sessions) API.", "optional": true, "type": "integer" }, "id": { "description": "The ID of the window. Window IDs are unique within a browser session. Under some circumstances a Window may not be assigned an ID, for example when querying windows using the $(ref:sessions) API, in which case a session ID may be present.", "minimum": 0, "optional": true, "type": "integer" }, "incognito": { "description": "Whether the window is incognito.", "type": "boolean" }, "left": { "description": "The offset of the window from the left edge of the screen in pixels. Under some circumstances a Window may not be assigned left property, for example when querying closed windows from the $(ref:sessions) API.", "optional": true, "type": "integer" }, "sessionId": { "description": "The session ID used to uniquely identify a Window obtained from the $(ref:sessions) API.", "optional": true, "type": "string" }, "state": { "$ref": "WindowState", "description": "The state of this browser window.", "optional": true }, "tabs": { "description": "Array of $(ref:tabs.Tab) objects representing the current tabs in the window.", "items": { "$ref": "tabs.Tab" }, "optional": true, "type": "array" }, "title": { "description": "The title of the window. Read-only.", "optional": true, "type": "string" }, "top": { "description": "The offset of the window from the top edge of the screen in pixels. Under some circumstances a Window may not be assigned top property, for example when querying closed windows from the $(ref:sessions) API.", "optional": true, "type": "integer" }, "type": { "$ref": "WindowType", "description": "The type of browser window this is.", "optional": true }, "width": { "description": "The width of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned width property, for example when querying closed windows from the $(ref:sessions) API.", "optional": true, "type": "integer" } }, "type": "object" }, { "description": "Specifies what type of browser window to create. The 'panel' and 'detached_panel' types create a popup unless the '--enable-panels' flag is set.", "enum": [ "normal", "popup", "panel", "detached_panel" ], "id": "CreateType", "type": "string" } ] } ]