[ { "namespace": "extension", "unprivileged": true, "types": [ { "id": "MessageSender", "type": "object", "description": "An object containing information about the script context that sent a message or request.", "properties": { "tab": {"$ref": "Tab", "optional": true, "description":"This property will only be present when the connection was opened from a tab or content script."}, "id": {"type": "string", "description": "The extension ID of the extension that opened the connection."} } }, { "id": "Event", "type": "object", "description": "An object which allows the addition and removal of listeners for a Chrome event.", "properties": { "addListener": {"type": "function"}, "removeListener": {"type": "function"}, "hasListener": {"type": "function"}, "hasListeners": {"type": "function"} }, "additionalProperties": { "type": "any"} }, { "id": "Port", "type": "object", "description": "An object which allows two way communication with other pages.", "properties": { "name": {"type": "string"}, "onDisconnect": { "$ref": "Event" }, "onMessage": { "$ref": "Event" }, "postMessage": {"type": "function"}, "sender": { "$ref": "MessageSender", "optional": true, "description": "This property will only be present on ports passed to onConnect/onConnectExternal listeners." } }, "additionalProperties": { "type": "any"} } ], "properties": { "lastError": { "type": "object", "optional": true, "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.", "properties": { "message": { "type": "string", "description": "Description of the error that has taken place." } } }, "inIncognitoTab": { "type": "object", "optional": true, "unprivileged": true, "description": "True for content scripts running inside incognito tabs. Will be undefined for non-content scripts.", "properties": { "message": { "type": "boolean", "description": "True if the script is in an incongito tab." } } } }, "functions": [ { "name": "connect", "type": "function", "unprivileged": true, "description": "Attempts to connect to other listeners within the extension (such as the extension's background page). This is primarily useful for content scripts connecting to their extension processes. Extensions may connect to content scripts embedded in tabs via chrome.tabs.connect().", "parameters": [ {"type": "string", "name": "extensionId", "optional": true, "description": "The extension ID of the extension you want to connect to. If omitted, default is your own extension."}, { "type": "object", "name": "connectInfo", "properties": { "name": { "type": "string", "optional": true, "description": "Will be passed into onConnect for extension processes that are listening for the connection event." } }, "optional": true } ], "returns": { "$ref": "Port", "description": "Port through which messages can be sent and received with the extension." } }, { "name": "sendRequest", "type": "function", "unprivileged": true, "description": "Sends a single request to other listeners within the extension. Similar to chrome.extension.connect, but only sends a single request with an optional response.", "parameters": [ {"type": "string", "name": "extensionId", "optional": true, "description": "The extension ID of the extension you want to connect to. If omitted, default is your own extension."}, { "type": "any", "name": "request" }, { "type": "function", "name": "responseCallback", "optional": true, "parameters": [ { "name": "response", "type": "any", "description": "The JSON response object sent by the handler of the request." } ] } ] }, { "name": "getURL", "type": "function", "unprivileged": true, "description": "Converts a relative path within an extension install directory to a fully-qualified URL.", "parameters": [ { "type": "string", "name": "path", "description": "A path to a resource within an extension expressed relative to it's install directory." } ], "returns": { "type": "string", "description": "The fully-qualified URL to the resource." } }, { "name": "getViews", "type": "function", "description": "Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.", "parameters": [ { "type": "object", "name": "fetchProperties", "optional": true, "properties": { "type": { "type": "string", "enum": ["tab", "infobar", "notification", "popup"], "optional": true, "description": "The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'infobar', 'notification', 'popup'." }, "windowId": { "type": "integer", "optional": true, "description": "The window to restrict the search to. If omitted, returns all views." } } } ], "returns": { "type": "array", "description": "Array of global objects", "items": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" } } } }, { "name": "getBackgroundPage", "type": "function", "description": "Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no backround page.", "parameters": [], "returns": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" } } }, { "name": "getToolstrips", "nodoc": true, "type": "function", "description": "Deprecated. Please use getViews({type: 'TOOLSTRIP'}). Returns an array of the JavaScript 'window' objects for each of the toolstrip views running inside the current extension. If windowId is specified, returns only the 'window' objects of toolstrips attached to the specified window.", "parameters": [ {"type": "integer", "name": "windowId", "optional": true} ], "returns": { "type": "array", "description": "Array of global window objects", "items": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" } } } }, { "name": "getExtensionTabs", "nodoc": true, "type": "function", "description": "Deprecated. Please use getViews({type: 'TAB'}). Returns an array of the JavaScript 'window' objects for each of the tabs running inside the current extension. If windowId is specified, returns only the 'window' objects of tabs attached to the specified window.", "parameters": [ {"type": "integer", "name": "windowId", "optional": true} ], "returns": { "type": "array", "description": "Array of global window objects", "items": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" } } } } ], "events": [ { "name": "onConnect", "type": "function", "unprivileged": true, "description": "Fired when a connection is made from either an extension process or a content script.", "parameters": [ {"$ref": "Port", "name": "port"} ] }, { "name": "onConnectExternal", "type": "function", "description": "Fired when a connection is made from another extension.", "parameters": [ {"$ref": "Port", "name": "port"} ] }, { "name": "onRequest", "type": "function", "unprivileged": true, "description": "Fired when a request is sent from either an extension process or a content script.", "parameters": [ {"name": "request", "type": "any", "description": "The request sent by the calling script."}, {"name": "sender", "$ref": "MessageSender" }, {"name": "sendResponse", "type": "function", "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": "onRequestExternal", "type": "function", "description": "Fired when a request is sent from another extension.", "parameters": [ {"name": "request", "type": "any", "description": "The request sent by the calling script."}, {"name": "sender", "$ref": "MessageSender" }, {"name": "sendResponse", "type": "function", "description": "Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response." } ] } ] }, { "namespace": "experimental.accessibility", "nodoc": true, "types": [ { "id": "AccessibilityObject", "type": "object", "description": "Parent class for accessibility information about an object.", "properties": { "type": { "type": "string", "description": "The type of this object, which determines the contents of 'details'.", "enum": ["button", "checkbox", "combobox", "link", "menu", "menuitem", "radiobutton", "tab", "textbox", "window"] }, "name": { "type": "string", "description": "The localized name of the object, like OK or Password. Do not rely on an exact string match because the text will be in the user's language and may change in the future." }, "details": { "description": "Other details like the state, depending on the type of object.", "optional": true, "choices": [ { "$ref": "CheckboxDetails" }, { "$ref": "ComboBoxDetails" }, { "$ref": "MenuDetails" }, { "$ref": "MenuItemDetails" }, { "$ref": "RadioButtonDetails" }, { "$ref": "TabDetails" }, { "$ref": "TextBoxDetails" } ] } } }, { "id": "CheckboxDetails", "type": "object", "description": "Information about the state of a checkbox.", "properties": { "isChecked": {"type": "boolean", "description": "True if this checkbox is checked."} } }, { "id": "ComboBoxDetails", "type": "object", "description": "Information about the state of a combo box.", "properties": { "value": {"type": "string", "description": "The value of the combo box."}, "itemCount": {"type": "integer", "description": "The number of items in the combo box's list."}, "itemIndex": {"type": "integer", "description": "The 0-based index of the current value, or -1 if the user entered a value not from the list."} } }, { "id": "ListBoxDetails", "type": "object", "description": "Information about the state of a list box.", "properties": { "value": {"type": "string", "description": "The value of the list box."}, "itemCount": {"type": "integer", "description": "The number of items in the list."}, "itemIndex": {"type": "integer", "description": "The 0-based index of the selected value, or -1 if no items are selected."} } }, { "id": "MenuDetails", "type": "object", "description": "Information about the state of a drop-down menu.", "properties": { } }, { "id": "MenuItemDetails", "type": "object", "description": "Information about a menu item.", "properties": { "hasSubmenu": {"type": "boolean", "description": "True if this item opens a submenu."}, "itemCount": {"type": "integer", "description": "The number of items in the menu."}, "itemIndex": {"type": "integer", "description": "The 0-based index of this menu item."} } }, { "id": "RadioButtonDetails", "type": "object", "description": "Information about the state of a radio button.", "properties": { "isChecked": {"type": "boolean", "description": "True if this radio button is checked."}, "itemCount": {"type": "integer", "description": "The number of radio buttons in this group."}, "itemIndex": {"type": "integer", "description": "The 0-based index of this radio button in this group."} } }, { "id": "TabDetails", "type": "object", "description": "Additional accessibility information about a tab.", "properties": { "itemCount": {"type": "integer", "description": "The number of tabs in this group."}, "itemIndex": {"type": "integer", "description": "The 0-based index of this tab in this group."} } }, { "id": "TextBoxDetails", "type": "object", "description": "Information about the state of a text box.", "properties": { "value": {"type": "string", "description": "The value of the text box - the entered text."}, "isPassword": {"type": "boolean", "description": "True if this control contains password text whose contents should be obscured."}, "selectionStart": {"type": "integer", "description": "The index of the character where the selection starts, if this control contains editable text."}, "selectionEnd": {"type": "integer", "description": "The index of the character where the selection ends, if this control contains editable text."} } } ], "functions": [ { "name": "setAccessibilityEnabled", "type": "function", "description": "Enable or disable the accessibility extension api. This must be set to true before event listeners or getFocusedControl will work.", "parameters": [ { "type": "boolean", "name": "enabled", "description": "True if accessibility support should be enabled." } ] }, { "name": "getFocusedControl", "type": "function", "description": "Get information about the currently focused control.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "name": "control", "description": "Details of the currently focused control, or null if nothing is focused.", "choices": [ { "$ref": "AccessibilityObject" }, { "type": "null" } ] } ] } ] } ], "events": [ { "name": "onWindowOpened", "type": "function", "description": "Fired when a window is opened.", "parameters": [ { "$ref": "AccessibilityObject", "name": "window", "description": "Information about the window that was opened." } ] }, { "name": "onWindowClosed", "type": "function", "description": "Fired when a window is closed.", "parameters": [ { "$ref": "AccessibilityObject", "name": "window", "description": "Information about the window that was closed." } ] }, { "name": "onControlFocused", "type": "function", "description": "Fired when a control is focused.", "parameters": [ { "$ref": "AccessibilityObject", "name": "control", "description": "Details of the control that was focused." } ] }, { "name": "onControlAction", "type": "function", "description": "Fired when a control's action is taken, like pressing a button or toggling a checkbox.", "parameters": [ { "$ref": "AccessibilityObject", "name": "control", "description": "Details of the control whose action was taken." } ] }, { "name": "onTextChanged", "type": "function", "description": "Fired when text changes in an editable text control.", "parameters": [ { "$ref": "AccessibilityObject", "name": "control", "description": "Details of the control where the text changed." } ] }, { "name": "onMenuOpened", "type": "function", "description": "Fired when a menu is opened.", "parameters": [ { "$ref": "AccessibilityObject", "name": "menu", "description": "Information about the menu that was opened." } ] }, { "name": "onMenuClosed", "type": "function", "description": "Fired when a menu is closed.", "parameters": [ { "$ref": "AccessibilityObject", "name": "menu", "description": "Information about the menu that was closed." } ] } ] }, { "namespace": "experimental.extension", "nodoc": true, "types": [], "functions": [ { "name": "getPopupView", "type": "function", "description": "Returns a reference to the JavaScript 'window' object of the popup view. Returns undefined if no popup presently shown.", "parameters": [], "returns": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" }, "optional": true } } ], "events": [] }, { "namespace": "windows", "types": [ { "id": "Window", "type": "object", "properties": { "id": {"type": "integer", "minimum": 0, "description": "The ID of the window. Window IDs are unique within a browser session."}, "focused": {"type": "boolean", "description": "Whether the window is currently the focused window."}, "top": {"type": "integer", "description": "The offset of the window from the top edge of the screen in pixels."}, "left": {"type": "integer", "description": "The offset of the window from the left edge of the screen in pixels."}, "width": {"type": "integer", "description": "The width of the window in pixels."}, "height": {"type": "integer", "description": "The height of the window in pixels."}, "tabs": {"type": "array", "items": { "$ref": "Tab" }, "optional": true, "description": "Array of Tab objects representing the current tabs in the window."}, "incognito": {"type": "boolean", "description": "Whether the window is incognito."}, "type": { "type": "string", "description": "The type of browser window this is.", "enum": ["normal", "popup", "app"] } } } ], "properties": { "WINDOW_ID_NONE": { "type": "integer", "value": "-1", "description": "The windowId value that represents the absence of a chrome browser window." } }, "functions": [ { "name": "get", "type": "function", "description": "Gets details about a window.", "parameters": [ {"type": "integer", "name": "windowId", "minimum": 0}, { "type": "function", "name": "callback", "parameters": [ { "name": "window", "$ref": "Window" } ] } ] }, { "name": "getCurrent", "type": "function", "description": "Gets the current window.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "name": "window", "$ref": "Window" } ] } ] }, { "name": "getLastFocused", "type": "function", "description": "Gets the window that was most recently focused — typically the window 'on top'.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "name": "window", "$ref": "Window" } ] } ] }, { "name": "getAll", "type": "function", "description": "Gets all windows.", "parameters": [ { "type": "object", "name": "getInfo", "optional": true, "description": "", "properties": { "populate": {"type": "boolean", "optional": true, "description": "If true, each window object will have a tabs property that contains a list of the Tab objects for that window." } } }, { "type": "function", "name": "callback", "parameters": [ { "name": "windows", "type": "array", "items": { "$ref": "Window" } } ] } ] }, { "name": "create", "type": "function", "description": "Creates (opens) a new browser with any optional sizing, position or default URL provided.", "parameters": [ { "type": "object", "name": "createData", "properties": { "url": {"type": "string", "optional": true, "description": "The URL to navigate the first tab to. 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."}, "left": {"type": "integer", "optional": true, "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 focusd window."}, "top": {"type": "integer", "optional": true, "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 focusd window."}, "width": {"type": "integer", "minimum": 0, "optional": true, "description": "The width in pixels of the new window. If not specified defaults to a natural width."}, "height": {"type": "integer", "minimum": 0, "optional": true, "description": "The height in pixels of the new window. If not specified defaults to a natural height."}, "incognito": {"type": "boolean", "optional": true, "description": "Whether the new window should be an incognito window."}, "type": { "type": "string", "optional": true, "description": "Specifies what type of browser window to create.", "enum": ["normal", "popup"] } }, "optional": true }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "window", "$ref": "Window", "description": "Contains details about the created window.", "optional": true } ] } ] }, { "name": "update", "type": "function", "description": "Updates the properties of a window. Specify only the properties that you want to change; unspecified properties will be left unchanged.", "parameters": [ {"type": "integer", "name": "windowId", "minimum": 0}, { "type": "object", "name": "updateInfo", "properties": { "left": {"type": "integer", "optional": true, "description": "The offset from the left edge of the screen to move the window to in pixels."}, "top": {"type": "integer", "optional": true, "description": "The offset from the top edge of the screen to move the window to in pixels."}, "width": {"type": "integer", "minimum": 0, "optional": true, "description": "The width to resize the window to in pixels."}, "height": {"type": "integer", "minimum": 0, "optional": true, "description": "The height to resize the window to in pixels."} } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "window", "$ref": "Window" } ] } ] }, { "name": "remove", "type": "function", "description": "Removes (closes) a window, and all the tabs inside it.", "parameters": [ {"type": "integer", "name": "windowId", "minimum": 0}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] } ], "events": [ { "name": "onCreated", "type": "function", "description": "Fired when a window is created.", "parameters": [ { "$ref": "Window", "name": "window", "description": "Details of the window that was created." } ] }, { "name": "onRemoved", "type": "function", "description": "Fired when a window is removed (closed).", "parameters": [ {"type": "integer", "name": "windowId", "minimum": 0, "description": "ID of the removed window."} ] }, { "name": "onFocusChanged", "type": "function", "description": "Fired when the currently focused window changes. Will be chrome.windows.WINDOW_ID_NONE if all chrome windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one chrome window to another.", "parameters": [ {"type": "integer", "name": "windowId", "minimum": 0, "description": "ID of the newly focused window."} ] } ] }, { "namespace": "tabs", "types": [ { "id": "Tab", "type": "object", "properties": { "id": {"type": "integer", "minimum": 0, "description": "The ID of the tab. Tab IDs are unique within a browser session."}, "index": {"type": "integer", "minimum": 0, "description": "The zero-based index of the tab within its window."}, "windowId": {"type": "integer", "minimum": 0, "description": "The ID of the window the tab is contained within."}, "selected": {"type": "boolean", "description": "Whether the tab is selected."}, "url": {"type": "string", "description": "The URL the tab is displaying."}, "title": {"type": "string", "optional": true, "description": "The title of the tab. This may not be available if the tab is loading."}, "favIconUrl": {"type": "string", "optional": true, "description": "The URL of the tab's favicon. This may not be available if the tab is loading."}, "status": {"type": "string", "optional": true, "description": "Either loading or complete."}, "incognito": {"type": "boolean", "description": "Whether the tab is in an incognito window."} } } ], "functions": [ { "name": "get", "type": "function", "description": "Retrieves details about the specified tab.", "parameters": [ { "type": "integer", "name": "tabId", "minimum": 0 }, { "type": "function", "name": "callback", "parameters": [ {"name": "tab", "$ref": "Tab"} ] } ] }, { "name": "getCurrent", "type": "function", "description": "Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example: a background page or popup view).", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "name": "tab", "$ref": "Tab", "optional": true } ] } ] }, { "name": "connect", "type": "function", "description": "Connects to the content script(s) in the specified tab. The chrome.extension.onConnect event is fired in each content script running in the specified tab for the current extension. For more details, see Content Script Messaging.", "parameters": [ { "type": "integer", "name": "tabId", "minimum": 0 }, { "type": "object", "name": "connectInfo", "properties": { "name": { "type": "string", "optional": true, "description": "Will be passed into onConnect for content scripts that are listening for the connection event." } }, "optional": true } ], "returns": { "$ref": "Port", "description": "A port that can be used to communicate with the content scripts running in the specified tab." } }, { "name": "sendRequest", "type": "function", "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 chrome.extension.onRequest event is fired in each content script running in the specified tab for the current extension.", "parameters": [ { "type": "integer", "name": "tabId", "minimum": 0 }, { "type": "any", "name": "request" }, { "type": "function", "name": "responseCallback", "optional": true, "parameters": [ { "name": "response", "type": "any", "description": "The JSON response object sent by the handler of the request." } ] } ] }, { "name": "getSelected", "type": "function", "description": "Gets the tab that is selected in the specified window.", "parameters": [ { "type": "integer", "name": "windowId", "minimum": 0, "optional": true, "description": "Defaults to the current window." }, { "type": "function", "name": "callback", "parameters": [ {"name": "tab", "$ref": "Tab"} ] } ] }, { "name": "getAllInWindow", "type": "function", "description": "Gets details about all tabs in the specified window.", "parameters": [ { "type": "integer", "name": "windowId", "minimum": 0, "optional": true, "description": "Defaults to the current window." }, { "type": "function", "name": "callback", "parameters": [ {"name": "tabs", "type": "array", "items": { "$ref": "Tab" } } ] } ] }, { "name": "create", "type": "function", "description": "Creates a new tab.", "parameters": [ { "type": "object", "name": "createProperties", "properties": { "windowId": { "type": "integer", "minimum": 0, "optional": true, "description": "The window to create the new tab in. Defaults to the current window." }, "index": { "type": "integer", "minimum": 0, "optional": true, "description": "The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window." }, "url": { "type": "string", "optional": true, "description": "The URL to navigate the tab to initially. 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." }, "selected": { "type": "boolean", "optional": true, "description": "Whether the tab should become the selected tab in the window. Defaults to true" } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "tab", "$ref": "Tab", "description": "Details about the created tab. Will contain the ID of the new tab." } ] } ] }, { "name": "update", "type": "function", "description": "Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "updateProperties", "properties": { "url": {"type": "string", "optional": true}, "selected": {"type": "boolean", "optional": true} } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "tab", "$ref": "Tab", "description": "Details about the updated tab." } ] } ] }, { "name": "move", "type": "function", "description": "Moves a tab 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.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "moveProperties", "properties": { "windowId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the window the tab is currently in." }, "index": { "type": "integer", "minimum": 0, "description": "The position to move the window to. The provided value will be clamped to between zero and the number of tabs in the window." } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "tab", "$ref": "Tab", "description": "Details about the moved tab." } ] } ] }, { "name": "remove", "type": "function", "description": "Closes a tab.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "detectLanguage", "type": "function", "description": "Detects the primary language of the content in a tab.", "parameters": [ { "type": "integer", "name": "tabId", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." }, { "type": "function", "name": "callback", "parameters": [ { "type": "string", "name": "language", "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": "captureVisibleTab", "type": "function", "description": "Captures the visible area of the currently selected tab in the specified window.", "parameters": [ { "type": "integer", "name": "windowId", "minimum": 0, "optional": true, "description": "The target window. Defaults to the current window." }, { "type": "object", "name": "options", "optional": true, "min_version": "5.0.372.0", "description": "Set parameters of image capture, such as the format of the resulting image.", "properties": { "format": { "type": "string", "optional": true, "enum": ["jpeg", "png"], "description": "The format of the resulting image. Default is jpeg." }, "quality": { "type": "integer", "name": "quality", "optional": true, "minimum": 0, "maximum": 100, "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." } } }, { "type": "function", "name": "callback", "parameters": [ {"type": "string", "name": "dataUrl", "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": "executeScript", "type": "function", "description": "Injects JavaScript code into a page. For details, see the programmatic injection section of the content scripts doc.", "parameters": [ {"type": "integer", "name": "tabId", "optional": true, "description": "The ID of the tab in which to run the script; defaults to the selected tab of the current window."}, { "type": "object", "name": "details", "description": "Details of the script to run. Either the code or the file property must be set, but both may not be set at the same time.", "properties": { "code": {"type": "string", "optional": true, "description": "JavaScript code to execute."}, "file": {"type": "string", "optional": true, "description": "JavaScript file to execute."}, "allFrames": {"type": "boolean", "optional": true, "description": "If allFrames is true, this function injects script into all frames of current page. By default, it's false and script is injected only into the top main frame."} } }, { "type": "function", "name": "callback", "optional": true, "description": "Called after all the JavaScript has been executed.", "parameters": [] } ] }, { "name": "insertCSS", "type": "function", "description": "Injects CSS into a page. For details, see the programmatic injection section of the content scripts doc.", "parameters": [ {"type": "integer", "name": "tabId", "optional": true, "description": "The ID of the tab in which to insert the CSS; defaults to the selected tab of the current window."}, { "type": "object", "name": "details", "description": "Details of the CSS text to insert. Either the code or the file property must be set, but both may not be set at the same time.", "properties": { "code": {"type": "string", "optional": true, "description": "CSS code to be injected."}, "file": {"type": "string", "optional": true, "description": "CSS file to be injected."}, "allFrames": {"type": "boolean", "optional": true, "description": "If allFrames is true, this function injects CSS text into all frames of current page. By default, it's false and CSS is injected only into the top main frame."} } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when all the CSS has been inserted.", "parameters": [] } ] } ], "events": [ { "name": "onCreated", "type": "function", "description": "Fires when a tab is created.", "parameters": [ { "$ref": "Tab", "name": "tab", "description": "Details of the tab that was created." } ] }, { "name": "onUpdated", "type": "function", "description": "Fires when a tab is updated.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "changeInfo", "description": "Lists the changes to the state of the tab that was updated.", "properties": { "status": { "type": "string", "description": "The status of the tab. Can be either loading or complete." }, "url": { "type": "string", "optional": true, "description": "Only specified if the tab's URL changed." } } }, { "$ref": "Tab", "name": "tab", "description": "Gives the state of the tab that was updated." } ] }, { "name": "onMoved", "type": "function", "description": "Fires 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 onDetached.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "moveInfo", "properties": { "windowId": {"type": "integer", "minimum": 0}, "fromIndex": {"type": "integer", "minimum": 0}, "toIndex": {"type": "integer", "minimum": 0} } } ] }, { "name": "onSelectionChanged", "type": "function", "description": "Fires when the selected tab in a window changes.", "parameters": [ { "type": "integer", "name": "tabId", "minimum": 0, "description": "The ID of the tab that has become selected." }, { "type": "object", "name": "selectInfo", "properties": { "windowId": { "type": "integer", "minimum": 0, "description": "The ID of the window the selected tab changed inside of." } } } ] }, { "name": "onDetached", "type": "function", "description": "Fired when a tab is detached from a window, for example because it is being moved between windows.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "detachInfo", "properties": { "oldWindowId": {"type": "integer", "minimum": 0}, "oldPosition": {"type": "integer", "minimum": 0} } } ] }, { "name": "onAttached", "type": "function", "description": "Fired when a tab is attached to a window, for example because it was moved between windows.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "attachInfo", "properties": { "newWindowId": {"type": "integer", "minimum": 0}, "newPosition": {"type": "integer", "minimum": 0} } } ] }, { "name": "onRemoved", "type": "function", "description": "Fires when a tab is closed.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0} ] } ] }, { "namespace": "pageActions", "nodoc": true, "types": [], "functions": [ { "name": "enableForTab", "type": "function", "description": "Enables a page action for a particular tab+URL combination (makes its icon visible in the OmniBox when a certain URL is active in a given tab). The page action will automatically be disabled (its icon hidden) if the user navigates to a new URL or closes the tab. The action will also automatically be enabled/disabled as the user switches tabs.", "parameters": [ {"type": "string", "name": "pageActionId", "description": "An extension can have multiple page actions specified in the manifest, each with a unique identifier. This string identifies which page action you want to enable (and must match a page action id declared in the manifest)."}, { "type": "object", "name": "action", "description": "An object specifing what action should be applied to the page action. Contains the following properties:", "properties": { "tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to enable the page action."}, "url": {"type": "string", "description": "The URL of the page you want the page action to apply to. If the URL specified does not match the currently navigated URL (user has navigated to another page) then no action is taken."}, "title": {"type": "string", "optional": true, "description": "Specifying title allows you to change the tooltip that appears when you hover over the page action icon in the OmniBox. This parameter is optional and if omitted then the page action name property declared in the manifest is used."}, "iconId": {"type": "integer", "minimum": 0, "optional": true, "description": "A zero-based index into the icons vector specified in the manifest. This parameter is optional and if omitted then the first icon in the icons vector of the page action is used. This id is useful to represent different page action states. Example: An RSS feed icon could have a 'subscribe now' icon and an 'already subscribed' icon."} }, "optional": false } ] }, { "name": "disableForTab", "type": "function", "description": "Disables a page action for a particular tab+URL combination (makes its OmniBox page action icon hidden when a certain URL is active in a given tab). This can be useful to disable a page action before the user navigates away from a page containing an enabled page action.", "parameters": [ {"type": "string", "name": "pageActionId", "description": "An extension can have multiple page actions specified in the manifest, each with a unique identifier. This string identifies which page action you want to disable (and must match a page action id declared in the manifest)."}, { "type": "object", "name": "action", "description": "An object specifying what action should be applied to the page action. Contains the following properties:", "properties": { "tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to disable the page action."}, "url": {"type": "string", "description": "The URL of the page you want the page action to not apply to. If the URL specified does not match the currently navigated URL (user has navigated to another page) then no action is taken."} }, "optional": false } ] } ], "events": [] }, { "namespace": "pageAction", "types": [], "functions": [ { "name": "show", "type": "function", "description": "Shows the page action. The page action is shown whenever the tab is selected.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."} ] }, { "name": "hide", "type": "function", "description": "Hides the page action.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."} ] }, { "name": "setTitle", "type": "function", "description": "Sets the title of the page action. This is displayed in a tooltip over the page action.", "parameters": [ { "name": "details", "type": "object", "properties": { "tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."}, "title": {"type": "string", "description": "The tooltip string."} } } ] }, { "name": "setIcon", "type": "function", "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. Either the path or the imageData property must be specified.", "parameters": [ { "name": "details", "type": "object", "properties": { "tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."}, "imageData": { "type": "object", "isInstanceOf": "ImageData", "properties": {}, "additionalProperties": { "type": "any" }, "description": "Pixel data for an image. Must be an ImageData object (for example, from a canvas element).", "optional": true }, "path": { "type": "string", "description": "Relative path to an image in the extension to show in the browser action.", "optional": true }, "iconIndex": { "type": "integer", "minimum": 0, "description": "Deprecated. The zero-based index into the icons vector specified in the manifest.", "optional": true } } } ] }, { "name": "setPopup", "type": "function", "description": "Sets the html document to be opened as a popup when the user clicks on the page action's icon.", "min_version": "5.0.308.0", "parameters": [ { "name": "details", "type": "object", "properties": { "tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."}, "popup": { "type": "string", "description": "The html file to show in a popup. If set to the empty string (''), no popup is shown." } } } ] } ], "events": [ { "name": "onClicked", "perExtensionEvent": true, "type": "function", "description": "Fired when a page action icon is clicked. This event will not fire if the page action has a popup.", "parameters": [ { "name": "tab", "$ref": "Tab" } ] } ] }, { "namespace": "browserAction", "types": [], "functions": [ { "name": "setTitle", "type": "function", "description": "Sets the title of the browser action. This shows up in the tooltip.", "parameters": [ { "name": "details", "type": "object", "properties": { "title": { "type": "string", "description": "The string the browser action should display when moused over." }, "tabId": { "type": "integer", "optional": true, "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed." } } } ] }, { "name": "setIcon", "type": "function", "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. Either the path or the imageData property must be specified.", "parameters": [ { "name": "details", "type": "object", "properties": { "imageData": { "type": "object", "isInstanceOf": "ImageData", "properties": {}, "additionalProperties": { "type": "any" }, "description": "Pixel data for an image. Must be an ImageData object (for example, from a canvas element).", "optional": true }, "path": { "type": "string", "description": "Relative path to an image in the extension to show in the browser action.", "optional": true }, "tabId": { "type": "integer", "optional": true, "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed." } } } ] }, { "name": "setPopup", "type": "function", "min_version": "5.0.316.0", "description": "Sets the html document to be opened as a popup when the user clicks on the browser action's icon.", "parameters": [ { "name": "details", "type": "object", "properties": { "tabId": { "type": "integer", "optional": true, "minimum": 0, "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed." }, "popup": { "type": "string", "description": "The html file to show in a popup. If set to the empty string (''), no popup is shown." } } } ] }, { "name": "setBadgeText", "type": "function", "description": "Sets the badge text for the browser action. The badge is displayed on top of the icon.", "parameters": [ { "name": "details", "type": "object", "properties": { "text": { "type": "string", "description": "Any number of characters can be passed, but only about four can fit in the space." }, "tabId": { "type": "integer", "optional": true, "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed." } } } ] }, { "name": "setBadgeBackgroundColor", "type": "function", "description": "Sets the background color for the badge.", "parameters": [ { "name": "details", "type": "object", "properties": { "color": { "type": "array", "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].", "items": { "type": "integer", "minimum": 0, "maximum": 255 }, "minItems": 4, "maxItems": 4 }, "tabId": { "type": "integer", "optional": true, "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed." } } } ] } ], "events": [ { "name": "onClicked", "perExtensionEvent": true, "type": "function", "description": "Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.", "parameters": [ { "name": "tab", "$ref": "Tab" } ] } ] }, { "namespace": "experimental.infobars", "types": [], "functions": [ { "name": "show", "type": "function", "description": "Shows an infobar in the specified tab. The infobar will be closed automatically when the tab navigates. Use window.close() to close the infobar before then.", "parameters": [ { "name": "details", "type": "object", "properties": { "tabId": { "type": "integer", "description": "The tab id for the tab to display the infobar in." }, "path": { "type": "string", "description": "The html file that contains the infobar." } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "window", "$ref": "Window", "description": "Contains details about the window in which the infobar was created." } ] } ] } ] }, { "namespace": "bookmarks", "types": [ { "id": "BookmarkTreeNode", "type": "object", "description": "A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder.", "properties": { "id": {"type": "string", "minimum": 0, "description": "The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the browser is restarted."}, "parentId": {"type": "string", "minimum": 0, "optional": true, "description": "The id of the parent folder. Omitted for the root node."}, "index": {"type": "integer", "optional": true, "description": "The 0-based position of this node within its parent folder."}, "url": {"type": "string", "optional": true, "description": "The URL navigated to when a user clicks the bookmark. Omitted for folders."}, "title": {"type": "string", "description": "The text displayed for the node."}, "dateAdded": {"type": "number", "optional": true, "description": "When this node was created, in milliseconds since the epoch (new Date(dateAdded))."}, "dateGroupModified": {"type": "number", "optional": true, "description": "When the contents of this folder last changed, in milliseconds since the epoch."}, "children": {"type": "array", "optional": true, "items": {"$ref": "BookmarkTreeNode"}, "description": "An ordered list of children of this node."} } } ], "functions": [ { "name": "get", "type": "function", "description": "Retrieves the specified BookmarkTreeNode(s).", "parameters": [ { "name": "idOrIdList", "description": "A single string-valued id, or an array of string-valued ids", "choices": [ {"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1} ] }, { "type": "function", "name": "callback", "parameters": [ {"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} } ] } ] }, { "name": "getChildren", "type": "function", "description": "Retrieves the children of the specified BookmarkTreeNode id.", "parameters": [ {"type": "string", "name": "id"}, { "type": "function", "name": "callback", "parameters": [ {"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} } ] } ] }, { "name": "getRecent", "type": "function", "description": "Retrieves the recently added bookmarks.", "parameters": [ { "type": "integer", "minimum": 1, "name": "numberOfItems", "description": "The maximum number of items to return." }, { "type": "function", "name": "callback", "parameters": [ {"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} } ] } ] }, { "name": "getTree", "type": "function", "description": "Retrieves the entire Bookmarks hierarchy.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ {"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} } ] } ] }, { "name": "search", "type": "function", "description": "Searches for BookmarkTreeNodes matching the given query.", "parameters": [ {"type": "string", "name": "query"}, { "type": "function", "name": "callback", "parameters": [ {"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} } ] } ] }, { "name": "create", "type": "function", "description": "Creates a bookmark or folder under the specified parentId. If url is NULL or missing, it will be a folder.", "parameters": [ { "type": "object", "name": "bookmark", "properties": { "parentId": {"type": "string"}, "index": {"type": "integer", "minimum": 0, "optional": true}, "title": {"type": "string", "optional": true}, "url": {"type": "string", "optional": true} } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ {"name": "result", "$ref": "BookmarkTreeNode" } ] } ] }, { "name": "move", "type": "function", "description": "Moves the specified BookmarkTreeNode to the provided location.", "parameters": [ {"type": "string", "name": "id"}, { "type": "object", "name": "destination", "properties": { "parentId": {"type": "string"}, "index": {"type": "integer", "minimum": 0, "optional": true} } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ {"name": "result", "$ref": "BookmarkTreeNode" } ] } ] }, { "name": "update", "type": "function", "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.", "parameters": [ {"type": "string", "name": "id"}, { "type": "object", "name": "changes", "properties": { "title": {"type": "string", "optional": true}, "url": {"type": "string", "optional": true} } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ {"name": "result", "$ref": "BookmarkTreeNode" } ] } ] }, { "name": "remove", "type": "function", "description": "Removes a bookmark or an empty bookmark folder.", "parameters": [ {"type": "string", "name": "id"}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "removeTree", "type": "function", "description": "Recursively removes a bookmark folder.", "parameters": [ {"type": "string", "name": "id"}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "import", "type": "function", "description": "Imports bookmarks from a chrome html bookmark file", "nodoc": "true", "parameters": [ {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "export", "type": "function", "description": "Exports bookmarks to a chrome html bookmark file", "nodoc": "true", "parameters": [ {"type": "function", "name": "callback", "optional": true, "parameters": []} ] } ], "events": [ { "name": "onCreated", "type": "function", "description": "Fired when a bookmark or folder is created.", "parameters": [ {"type": "string", "name": "id"}, { "$ref": "BookmarkTreeNode", "name": "bookmark" } ] }, { "name": "onRemoved", "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.", "parameters": [ {"type": "string", "name": "id"}, { "type": "object", "name": "removeInfo", "properties": { "parentId": { "type": "string" }, "index": { "type": "integer" } } } ] }, { "name": "onChanged", "type": "function", "description": "Fired when a bookmark or folder changes. Note: Currently, only title and url changes trigger this.", "parameters": [ {"type": "string", "name": "id"}, { "type": "object", "name": "changeInfo", "properties": { "title": {"type": "string"}, "url": {"type": "string", "optional": true} } } ] }, { "name": "onMoved", "type": "function", "description": "Fired when a bookmark or folder is moved to a different parent folder.", "parameters": [ {"type": "string", "name": "id"}, { "type": "object", "name": "moveInfo", "properties": { "parentId": { "type": "string" }, "index": { "type": "integer" }, "oldParentId": { "type": "string" }, "oldIndex": { "type": "integer" } } } ] }, { "name": "onChildrenReordered", "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().", "parameters": [ {"type": "string", "name": "id"}, { "type": "object", "name": "reorderInfo", "properties": { "childIds": { "type": "array", "items": { "type": "string" } } } } ] }, { "name": "onImportBegan", "type": "function", "description": "Fired when a bookmark import session is begun. Expensive observers should ignore handleCreated updates until onImportEnded is fired. Observers should still handle other notifications immediately.", "parameters": [] }, { "name": "onImportEnded", "type": "function", "description": "Fired when a bookmark import session is ended.", "parameters": [] } ] }, { "namespace": "history", "types": [ { "id": "HistoryItem", "type": "object", "description": "An object encapsulating one result of a history query.", "properties": { "id": {"type": "string", "minimum": 0, "description": "The unique identifier for the item."}, "url": {"type": "string", "optional": true, "description": "The URL navigated to by a user."}, "title": {"type": "string", "optional": true, "description": "The title of the history page."}, "lastVisitTime": {"type": "number", "optional": true, "description": "When this page was last loaded, represented in milliseconds since the epoch."}, "visitCount": {"type": "integer", "optional": true, "description": "The number of times the user has navigated to this page."}, "typedCount": {"type": "integer", "optional": true, "description": "The number of times the user has navigated to this page by typing in the address."} } }, { "id": "VisitItem", "type": "object", "description": "An object encapsulating one visit to a URL.", "properties": { "id": {"type": "string", "minimum": 0, "description": "The unique identifier for the item."}, "visitId": {"type": "string", "description": "The unique identifier for this visit."}, "visitTime": {"type": "number", "optional": true, "description": "When this visit occurred, represented in milliseconds since the epoch."}, "referringVisitId": {"type": "string", "description": "The visit_id of the referrer."}, "transition": { "type": "string", "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"], "description": "The transition type for this visit from its referrer." } } } ], "functions": [ { "name": "search", "type": "function", "description": "Search the history for the last visit time of each page matching the query.", "parameters": [ { "name": "query", "type": "object", "properties": { "text": {"type": "string", "description": "A free-text query to the history service. Leave empty to retrieve all pages."}, "startTime": {"type": "number", "optional": true, "description": "Limit results to those visited after this date, represented in milliseconds since the epoch."}, "endTime": {"type": "number", "optional": true, "description": "Limit results to those visited before this date, represented in milliseconds since the epoch."}, "maxResults": {"type": "integer", "optional": true, "minimum": 0, "description": "The maximum number of results to retrieve. Defaults to 100."} } }, { "name": "callback", "type": "function", "parameters": [ { "name": "results", "type": "array", "items": { "$ref": "HistoryItem"} } ] } ] }, { "name": "getVisits", "type": "function", "description": "Retrieve information about visits to a URL.", "parameters": [ { "name": "details", "type": "object", "properties": { "url": {"type": "string", "description": "The URL for which to retrieve visit information. It must be in the format as returned from a call to history.search."} } }, { "name": "callback", "type": "function", "parameters": [ { "name": "results", "type": "array", "items": { "$ref": "VisitItem"} } ] } ] }, { "name": "addUrl", "type": "function", "description": "Adds a URL to the history at the current time with a transition type of \"link\".", "parameters": [ { "name": "details", "type": "object", "properties": { "url": {"type": "string", "description": "The URL to add."} } } ] }, { "name": "deleteUrl", "type": "function", "description": "Removes all occurrences of the given URL from the history.", "parameters": [ { "name": "details", "type": "object", "properties": { "url": {"type": "string", "description": "The URL to remove."} } } ] }, { "name": "deleteRange", "type": "function", "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.", "parameters": [ { "name": "range", "type": "object", "properties": { "startTime": { "type": "number", "description": "Items added to history after this date, represented in milliseconds since the epoch." }, "endTime": { "type": "number", "description": "Items added to history before this date, represented in milliseconds since the epoch." } } }, { "name": "callback", "type": "function", "parameters": [] } ] }, { "name": "deleteAll", "type": "function", "description": "Deletes all items from the history.", "parameters": [ { "name": "callback", "type": "function", "parameters": [] } ] } ], "events": [ { "name": "onVisited", "type": "function", "description": "Fired when a URL is visited, providing the HistoryItem data for that URL.", "parameters": [ { "name": "result", "$ref": "HistoryItem"} ] }, { "name": "onVisitRemoved", "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.", "parameters": [ { "name": "removed", "type": "object", "properties": { "allHistory": { "type": "boolean", "description": "True if all history was removed. If true, then urls will be empty." }, "urls": { "type": "array", "items": { "type": "string" }, "optional": true} } } ] } ] }, { "namespace": "experimental.idle", "nodoc": "true", "types": [], "functions": [ { "name": "queryState", "type": "function", "description": "Returns the current state of the browser.", "parameters": [ { "name": "threshold", "type": "integer", "minimum": 15, "description": "Threshold used to determine when a machine is in the idle state." }, { "name": "callback", "type": "function", "parameters": [ { "type": "string", "enum": ["active", "idle", "locked"] } ] } ] } ], "events": [ { "name": "onStateChanged", "type": "function", "description": "Fired when the browser changes to an active state. Currently only reports the transition from idle to active.", "parameters": [ { "type": "string", "enum": ["active"] } ] } ] }, { "namespace": "toolstrip", "nodoc": true, "types": [], "functions": [ { "name": "expand", "type": "function", "description": "", "parameters": [ { "type": "object", "name": "expandInfo", "properties": { "height": { "type": "integer", "minimum": 0, "description": "The vertical pixel height required of the toolstrip area." }, "url": { "type": "string", "optional": true, "description": "If present, the toolstrip mole will change it's content to the provided URL. Otherwise, the current page will just be expanded in size." } } }, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "collapse", "type": "function", "description": "", "parameters": [ { "type": "object", "name": "collapseInfo", "optional": true, "properties": { "url": { "type": "string", "optional": true, "description": "If present, the toolstrip mole will change it's content to the provided URL. Otherwise, the current page will just be collapsed in size." } } }, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] } ], "events": [] }, { "namespace": "i18n", "unprivileged": true, "types": [], "functions": [ { "name": "getAcceptLanguages", "type": "function", "description": "Gets the accept-languages of the browser. This is different from the locale used by the browser; to get the locale, use window.navigator.language.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ {"name": "languages", "type": "array", "items": {"type": "string"}, "description": "Array of the accept languages of the browser, such as en-US,en,zh-CN"} ] } ] }, { "name": "getMessage", "type": "function", "unprivileged": true, "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 is empty or has more than 9 elements — this method returns undefined.", "parameters": [ { "type": "string", "name": "messageName", "description": "The name of the message, as specified in the messages.json file." }, { "choices": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 9 } ], "name": "substitutions", "optional": true, "description": "1 - 9 substitution strings, if the message requires any." } ], "returns": { "type": "string", "description": "Message localized for current locale." } } ], "events": [] }, { "namespace": "experimental.popup", "nodoc": true, "types": [], "functions": [ { "name": "show", "type": "function", "description": "Displays a pop-up window hosting an extension view.", "parameters": [ { "type": "string", "name": "url", "description": "The URL of the contents to which the pop-up will be navigated." }, { "type": "object", "name": "showDetails", "properties": { "relativeTo": { "type": "object", "properties": {}, "additionalProperties": { "type": "any" }, "isInstanceOf": "HTMLElement", "description": "A HTML DOM object to which the pop-up's position will be made relative." }, "giveFocus": { "type": "boolean", "description": "Pass true to give the focus to the popup window. The default behaviour is true.", "optional": true }, "borderStyle": { "type": "string", "description": "Pass 'bubble' to give the pop-up window a bubble-chrome border, including an arrow pointing at the relative-to point. Pass 'rectangle' to give the pop-up a rectangular black border with drop-shadow. Default behaviour is to pass 'bubble'.", "optional": true, "enum": ["bubble", "rectangle"] } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [] } ] }, { "name": "getParentWindow", "type": "function", "description": "Returns a reference to the JavaScript 'window' object of the extension view that launched the popup. Returns undefined if called outside of a popup window.", "parameters": [], "returns": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" }, "optional": true } } ], "events": [ { "name": "onClosed", "type": "function", "description": "Fired when the popup view is closed.", "parameters": [] } ] }, { "namespace": "experimental.bookmarkManager", "nodoc": true, "types": [ { "id": "BookmarkDragDataElement", "nodoc": true, "type": "object", "properties": { "id": { "type": "string", "optional": true, "description": "The ID of the bookmark. This is only provided if the data is from the same profile." }, "parentId": { "type": "string", "optional": true, "description": "The ID of the parent of the bookmark. This is only provided if the data is from the same profile." }, "title": {"type": "string"}, "url": { "type": "string", "optional": true }, "children": { "type": "array", "items": {"$ref": "BookmarkDragDataElement"} } } }, { "id": "BookmarkDragData", "nodoc": true, "type": "object", "description": "Information about the drag and drop data for use with drag and drop events.", "properties": { "sameProfile": {"type": "boolean"}, "elements": { "type": "array", "items": {"$ref": "BookmarkDragDataElement"} } } } ], "functions": [ { "name": "copy", "type": "function", "description": "Copies the given bookmarks into the clipboard", "nodoc": "true", "parameters": [ { "name": "idList", "description": "An array of string-valued ids", "type": "array", "items": {"type": "string"}, "minItems": 1 }, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "cut", "type": "function", "description": "Cuts the given bookmarks into the clipboard", "nodoc": "true", "parameters": [ { "name": "idList", "description": "An array of string-valued ids", "type": "array", "items": {"type": "string"}, "minItems": 1 }, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "paste", "type": "function", "description": "Pastes bookmarks from the clipboard into the parent folder", "nodoc": "true", "parameters": [ {"type": "string", "name": "parentId"}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "canPaste", "type": "function", "description": "Whether there are any bookmarks that can be pasted", "nodoc": "true", "parameters": [ {"type": "string", "name": "parentId", "description": "The ID of the folder to paste into"}, {"type": "function", "name": "callback", "parameters": [ {"type": "boolean"} ]} ] }, { "name": "sortChildren", "type": "function", "description": "Sorts the children of a given folder", "nodoc": "true", "parameters": [ {"type": "string", "name": "parentId", "description": "The ID of the folder to sort the children of"} ] }, { "name": "getStrings", "type": "function", "description": "Gets the i18n strings for the bookmark manager", "nodoc": "true", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "type": "object", "properties": {}, "additionalProperties": {"type": "string"} } ] } ] }, { "name": "startDrag", "type": "function", "description": "Begins dragging a set of bookmarks", "nodoc": "true", "parameters": [ { "name": "idList", "description": "An array of string-valued ids", "type": "array", "items": {"type": "string"}, "minItems": 1 } ] }, { "name": "drop", "type": "function", "description": "Performs the drop action of the drag and drop session", "nodoc": "true", "parameters": [ { "name": "parentId", "description": "The ID of the folder that the drop was made", "type": "string" }, { "name": "index", "description": "The index of the position to drop at. If left out the dropped items will be placed at the end of the existing children", "type": "integer", "minimum": 0, "optional": true } ] }, { "name": "getSubtree", "type": "function", "description": "Retrieves a bookmark hierarchy from the given node. If the node id is empty, it is the full tree. If foldersOnly is true, it will only return folders, not actual bookmarks.", "nodoc": "true", "parameters": [ { "name": "id", "type": "string", "description": "ID of the root of the tree to pull. If empty, the entire tree will be returned." }, { "name": "foldersOnly", "type": "boolean", "description": "Pass true to only return folders." }, { "name": "callback", "type": "function", "parameters": [ {"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} } ] } ] } ], "events": [ { "name": "onDragEnter", "type": "function", "description": "Fired when dragging bookmarks over the document", "parameters": [ {"$ref": "BookmarkDragData"} ] }, { "name": "onDragLeave", "type": "function", "description": "Fired when the drag and drop leaves the document", "parameters": [ {"$ref": "BookmarkDragData"} ] }, { "name": "onDrop", "type": "function", "description": "Fired when the user drops bookmarks on the document", "parameters": [ {"$ref": "BookmarkDragData"} ] } ] }, { "namespace": "devtools", "nodoc": "true", "types": [], "functions": [ { "name": "getTabEvents", "type": "function", "description": "Experimental support for timeline API", "nodoc": "true", "parameters": [ { "name": "tab_id", "type": "integer" } ], "returns": { "type": "object", "properties": {}, "additionalProperties": { "type": "any" }, "description": "DevTools tab events object" } } ] }, { "namespace": "experimental.processes", "types": [ { "id": "Process", "type": "object", "description": "An object containing information about one of the browser's processes.", "properties": { "id": { "type": "integer", "description": "The internal ID of the process." } } } ], "functions": [ { "name": "getProcessForTab", "type": "function", "description": "Returns details about the current renderer process of the specified tab.", "parameters": [ { "name": "tabId", "type": "integer", "minimum": 0 }, { "type": "function", "name": "callback", "parameters": [ { "name": "process", "$ref": "Process", "description": "Details about the tab's process." } ] } ] } ], "events": [] }, { "namespace": "experimental.contextMenu", "types": [], "functions": [ { "name": "create", "type": "function", "description": "An API to add items to context menus.", "parameters": [ { "type": "object", "name": "createProperties", "properties": { "type": { "type": "string", "optional": true, "description": "The type of menu item - one of 'NORMAL', 'CHECKBOX', 'RADIO', or 'SEPARATOR'. Defaults to 'NORMAL' if not specified." }, "title": { "type": "string", "optional": "true", "description": "This must be specified unless type is 'SEPARATOR'." }, "checked": { "type": "boolean", "optional": true, "description": " For items of type CHECKBOX or RADIO, should this be selected (RADIO) or checked (CHECKBOX)? Only one RADIO item can be selected at a time in a given group of RADIO items, with the last one to have checked == true winning." }, "contexts": { "type": "array", "items": {"type": "string"}, "minItems": 1, "optional": true, "description": "List of contexts this menu item will appear in. Legal values are: 'ALL', 'PAGE', 'SELECTION', 'LINK', 'EDITABLE', 'IMAGE', 'VIDEO', and 'AUDIO'. Defaults to ['PAGE']." }, "enabledContexts": { "type": "array", "optional": true, "items": {"type": "string"}, "minItems": 1, "description": "By default the values you pass for the contexts parameter make an item both shown and selectable in those contexts. If you want to limit the contexts where an item is selectable (i.e. not greyed out), you put the ones you want selectable in enabledContexts and any not listed will be shown but disabled. So, for example, if you wanted an item to appear for links and images but only be enabled for links, you would set 'contexts' : ['LINK', 'IMAGE'] and 'enabledContexts' : ['LINK']." }, "onclick": { "type": "function", "optional": true, "description": "Function to be called back when your menu item or one of its children is clicked." }, "parentId": { "type": "integer", "optional": true, "description": "The id of a parent menu item - this makes the item a child of a previously added item." } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "menuItemId", "type": "integer", "description": "The id of the newly created context menu item." } ] } ] }, { "name": "update", "type": "function", "description": "Update a previously created context menu item.", "parameters": [ { "type": "integer", "name": "id", "description": "The id of the item to update." }, { "type": "object", "name": "updateProperties", "description": "The properties to update. Accepts the same values as the create function.", "properties": { "type": { "type": "string", "optional": true }, "title": { "type": "string", "optional": "true" }, "checked": { "type": "boolean", "optional": true }, "contexts": { "type": "array", "items": {"type": "string"}, "minItems": 1, "optional": true }, "enabledContexts": { "type": "array", "optional": true, "items": {"type": "string"}, "minItems": 1 }, "onclick": { "type": "function", "optional": true }, "parentId": { "type": "integer", "optional": true, "description": "Note: you cannot change an item to be a child of one of it's own descendants." } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [], "description": "Called when the context menu has been updated." } ] }, { "name": "remove", "type": "function", "description": "Remove a context menu item.", "parameters": [ { "type": "integer", "name": "menuItemId", "description": "The id of the context menu item to remove." }, { "type": "function", "name": "callback", "optional": true, "parameters": [], "description": "Called when the context menu has been removed." } ] }, { "name": "removeAll", "type": "function", "description": "Remove all context menu items added by this extension.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "parameters": [], "description": "Called when removal is complete." } ] } ] }, { "namespace": "experimental.metrics", "nodoc": true, "types": [ { "id": "MetricType", "type": "object", "description": "Describes the type of metric that is to be collected.", "properties": { "metricName": {"type": "string", "description": "A unique name within the extension for the metric."}, "type": { "type": "string", "enum": ["histogram-log", "histogram-linear"], "description": "The type of metric, such as 'histogram-log' or 'histogram-linear'." }, "min": {"type": "integer", "description": "The minimum sample value to be recoded. Must be greater than zero."}, "max": {"type": "integer", "description": "The maximum sample value to be recoded."}, "buckets": {"type": "integer", "description": "The number of buckets to use when separating the recorded values."} } } ], "functions": [ { "name": "recordUserAction", "type": "function", "description": "Records an action performed by the user.", "parameters": [ {"name": "name", "type": "string"} ] }, { "name": "recordPercentage", "type": "function", "description": "Record a percentage value from 1 to 100.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordCount", "type": "function", "description": "Record a value than can range from 1 to 1,000,000.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordSmallCount", "type": "function", "description": "Record a value than can range from 1 to 100.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordMediumCount", "type": "function", "description": "Record a value than can range from 1 to 10,000.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordTime", "type": "function", "description": "Record an elapsed time of no more than 10 seconds. The sample value is specified in milliseconds.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordMediumTime", "type": "function", "description": "Record an elapsed time of no more than 3 minutes. The sample value is specified in milliseconds.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordLongTime", "type": "function", "description": "Record an elapsed time of no more than 1 hour. The sample value is specified in milliseconds.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordValue", "type": "function", "unprivileged": true, "description": "Adds a value to the given metric.", "parameters": [ {"name": "metric", "$ref": "MetricType"}, {"name": "value", "type": "integer"} ] } ], "events": [] }, { "namespace": "experimental.cookies", "types": [ { "id": "Cookie", "type": "object", "description": "Represents information about an HTTP cookie.", "properties": { "name": {"type": "string", "description": "The name of the cookie."}, "value": {"type": "string", "description": "The value of the cookie."}, "domain": {"type": "string", "description": "The domain of the cookie (e.g. \"www.google.com\", \"example.com\")."}, "hostOnly": {"type": "boolean", "description": "True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie)."}, "path": {"type": "string", "description": "The path of the cookie."}, "secure": {"type": "boolean", "description": "True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS)."}, "httpOnly": {"type": "boolean", "description": "True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts)."}, "session": {"type": "boolean", "description": "True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date."}, "expirationDate": {"type": "number", "optional": true, "description": "The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies."}, "storeId": {"type": "string", "description": "The ID of the cookie store containing this cookie, as provided in getAllCookieStores()."} } }, { "id": "CookieStore", "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.", "properties": { "id": {"type": "string", "description": "The unique identifier for the cookie store."}, "tabIds": {"type": "array", "items": {"type": "integer"}, "description": "Identifiers of all the browser tabs that share this cookie store."} } } ], "functions": [ { "name": "get", "type": "function", "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 domain property will be returned. For cookies with the same domain property length, the one with the longest path length will be returned. If domains and paths are equal, then the cookie with the earliest creation time will be returned.", "parameters": [ { "type": "object", "name": "details", "description": "Details to identify the cookie being retrieved.", "properties": { "url": {"type": "string", "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."}, "name": {"type": "string", "description": "The name of the cookie to retrieve."}, "storeId": {"type": "string", "optional": true, "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."} } }, { "type": "function", "name": "callback", "parameters": [ { "name": "cookie", "$ref": "Cookie", "optional": true, "description": "Contains details about the cookie. This parameter is null if no such cookie was found." } ] } ] }, { "name": "getAll", "type": "function", "description": "Retrieves all cookies from a single cookie store that match the given information.", "parameters": [ { "type": "object", "name": "details", "description": "Information to filter the cookies being retrieved.", "properties": { "url": {"type": "string", "optional": true, "description": "Restricts the retrieved cookies to those that would match the given URL."}, "name": {"type": "string", "optional": true, "description": "Filters the cookies by name."}, "domain": {"type": "string", "optional": true, "description": "Restricts the retrieved cookies to those whose domains match or are subdomains of this one."}, "path": {"type": "string", "optional": true, "description": "Restricts the retrieved cookies to those whose path exactly matches this string."}, "secure": {"type": "boolean", "optional": true, "description": "Filters the cookies by their Secure property."}, "session": {"type": "boolean", "optional": true, "description": "Filters out session vs. persistent cookies."}, "storeId": {"type": "string", "optional": true, "description": "The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used."} } }, { "type": "function", "name": "callback", "parameters": [ { "name": "cookies", "type": "array", "items": {"$ref": "Cookie"}, "description": "All the existing, unexpired cookies that match the given cookie info." } ] } ] }, { "name": "set", "type": "function", "description": "Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.", "parameters": [ { "type": "object", "name": "details", "description": "Details about the cookie being set.", "properties": { "url": {"type": "string", "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."}, "name": {"type": "string", "optional": true, "description": "The name of the cookie. Empty by default if omitted."}, "value": {"type": "string", "optional": true, "description": "The value of the cookie. Empty by default if omitted."}, "domain": {"type": "string", "optional": true, "description": "The domain of the cookie. If omitted, the cookie becomes a host-only cookie."}, "path": {"type": "string", "optional": true, "description": "The path of the cookie. Defaults to the path portion of the url parameter."}, "secure": {"type": "boolean", "optional": true, "description": "Whether the cookie should be marked as Secure. Defaults to false."}, "httpOnly": {"type": "boolean", "optional": true, "description": "Whether the cookie should be marked as HttpOnly. Defaults to false."}, "expirationDate": {"type": "number", "optional": true, "description": "The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie."}, "storeId": {"type": "string", "optional": true, "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."} } } ] }, { "name": "remove", "type": "function", "description": "Deletes a cookie by name.", "parameters": [ { "type": "object", "name": "details", "description": "Information to identify the cookie to remove.", "properties": { "url": {"type": "string", "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."}, "name": {"type": "string", "description": "The name of the cookie to remove."}, "storeId": {"type": "string", "optional": true, "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."} } } ] }, { "name": "getAllCookieStores", "type": "function", "description": "Lists all existing cookie stores.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "name": "cookieStores", "type": "array", "items": {"$ref": "CookieStore"}, "description": "All the existing cookie stores." } ] } ] } ], "events": [ { "name": "onChanged", "type": "function", "description": "Fired when a cookie is set or removed.", "parameters": [ { "type": "object", "name": "changeInfo", "properties": { "removed": {"type": "boolean", "description": "True if a cookie was removed."}, "cookie": {"$ref": "Cookie", "description": "Information about the cookie that was set or removed."} } } ] } ] }, { "namespace": "experimental.rlz", "nodoc": true, "types": [], "functions": [ { "name": "recordProductEvent", "type": "function", "description": "Records an RLZ event for a given product's access point.", "parameters": [ {"name": "product", "type": "string", "minLength": 1, "maxLength": 1}, {"name": "accessPoint", "type": "string", "minLength": 1, "maxLength": 2}, {"name": "event", "type": "string", "enum": ["install", "set-to-google", "first-search", "activate"]} ] }, { "name": "getAccessPointRlz", "type": "function", "description": "Gets the RLZ string to be used when accessing a Google property through the given access point.", "parameters": [ {"name": "accessPoint", "type": "string", "minLength": 1, "maxLength": 2}, {"name": "callback", "type": "function", "parameters": [{"name": "rlz", "type": "string"}]} ] }, { "name": "clearProductState", "type": "function", "description": "Clears all product-specific RLZ state from the machine, as well as clearing all events for the specified access points.", "parameters": [ {"name": "product", "type": "string", "minLength": 1, "maxLength": 1}, {"name": "accessPoints", "type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 2}, "minItems": 1} ] } ], "events": [] }, { "namespace": "test", "nodoc": true, "types": [], "functions": [ { "name": "notifyFail", "type": "function", "description": "Notify the browser process that test code running in the extension failed. This is only used for internal unit testing.", "parameters": [ {"type": "string", "name": "message"} ] }, { "name": "notifyPass", "type": "function", "description": "Notify the browser process that test code running in the extension passed. This is only used for internal unit testing.", "parameters": [ {"type": "string", "name": "message", "optional": true} ] }, { "name": "resetQuota", "type": "function", "description": "Reset all accumulated quota state for all extensions. This is only used for internal unit testing.", "parameters": [] }, { "name": "log", "type": "function", "description": "Logs a message during internal unit testing.", "parameters": [ {"type": "string", "name": "message"} ] }, { "name": "createIncognitoTab", "type": "function", "description": "Creates an incognito tab during internal testing. Succeeds even if the extension is not enabled in incognito mode.", "parameters": [ {"type": "string", "name": "url"} ] } ], "events": [ { "name": "onMessage", "type": "function", "unprivileged": true, "description": "Used to test sending messages to extensions.", "parameters": [ { "type": "object", "name": "info", "properties": { "data": { "type": "string", "description": "Additional information." }, "lastMessage": { "type": "boolean", "description": "True if this was the last message for this test" } } } ] } ] }, { "namespace": "experimental.clipboard", "types": [], "functions": [ { "name": "executeCopy", "type": "function", "description": "Triggers a copy operation in the specified tab.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "executeCut", "type": "function", "description": "Triggers a cut operation in the specified tab.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { "name": "executePaste", "type": "function", "description": "Triggers a paste operation in the specified tab.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, {"type": "function", "name": "callback", "optional": true, "parameters": []} ] } ], "events": [] }, { "namespace": "experimental.omnibox", "types": [ { "id": "SuggestResult", "type": "object", "description": "A suggest result.", "properties": { "content": { "type": "string", "minLength": 1, "description": "The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry." }, "description": { "type": "string", "minLength": 1, "description": "The text that is displayed in the URL dropdown. Can optionally be stylized by the descriptionStyles parameter." }, "descriptionStyles": { "type": "array", "optional": true, "items": { "type": "object", "description": "A style object, created using styleNone, styleMatch, or styleDim. A style applies to the region of text starting at the style's offset, until either the next style or the end of the description.", "properties": { "type": {"type": "string", "enum": ["none", "match", "dim"]}, "offset": {"type": "integer"} } } } } } ], "functions": [ { "name": "sendSuggestions", "nodoc": true, "type": "function", "description": "A callback passed to the onInputChanged event used for sending suggestions back to the browser.", "parameters": [ {"type": "integer", "name": "requestId"}, { "type": "array", "description": "Array of suggest results", "items": { "$ref": "SuggestResult" } } ] }, { "name": "styleNone", "type": "function", "description": "Constructor for the descriptionStyles parameter of the suggest callback.", "parameters": [ {"type": "integer", "name": "offset", "minimum": 0} ] }, { "name": "styleMatch", "type": "function", "description": "Constructor for the descriptionStyles parameter of the suggest callback. This style designates a region of text matching what the user typed.", "parameters": [ {"type": "integer", "name": "offset", "minimum": 0} ] }, { "name": "styleDim", "type": "function", "description": "Constructor for the descriptionStyles parameter of the suggest callback. This style designates a region of dim helper text.", "parameters": [ {"type": "integer", "name": "offset", "minimum": 0} ] } ], "events": [ { "name": "onInputStarted", "perExtensionEvent": true, "type": "function", "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.", "parameters": [] }, { "name": "onInputChanged", "perExtensionEvent": true, "type": "function", "description": "User has changed what is typed into the omnibox.", "parameters": [ { "type": "string", "name": "text" }, { "name": "suggest", "type": "function", "description": "A callback passed to the onInputChanged event used for sending suggestions back to the browser.", "parameters": [ {"type": "integer", "name": "requestId"}, { "type": "array", "description": "Array of suggest results", "items": { "$ref": "SuggestResult" } } ] } ] }, { "name": "onInputEntered", "perExtensionEvent": true, "type": "function", "description": "User has accepted what is typed into the omnibox.", "parameters": [ { "type": "string", "name": "text" } ] }, { "name": "onInputCancelled", "perExtensionEvent": true, "type": "function", "description": "User has ended the keyword input session without accepting the input.", "parameters": [] } ] } ]