[ { "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, "unprivileged": 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." } } }, "inIncognitoContext": { "type": "boolean", "optional": true, "unprivileged": true, "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." } }, "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. The port's onDisconnect event is fired if extension does not exist. " } }, { "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. The chrome.extension.onRequest event is fired in each page of the extension.", "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. If an error occurs while connecting to the extension, the callback will be called with no arguments and chrome.extension.lastError will be set to the error message." } ] } ] }, { "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 its 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 background 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" } } } }, { "name": "isAllowedIncognitoAccess", "type": "function", "description": "Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.", "min_version": "12.0.706.0", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "name": "isAllowedAccess", "type": "boolean", "description": "True if the extension has access to Incognito mode, false otherwise." } ] } ] }, { "name": "isAllowedFileSchemeAccess", "type": "function", "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.", "min_version": "12.0.706.0", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "name": "isAllowedAccess", "type": "boolean", "description": "True if the extension can access the 'file://' scheme, false otherwise." } ] } ] }, { "name": "setUpdateUrlData", "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 Chrome Extension Gallery.", "parameters": [ {"type": "string", "name": "data", "maxLength": 1024} ] } ], "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": "Enables or disables 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": "Gets 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": "tts", "types": [ { "id": "TtsEvent", "type": "object", "description": "An event from the TTS engine to communicate the status of an utterance.", "properties": { "type": { "type": "string", "enum": ["start", "end", "word", "sentence", "marker", "interrupted", "cancelled", "error"], "description": "The type can be 'start' as soon as speech has started, 'word' when a word boundary is reached, 'sentence' when a sentence boundary is reached, 'marker' when an SSML mark element is reached, 'end' when the end of the utterance is reached, 'interrupted' when the utterance is stopped or interrupted before reaching the end, 'cancelled' when it's removed from the queue before ever being synthesized, or 'error' when any other error occurs." }, "charIndex": { "type": "number", "optional": true, "description": "The index of the current character in the utterance." }, "errorMessage": { "type": "string", "description": "The error description, if the event type is 'error'.", "optional": true }, "srcId": { "type": "number", "description": "An ID unique to the calling function's context so that events can get routed back to the correct tts.speak call.", "nodoc": true, "optional": true }, "isFinalEvent": { "type": "boolean", "description": "True if this is the final event that will be sent to this handler.", "nodoc": true, "optional": true } } }, { "id": "TtsVoice", "type": "object", "description": "A description of a voice available for speech synthesis.", "properties": { "voiceName": { "type": "string", "optional": true, "description": "The name of the voice." }, "lang": { "type": "string", "optional": true, "description": "The language that this voice supports, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'." }, "gender": { "type": "string", "optional": true, "description": "This voice's gender.", "enum": ["male", "female"] }, "extensionId": { "type": "string", "optional": true, "description": "The ID of the extension providing this voice." }, "eventTypes": { "type": "array", "items": {"type": "string"}, "optional": true, "description": "All of the callback event types that this voice is capable of sending." } } } ], "functions": [ { "name": "speak", "type": "function", "description": "Speaks text using a text-to-speech engine.", "parameters": [ { "type": "string", "name": "utterance", "description": "The text to speak, either plain text or a complete, well-formed SSML document. Speech engines that do not support SSML will strip away the tags and speak the text. The maximum length of the text is 32,768 characters." }, { "type": "object", "name": "options", "optional": true, "description": "The speech options.", "properties": { "enqueue": { "type": "boolean", "optional": true, "description": "If true, enqueues this utterance if TTS is already in progress. If false (the default), interrupts any current speech and flushes the speech queue before speaking this new utterance." }, "voiceName": { "type": "string", "optional": true, "description": "The name of the voice to use for synthesis. If empty, uses any available voice." }, "extensionId": { "type": "string", "optional": true, "description": "The extension ID of the speech engine to use, if known." }, "lang": { "type": "string", "optional": true, "description": "The language to be used for synthesis, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'." }, "gender": { "type": "string", "optional": true, "description": "Gender of voice for synthesized speech.", "enum": ["male", "female"] }, "rate": { "type": "number", "optional": true, "minimum": 0.1, "maximum": 10, "description": "Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. Values below 0.1 or above 10.0 are strictly disallowed, but many voices will constrain the minimum and maximum rates further—for example a particular voice may not actually speak faster than 3 times normal even if you specify a value larger than 3.0." }, "pitch": { "type": "number", "optional": true, "minimum": 0, "maximum": 2, "description": "Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to a voice's default pitch." }, "volume": { "type": "number", "optional": true, "minimum": 0, "maximum": 1, "description": "Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0." }, "requiredEventTypes": { "type": "array", "items": {"type": "string"}, "optional": true, "description": "The TTS event types the voice must support." }, "desiredEventTypes": { "type": "array", "items": {"type": "string"}, "optional": true, "description": "The TTS event types that you are interested in listening to. If missing, all event types may be sent." }, "onEvent": { "type": "function", "optional": true, "description": "This function is called with events that occur in the process of speaking the utterance.", "parameters": [ { "name": "event", "$ref": "TtsEvent", "description": "The update event from the text-to-speech engine indicating the status of this utterance." } ] } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called right away, before speech finishes. Check chrome.extension.lastError to make sure there were no errors. Use options.onEvent to get more detailed feedback.", "parameters": [] } ] }, { "name": "stop", "type": "function", "description": "Stops any current speech.", "parameters": [] }, { "name": "isSpeaking", "type": "function", "description": "Checks if the engine is currently speaking.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "parameters": [ { "name": "speaking", "type": "boolean", "description": "True if speaking, false otherwise." } ] } ] }, { "name": "getVoices", "type": "function", "description": "Gets an array of all available voices.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "parameters": [ { "type": "array", "name": "voices", "items": { "$ref": "TtsVoice" }, "description": "Array of $ref:TtsVoice objects representing the available voices for speech synthesis." } ] } ] } ], "events": [ { "name": "onEvent", "type": "function", "nodoc": true, "parameters": [ { "name": "event", "$ref": "TtsEvent", "description": "The event from the text-to-speech engine indicating the status of this utterance." } ], "description": "Used to pass events back to the function calling speak()." } ] }, { "namespace": "ttsEngine", "functions": [ { "name": "sendTtsEvent", "nodoc": true, "type": "function", "description": "Routes a TTS event from a speech engine to a client.", "parameters": [ { "type": "integer", "name": "requestId" }, { "name": "event", "$ref": "TtsEvent", "description": "The update event from the text-to-speech engine indicating the status of this utterance." } ] } ], "events": [ { "name": "onSpeak", "type": "function", "description": "Called when the user makes a call to tts.speak() and one of the voices from this extension's manifest is the first to match the options object.", "parameters": [ { "type": "string", "name": "utterance", "description": "The text to speak, specified as either plain text or an SSML document. If your engine does not support SSML, you should strip out all XML markup and synthesize only the underlying text content. The value of this parameter is guaranteed to be no more than 32,768 characters. If this engine does not support speaking that many characters at a time, the utterance should be split into smaller chunks and queued internally without returning an error." }, { "type": "object", "name": "options", "description": "Options specified to the tts.speak() method.", "properties": { "voiceName": { "type": "string", "optional": true, "description": "The name of the voice to use for synthesis." }, "lang": { "type": "string", "optional": true, "description": "The language to be used for synthesis, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'." }, "gender": { "type": "string", "optional": true, "description": "Gender of voice for synthesized speech.", "enum": ["male", "female"] }, "rate": { "type": "number", "optional": true, "minimum": 0.1, "maximum": 10.0, "description": "Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. This value is guaranteed to be between 0.1 and 10.0, inclusive. When a voice does not support this full range of rates, don't return an error. Instead, clip the rate to the range the voice supports." }, "pitch": { "type": "number", "optional": true, "minimum": 0, "maximum": 2, "description": "Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to this voice's default pitch." }, "volume": { "type": "number", "optional": true, "minimum": 0, "maximum": 1, "description": "Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0." } } }, { "name": "sendTtsEvent", "type": "function", "description": "Call this function with events that occur in the process of speaking the utterance.", "parameters": [ { "name": "event", "$ref": "TtsEvent", "description": "The event from the text-to-speech engine indicating the status of this utterance." } ] } ] }, { "name": "onStop", "type": "function", "description": "Fired when a call is made to tts.stop and this extension may be in the middle of speaking. If an extension receives a call to onStop and speech is already stopped, it should do nothing (not raise an error)." } ] }, { "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 $ref: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. The 'panel' type requires the 'experimental' permission.", "enum": ["normal", "popup", "panel", "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 $ref: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", "description": "A URL or list 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, "choices": [ {"type": "string"}, {"type": "array", "items": {"type": "string"}} ] }, "tabId": {"type": "integer", "minimum": 0, "optional": true, "description": "The id of the tab for which you want to adopt to the new window."}, "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."}, "focused": {"type": "boolean", "optional": true, "description": "If true, opens an active window. If false, opens an inactive window."}, "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. The 'panel' type requires the 'experimental' permission.", "enum": ["normal", "popup", "panel"] } }, "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."}, "focused": {"type": "boolean", "optional": true, "description": "If true, brings the window to the front. If false, brings the next window in the z-order to the front."}, "drawAttention": {"type": "boolean", "optional": true, "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 set to false or if the window already has focus."} } }, { "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": "experimental.permissions", "types": [ { "id": "Permissions", "type": "object", "properties": { "permissions": { "type": "array", "items": {"type": "string"}, "optional": true, "description": "List of named permissions (does not include hosts or origins)." } } } ], "events": [ { "name": "onAdded", "type": "function", "unprivileged": true, "description": "Fired when the extension acquires new permissions.", "parameters": [ { "$ref": "Permissions", "name": "permissions", "description": "The newly acquired permissions." } ] }, { "name": "onRemoved", "type": "function", "unprivileged": true, "description": "Fired when access to permissions has been removed from the extension.", "parameters": [ { "$ref": "Permissions", "name": "permissions", "description": "The permissions that have been removed." } ] } ], "functions": [ { "name": "getAll", "type": "function", "unprivileged": true, "description": "Gets the extension's current set of permissions.", "parameters": [ { "name": "callback", "type": "function", "parameters": [ { "name": "permissions", "$ref": "Permissions", "description": "The extension's active permissions." } ] } ] }, { "name": "contains", "type": "function", "unprivileged": true, "description": "Checks if the extension has the specified permissions.", "parameters": [ { "name": "permissions", "$ref": "Permissions" }, { "name": "callback", "type": "function", "parameters": [ { "name": "result", "type": "boolean", "description": "True if the extension has the specified permissions." } ] } ] }, { "name": "request", "type": "function", "unprivileged": true, "description": "Requests access to the specified permissions. These permissions must be defined in the optional_permissions field of the manifest.", "parameters": [ { "name": "permissions", "$ref": "Permissions" }, { "name": "callback", "type": "function", "optional": true, "parameters": [ { "name": "granted", "type": "boolean", "description": "True if the user granted the specified permissions." } ] } ] }, { "name": "remove", "type": "function", "unprivileged": true, "description": "Removes access to the specified permissions.", "parameters": [ { "name": "permissions", "$ref": "Permissions" }, { "name": "callback", "type": "function", "optional": true, "parameters": [ { "name": "removed", "type": "boolean", "description": "True if the permissions were removed." } ] } ] } ] }, { "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."}, "pinned": {"type": "boolean", "description": "Whether the tab is pinned."}, "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. The port's onDisconnect event is fired if the tab closes or does not exist. " } }, { "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. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and chrome.extension.lastError will be set to the error message." } ] } ] }, { "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. Note: This function can be used without requesting the 'tabs' permission in the manifest.", "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" }, "pinned": { "type": "boolean", "optional": true, "description": "Whether the tab should be pinned. Defaults to false" } } }, { "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. Note: This function can be used without requesting the 'tabs' permission in the manifest.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "updateProperties", "properties": { "url": { "optional": true, "description": "A URL to navigate the tab to." }, "selected": { "type": "boolean", "optional": true, "description": "Whether the tab should be selected." }, "pinned": { "type": "boolean", "optional": true, "description": "Whether the tab should be pinned." } } }, { "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. Note: This function can be used without requesting the 'tabs' permission in the manifest.", "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. You must have host permission for the URL displayed by the tab.", "parameters": [ { "type": "integer", "name": "windowId", "minimum": 0, "optional": true, "description": "The target window. Defaults to the current window." }, { "type": "object", "name": "options", "optional": true, "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": "Fired when a tab is created. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events to be notified when a URL is set.", "parameters": [ { "$ref": "Tab", "name": "tab", "description": "Details of the tab that was created." } ] }, { "name": "onUpdated", "type": "function", "description": "Fired when a tab is updated.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "changeInfo", "description": "Lists the changes to the state of the tab that was updated.", "properties": { "status": { "type": "string", "optional": true, "description": "The status of the tab. Can be either loading or complete." }, "url": { "type": "string", "optional": true, "description": "The tab's URL if it has changed." }, "pinned": { "type": "boolean", "optional": true, "description": "The tab's new pinned state." } } }, { "$ref": "Tab", "name": "tab", "description": "Gives the state of the tab that was updated." } ] }, { "name": "onMoved", "type": "function", "description": "Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see 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": "Fired 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": "Fired when a tab is closed. Note: A listener can be registered for this event without requesting the 'tabs' permission in the manifest.", "parameters": [ {"type": "integer", "name": "tabId", "minimum": 0}, { "type": "object", "name": "removeInfo", "properties": { "isWindowClosing": {"type": "boolean", "description": "True when the tab is being closed because its window is being closed." } } } ] } ] }, { "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.", "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", "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", "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", "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": "getSubTree", "type": "function", "description": "Retrieves part of the Bookmarks hierarchy, starting at the specified node.", "parameters": [ { "type": "string", "name": "id", "description": "The ID of the root of the subtree to retrieve." }, { "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 page when it was last loaded."}, "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": "Searches 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": "Retrieves 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. This event fires before the page has loaded.", "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": "idle", "types": [], "functions": [ { "name": "queryState", "type": "function", "description": "Returns the current state of the browser.", "parameters": [ { "name": "thresholdSeconds", "type": "integer", "minimum": 15, "description": "Threshold, in seconds, used to determine when a machine is in the idle state." }, { "name": "callback", "type": "function", "parameters": [ { "name": "newState", "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": [ { "name": "newState", "type": "string", "enum": ["active"] } ] } ] }, { "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.input", "nodoc": true, "types": [ { "id": "MenuItem", "type": "object", "description": "A menu item used by an input method to interact with the user from the language menu.", "properties": { "id": {"type": "string", "description": "String that will be passed to callbacks referencing this MenuItem."}, "label": {"type": "string", "optional": true, "description": "Text displayed in the menu for this item."}, "style": { "type": "string", "optional": true, "description": "Enum representing if this item is: none, check, radio, or a separator. Radio buttons between separators are considered grouped.", "enum": ["none", "check", "radio", "separator"] }, "visible": {"type": "boolean", "optional": true, "description": "Indicates this item is visible."}, "checked": {"type": "boolean", "optional": true, "description": "Indicates this item should be drawn with a check."}, "enabled": {"type": "boolean", "optional": true, "description": "Indicates this item is enabled."}, "icon": {"type": "string", "optional": true, "description": "Name of the icon to use. Must be bundled in the extension. Data urls are also acceptable."}, "shortcutKey": {"type": "Keystroke", "optional": true, "description": "Used to create a shortcut key label. The IME should handle the shortcut key itself, however."}, "children": {"type": "array", "items": { "type": "MenuItem" }, "optional": true, "description": "Menu items which will appear as children of this item."} } }, { "id": "KeyboardEvent", "type": "object", "description": "See http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent", "properties": { "type": {"type": "string", "description": "One of keyup or keydown.", "enum": ["keyup", "keydown"]}, "key": {"type": "string", "description": "Value of the key being pressed"}, "keyCode": {"type": "string", "description": "Value of the key being press, unmodified by control keys."}, "altKey": {"type": "boolean", "optional": true, "description": "Whether or not the ALT key is pressed."}, "ctrlKey": {"type": "boolean", "optional": true, "description": "Whether or not the CTRL key is pressed."}, "shiftKey": {"type": "boolean", "optional": true, "description": "Whether or not the SHIFT key is pressed."} } }, { "id": "Keystroke", "type": "object", "description": "See http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent", "properties": { "key": {"type": "string", "description": "Value of the key being pressed"}, "keyCode": {"type": "string", "description": "Value of the key being press, unmodified by control keys."}, "altKey": {"type": "boolean", "optional": true, "description": "Whether or not the ALT key is pressed."}, "ctrlKey": {"type": "boolean", "optional": true, "description": "Whether or not the CTRL key is pressed."}, "shiftKey": {"type": "boolean", "optional": true, "description": "Whether or not the SHIFT key is pressed."} } }, { "id": "Candidate", "type": "object", "description": "An item in the candidate window", "properties": { "candidate": {"type": "string", "description": "The candidate"}, "id": {"type": "integer", "description": "The candidate"}, "label": {"type": "string", "optional": true, "description": "Short string displayed to next to the candidate, often the shortcut key or index"}, "annotation": {"type": "string", "optional": true, "description": "Additional text describing the candidate"}, "subCandidates": {"type": "array", "items": { "type": "Candidate" }, "optional": true, "description": "Candidates that appear in a cascaded menu from this candidate."} } }, { "id": "InputContext", "type": "object", "description": "Describes an input Context", "properties": { "textID": {"type": "integer", "description": "This is used to specify targets of text field operations. This ID becomes invalid as soon as onBlur is called."}, "type": {"type": "string", "description": "Type of value this text field edits, (Text, Number, Password, etc)", "enum": ["text", "number", "password"]} } } ], "functions": [ { "name": "sendKeyboardEvent", "type": "function", "description": "Sends a keyboard event to Chrome.", "parameters": [ { "type": "object", "name": "event", "properties": { "type": { "type": "string", "description": "One of 'keyup' or 'keydown'." }, "keyIdentifier": { "type": "string", "description": "See http://www.w3.org/TR/2003/NOTE-DOM-Level-3-Events-20031107/keyset.html#KeySet-Set" }, "altKey": { "type": "boolean", "optional": true, "description": "Whether or not the ALT key is pressed." }, "ctrlKey": { "type": "boolean", "optional": true, "description": "Whether or not the CTRL key is pressed." }, "metaKey": { "type": "boolean", "optional": true, "description": "Whether or not the META key is pressed." }, "shiftKey": { "type": "boolean", "optional": true, "description": "Whether or not the SHIFT key is pressed." } }, "description": "The keyboard event to be sent." }, { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] }, { "name": "hideKeyboard", "type": "function", "description": "Hides the keyboard UI.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] }, { "name": "setKeyboardHeight", "type": "function", "description": "Sets the height of the keyboard UI.", "parameters": [ { "type": "integer", "name": "height", "minimum": 0, "optional": false, "description": "The height of the keyboard UI." }, { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed but the resizeing may be not finished.", "parameters": [] } ] }, { "name": "setComposition", "type": "function", "description": "Set the current composition. If this extension does not own the active IME, this fails.", "parameters": [ { "name": "parameters", "type": "object", "properties": { "contextID": { "description": "ID of the context where the composition text will be set", "type": "integer" }, "text": { "description": "Text to set", "type": "string" }, "selectionStart": { "description": "Position in the text that the selection starts at.", "type": "integer" }, "selectionEnd": { "description": "Position in the text that the selection ends at.", "type": "integer" }, "segments": { "description": "List of segments and their associated types.", "type": "object", "optional": true, "properties": { "start": { "description": "Index of the character to start this segment at", "type": "integer" }, "end": { "description": "Index of the character to end this segment after.", "type": "integer" }, "style": { "description": "How to render this segment", "enum": ["underline", "doubleUnderline"], "type": "string" } } } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, chrome.extension.lastError is set.", "parameters": [ { "name": "success", "type": "boolean" } ] } ] }, { "name": "clearComposition", "type": "function", "description": "Clear the current composition. If this extension does not own the active IME, this fails.", "parameters": [ { "name": "contextID", "description": "ID of the context with the composition text. This is the value provided in the InputContext from onFocus.", "type": "integer" }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, chrome.extension.lastError is set.", "parameters": [ { "name": "success", "type": "boolean" } ] } ] }, { "name": "commitText", "type": "function", "description": "Commits the provided text to the current input.", "parameters": [ { "name": "parameters", "type": "object", "properties": { "contextID": { "description": "ID of the context where the text will be committed", "type": "integer" }, "text": { "description": "The text to commit", "type": "string" } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, chrome.extension.lastError is set.", "parameters": [ { "name": "success", "type": "boolean" } ] } ] }, { "name": "setCandidateWindowProperties", "type": "function", "description": "Sets the properties of the candidate window. This fails if the extension doesn’t own the active IME", "parameters": [ { "name": "parameters", "type": "object", "properties": { "engineID": { "description": "ID of the engine to set properties on.", "type": "string" }, "properties": { "type": "object", "properties": { "visible": { "type": "boolean", "optional": true, "description": "True to show the Candidate window, false to hide it." }, "cursorVisible": { "type": "boolean", "optional": true, "description": "True to show the cursor, false to hide it." }, "vertical": { "type": "boolean", "optional": true, "description": "True if the candidate window should be rendered vertical, false to make it horizontal." }, "pageSize": { "type": "integer", "optional": true, "description": "The number of candidates to display per page." }, "auxiliaryText": { "type": "string", "optional": true, "description": "Text that is shown at the bottom of the candidate window." }, "auxiliaryTextVisible": { "type": "boolean", "optional": true, "description": "True to display the auxiliary text, false to hide it." } } } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the operation completes.", "parameters": [ { "name": "success", "type": "boolean" } ] } ] }, { "name": "setCandidates", "type": "function", "description": "Sets the current candidate list. This fails if this extension doesn’t own the active IME", "parameters": [ { "name": "parameters", "type": "object", "properties": { "contextID": { "description": "ID of the context that owns the candidate window.", "type": "integer" }, "candidates": { "description": "List of candidates to show in the candidate window", "type": "array", "items": { "type": "Candidate" } } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the operation completes.", "parameters": [ { "name": "success", "type": "boolean" } ] } ] }, { "name": "setCursorPosition", "type": "function", "description": "Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.", "parameters": [ { "name": "parameters", "type": "object", "properties": { "contextID": { "description": "ID of the context that owns the candidate window.", "type": "integer" }, "candidateID": { "description": "ID of the candidate to select.", "type": "integer" } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the operation completes", "parameters": [] } ] }, { "name": "setMenuItems", "type": "function", "description": "Adds the provided menu items to the language menu when this IME is active.", "parameters": [ { "name": "parameters", "type": "object", "properties": { "engineID": { "description": "ID of the engine to use", "type": "string" }, "items": { "description": "MenuItems to add. They will be added in the order they exist in the array.", "type": "array", "items": { "type": "MenuItem" } } } }, { "type": "function", "name": "callback", "optional": true, "description": "", "parameters": [] } ] }, { "name": "updateMenuItems", "type": "function", "description": "Updates the state of the MenuItems specified", "parameters": [ { "name": "parameters", "type": "object", "properties": { "engineID": { "description": "ID of the engine to use", "type": "string" }, "items": { "description": "Array of MenuItems to update", "type": "array", "items": { "type": "MenuItem" } } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the operation completes", "parameters": [] } ] }, { "name": "sendHandwritingStroke", "type": "function", "description": "Sends a handwriting event to Chrome.", "parameters": [ { "name": "stroke", "type": "array", "items": { "type": "object", "properties": { "x": {"type": "number", "minimum": 0, "maximum": 1}, "y": {"type": "number", "minimum": 0, "maximum": 1} } } } ] }, { "name": "cancelHandwritingStrokes", "type": "function", "description": "Clears last N handwriting strokes.", "parameters": [ { "name": "strokeCount", "optional": true, "description": "The number of strokes to be removed. Pass 0 to remove all strokes. If omitted, removes all.", "type": "integer", "minimum": 0 } ] } ], "events": [ { "name": "onActivate", "type": "function", "description": "This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.", "parameters": [ { "type": "string", "name": "engineID", "description": "ID of the engine receiving the event" } ] }, { "name": "onDeactivated", "type": "function", "description": "This event is sent when an IME is deactivated. It signals that the IME will no longer be receiving onKeyPress events.", "parameters": [ { "type": "string", "name": "engineID", "description": "ID of the engine receiving the event" } ] }, { "name": "onFocus", "type": "function", "description": "This event is sent when focus enters a text box. It is sent to all extensions that are listening to this event, and enabled by the user.", "parameters": [ { "type": "InputContext", "name": "context", "description": "Describes the text field that has acquired focus." } ] }, { "name": "onBlur", "type": "function", "description": "This event is sent when focus leaves a text box. It is sent to all extensions that are listening to this event, and enabled by the user.", "parameters": [ { "type": "integer", "name": "contextID", "description": "The ID of the text field that has lost focus. The ID is invalid after this call" } ] }, { "name": "onInputContextUpdate", "type": "function", "description": "This event is sent when the properties of the current InputContext change, such as the the type. It is sent to all extensions that are listening to this event, and enabled by the user.", "parameters": [ { "type": "InputContext", "name": "context", "description": "An InputContext object describing the text field that has changed." } ] }, { "name": "onKeyEvent", "type": "function", "description": "This event is sent if this extension owns the active IME.", "parameters": [ { "type": "string", "name": "engineID", "description": "ID of the engine receiving the event" }, { "type": "KeyboardEvent", "name": "keyData", "description": "Data on the key event" } ], "returns": { "type": "boolean", "description": "True if the keystroke was handled, false if not" } }, { "name": "onCandidateClicked", "type": "function", "description": "This event is sent if this extension owns the active IME.", "parameters": [ { "type": "string", "name": "engineID", "description": "ID of the engine receiving the event" }, { "type": "integer", "name": "candidateID", "description": "ID of the candidate that was clicked." }, { "type": "string", "name": "button", "description": "Which mouse buttons was clicked.", "enum": ["left", "middle", "right"] } ] }, { "name": "onMenuItemActivated", "type": "function", "description": "Called when the user selects a menu item", "parameters": [ { "type": "string", "name": "engineID", "description": "ID of the engine receiving the event" }, { "type": "string", "name": "name", "description": "Name of the MenuItem which was activated" } ] } ] }, { "namespace": "inputMethodPrivate", "nodoc": true, "platforms": ["chromeos"], "types": [], "functions": [ { "name": "get", "type": "function", "description": "Gets the current input method.", "parameters": [ { "name": "callback", "type": "function", "optional": false, "description": "Callback which is called with the current input method.", "parameters": [ { "name": "inputMethodId", "type": "string", "description": "Current input method." } ] } ] } ], "events": [ { "name": "onChanged", "type": "function", "description": "Fired when the input method is changed.", "parameters": [ { "name": "newInputMethodId", "type": "string", "description": "New input method which is being used." } ] } ] }, { "namespace": "experimental.inputUI", "nodoc": true, "platforms": ["chromeos touch"], "types": [], "functions": [ { "name": "register", "type": "function", "description": "Registers the extension, so the extension can receive input method related events.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] }, { "name": "candidateClicked", "type": "function", "description": "Notifies input method engine that a candidate was clicked.", "parameters": [ { "type": "integer", "name": "index" }, { "type": "integer", "name": "button" }, { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] }, { "name": "cursorUp", "type": "function", "description": "Notifies input method engine cursor up button was clicked.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] }, { "name": "cursorDown", "type": "function", "description": "Notifies input method engine cursor down button was clicked.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] }, { "name": "pageUp", "type": "function", "description": "Notifies input method engine page up button was clicked.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] }, { "name": "pageDown", "type": "function", "description": "Notifies input method engine page down button was clicked.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "description": "This function is called when the event processing is completed.", "parameters": [] } ] } ], "events": [ { "name": "onSetCursorLocation", "type": "function", "description": "Fired when input cursor location is changed.", "parameters": [ { "type": "integer", "name": "x" }, { "type": "integer", "name": "y" }, { "type": "integer", "name": "width" }, { "type": "integer", "name": "height" } ] }, { "name": "onUpdateAuxiliaryText", "type": "function", "description": "Fired when auxiliary text is changed.", "parameters": [ { "type": "string", "name": "text", "description": "Auxiliary text." } ] }, { "name": "onUpdateLookupTable", "type": "function", "description": "Fired when lookup table is updated.", "parameters": [ { "type": "object", "properties": { "visible": { "type": "boolean" }, "candidates": { "type": "array", "items": { "type": "string" } } }, "description": "Lookup table" } ] } ] }, { "namespace": "experimental.bookmarkManager", "nodoc": true, "types": [ { "id": "BookmarkNodeDataElement", "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": "BookmarkNodeDataElement"} } } }, { "id": "BookmarkNodeData", "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": "BookmarkNodeDataElement"} } } } ], "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 after the last selected node", "nodoc": "true", "parameters": [ {"type": "string", "name": "parentId"}, { "name": "selectedIdList", "description": "An array of string-valued ids for selected bookmarks", "optional": true, "type": "array", "items": {"type": "string"}, "minItems": 0 }, {"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"} } ] } ] }, { "name": "canEdit", "type": "function", "description": "Whether bookmarks can be modified", "nodoc": "true", "parameters": [ {"type": "function", "name": "callback", "parameters": [ {"type": "boolean"} ]} ] } ], "events": [ { "name": "onDragEnter", "type": "function", "description": "Fired when dragging bookmarks over the document", "parameters": [ {"$ref": "BookmarkNodeData"} ] }, { "name": "onDragLeave", "type": "function", "description": "Fired when the drag and drop leaves the document", "parameters": [ {"$ref": "BookmarkNodeData"} ] }, { "name": "onDrop", "type": "function", "description": "Fired when the user drops bookmarks on the document", "parameters": [ {"$ref": "BookmarkNodeData"} ] } ] }, { "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 ID of the process, as provided by the OS." }, "type": { "type": "string", "enum": ["browser", "renderer", "extension", "notification", "plugin", "worker", "nacl", "utility", "gpu", "other"], "description": "The type of process." }, "cpu": { "type": "number", "description": "The most recent measurement of the process's CPU usage, between 0 and 100%." }, "network": { "type": "number", "description": "The most recent measurement of the process's network usage, in bytes per second." }, "privateMemory": { "type": "number", "description": "The most recent measurement of the process's private memory usage, in bytes." }, "sharedMemory": { "type": "number", "description": "The most recent measurement of the process's shared memory usage, in bytes." } } } ], "functions": [ { "name": "getProcessIdForTab", "type": "function", "description": "Returns the ID of the renderer process for the specified tab.", "parameters": [ { "name": "tabId", "type": "integer", "minimum": 0 }, { "type": "function", "name": "callback", "parameters": [ { "name": "processId", "type": "integer", "description": "Process ID of the tab's renderer process." } ] } ] } ], "events": [ { "name": "onUpdated", "type": "function", "description": "Fired each time the Task Manager updates its process statistics, providing the dictionary of updated Process objects, indexed by process ID.", "parameters": [ { "name": "processes", "type": "object", "properties": {}, "additionalProperties": { "$ref": "Process" } } ] } ] }, { "namespace": "contextMenus", "types": [ { "id": "OnClickData", "type": "object", "description": "Information sent when a context menu item is clicked.", "properties": { "menuItemId": { "type": "integer", "description": "The ID of the menu item that was clicked." }, "parentMenuItemId": { "type": "integer", "optional": true, "description": "The parent ID, if any, for the item clicked." }, "mediaType": { "type": "string", "optional": true, "description": "One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements." }, "linkUrl": { "type": "string", "optional": true, "description": "If the element is a link, the URL it points to." }, "srcUrl": { "type": "string", "optional": true, "description": "Will be present for elements with a 'src' URL." }, "pageUrl": { "type": "string", "description": "The URL of the page where the menu item was clicked." }, "frameUrl": { "type": "string", "optional": true, "description": " The URL of the frame of the element where the context menu was clicked, if it was in a frame." }, "selectionText": { "type": "string", "optional": true, "description": "The text for the context selection, if any." }, "editable": { "type": "string", "description": "A flag indicating whether the element is editable (text input, textarea, etc.)." } } } ], "functions": [ { "name": "create", "type": "function", "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 chrome.extension.lastError).", "returns": { "type": "integer", "description": "The ID of the newly created item." }, "parameters": [ { "type": "object", "name": "createProperties", "properties": { "type": { "type": "string", "enum": ["normal", "checkbox", "radio", "separator"], "optional": true, "description": "The type of menu item. Defaults to 'normal' if not specified." }, "title": { "type": "string", "optional": true, "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\"." }, "checked": { "type": "boolean", "optional": true, "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." }, "contexts": { "type": "array", "items": { "type": "string", "enum": ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"] }, "minItems": 1, "optional": true, "description": "List of contexts this menu item will appear in. Defaults to ['page'] if not specified." }, "onclick": { "type": "function", "optional": true, "description": "A function that will be called back when the menu item is clicked.", "parameters": [ { "name": "info", "$ref": "OnClickData", "description": "Information about the item clicked and the context where the click happened." }, { "name": "tab", "$ref": "Tab", "description": "The details of the tab where the click took place." } ] }, "parentId": { "type": "integer", "optional": true, "description": "The ID of a parent menu item; this makes the item a child of a previously added item." }, "documentUrlPatterns": { "type": "array", "items": {"type": "string"}, "optional": true, "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 Match Patterns." }, "targetUrlPatterns": { "type": "array", "items": {"type": "string"}, "optional": true, "description": "Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags." } } }, { "type": "function", "name": "callback", "optional": true, "description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.extension.lastError.", "parameters": [] } ] }, { "name": "update", "type": "function", "description": "Updates 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", "enum": ["normal", "checkbox", "radio", "separator"], "optional": true }, "title": { "type": "string", "optional": true }, "checked": { "type": "boolean", "optional": true }, "contexts": { "type": "array", "items": { "type": "string", "enum": ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"] }, "minItems": 1, "optional": true }, "onclick": { "type": "function", "optional": true }, "parentId": { "type": "integer", "optional": true, "description": "Note: You cannot change an item to be a child of one of its own descendants." }, "documentUrlPatterns": { "type": "array", "items": {"type": "string"}, "optional": true }, "targetUrlPatterns": { "type": "array", "items": {"type": "string"}, "optional": true } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [], "description": "Called when the context menu has been updated." } ] }, { "name": "remove", "type": "function", "description": "Removes 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": "Removes 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": "getEnabled", "type": "function", "description": "Gets the user preference to send UMA and crash reports to Google.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ {"name": "enabled", "type": "boolean"} ] } ] }, { "name": "setEnabled", "type": "function", "description": "Sets the user preference to send UMA and crash reports to Google.", "parameters": [ {"name": "enabled", "type": "boolean", "description": "True for setting Chrome to actively send UMA and crash reports, false for disabling this."}, { "type": "function", "name": "callback", "parameters": [ { "name": "enabled", "type": "boolean", "description": "The actual value set. If it is not the one passed in parameter, the value couldn't be changed (e.g. because of security)." } ] } ] }, { "name": "recordUserAction", "type": "function", "description": "Records an action performed by the user.", "parameters": [ {"name": "name", "type": "string"} ] }, { "name": "recordPercentage", "type": "function", "description": "Records a percentage value from 1 to 100.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordCount", "type": "function", "description": "Records 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": "Records a value than can range from 1 to 100.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordMediumCount", "type": "function", "description": "Records a value than can range from 1 to 10,000.", "parameters": [ {"name": "metricName", "type": "string"}, {"name": "value", "type": "integer"} ] }, { "name": "recordTime", "type": "function", "description": "Records 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": "Records 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": "Records 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": "chromePrivate", "nodoc": "true", "functions": [ { "name": "decodeJPEG", "description": "Decodes JPEG image array to raw bitmap array", "parameters": [ { "name": "jpeg_image", "type": "array", "optional": false, "description": "The JPEG image bytes array", "items": {"type": "number"} } ], "returns": { "type": "array", "description": "Decoded bitmap RGB array formatted as (B | G << 8 | R << 16)", "items": {"type": "number"} } } ] }, { "namespace": "chromeosInfoPrivate", "nodoc": "true", "functions": [ { "name": "get", "description": "Fetches customization values for the given property names. See property names in the declaration of the returned dictionary.", "type": "function", "parameters": [ { "name": "propertyNames", "type": "array", "item": {"type": "string", "description": "Chrome OS Property name"} }, { "name": "callback", "type": "function", "parameters": [ { "name": "propertiesDictionary", "type": "object", "description": "Dictionary which contains all requested properties", "properties": { "hwid": {"type": "string", "optional": "true", "description": "Hardware ID"}, "homeProvider" : {"type": "string", "optional": "true", "description": "Home provider which is used by the cellular device"}, "initialLocale" : {"type": "string", "optional": "true", "description": "Initial locale for the device"} } } ] } ] } ] }, { "namespace": "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 path will be returned. For cookies with the same path length, 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. 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.", "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."} } }, { "type": "function", "name": "callback", "optional": true, "min_version": "11.0.674.0", "parameters": [ { "name": "cookie", "$ref": "Cookie", "optional": true, "description": "Contains details about the cookie that's been set. If setting failed for any reason, this will be \"null\", and \"chrome.extension.lastError\" will be set." } ] } ] }, { "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."} } }, { "type": "function", "name": "callback", "optional": true, "min_version": "11.0.674.0", "parameters": [ { "name": "details", "type": "object", "description": "Contains details about the cookie that's been removed. If removal failed for any reason, this will be \"null\", and \"chrome.extension.lastError\" will be set.", "optional": true, "properties": { "url": {"type": "string", "description": "The URL associated with the cookie that's been removed."}, "name": {"type": "string", "description": "The name of the cookie that's been removed."}, "storeId": {"type": "string", "description": "The ID of the cookie store from which the cookie was removed."} } } ] } ] }, { "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. 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\".", "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."}, "cause": {"min_version": "12.0.707.0", "type": "string", "enum": ["evicted", "expired", "explicit", "expired_overwrite", "overwrite"], "description": "The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to \"chrome.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."} } } ] } ] }, { "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": "sendFinancialPing", "type": "function", "description": "Sends Google promotional information about this extension.", "parameters": [ {"name": "product", "type": "string", "minLength": 1, "maxLength": 1}, {"name": "accessPoints", "type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 2}, "minItems": 1}, {"name": "signature", "type": "string"}, {"name": "brand", "type": "string"}, {"name": "id", "type": "string"}, {"name": "lang", "type": "string"}, {"name": "exclude_machine_id", "type": "boolean"}, {"name": "callback", "type": "function", "optional": true, "parameters": [{"name": "sent", "type": "boolean"}]} ] }, { "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": "experimental.webNavigation", "types": [], "functions": [ { "name": "getFrame", "type": "function", "description": "Retrieves information about the given frame.", "parameters": [ { "type": "object", "name": "details", "description": "Information about the frame to retrieve information about.", "properties": { "tabId": { "type": "integer", "minimum": 0, "description": "The ID of the tab in which the frame is." }, "frameId": { "type": "integer", "minimum": 0, "description": "The ID of the frame in the given tab." } } }, { "type": "function", "name": "callback", "parameters": [ { "type": "object", "name": "details", "properties": { "errorOccurred": { "type": "boolean", "description": "True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired." }, "url": { "type": "string", "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." } } } ] } ] } ], "events": [ { "name": "onBeforeNavigate", "type": "function", "description": "Fired when a navigation is about to occur.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation is about to occur."}, "url": {"type": "string"}, "frameId": {"type": "integer", "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."}, "timeStamp": {"type": "number", "description": "The time when the browser was about to start the navigation, in milliseconds since the epoch."} } } ] }, { "name": "onCommitted", "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.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."}, "url": {"type": "string"}, "frameId": {"type": "integer", "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."}, "transitionType": {"type": "string", "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of the navigation. The same transition types as defined in the history API are used."}, "transitionQualifiers": {"type": "array", "description": "A list of transition qualifiers.", "items:": {"type": "string", "enum": ["client_redirect", "server_redirect", "forward_back"]}}, "timeStamp": {"type": "number", "description": "The time when the navigation was committed, in milliseconds since the epoch."} } } ] }, { "name": "onDOMContentLoaded", "type": "function", "description": "Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."}, "url": {"type": "string"}, "frameId": {"type": "integer", "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."}, "timeStamp": {"type": "number", "description": "The time when the page's DOM was fully constructed, in milliseconds since the epoch."} } } ] }, { "name": "onCompleted", "type": "function", "description": "Fired when a document, including the resources it refers to, is completely loaded and initialized.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."}, "url": {"type": "string"}, "frameId": {"type": "integer", "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."}, "timeStamp": {"type": "number", "description": "The time when the document finished loading, in milliseconds since the epoch."} } } ] }, { "name": "onErrorOccurred", "type": "function", "description": "Fired when an error occurs.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."}, "url": {"type": "string"}, "frameId": {"type": "integer", "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."}, "error": {"type": "string", "description": "The error description."}, "timeStamp": {"type": "number", "description": "The time when the error occurred, in milliseconds since the epoch."} } } ] }, { "name": "onBeforeRetarget", "type": "function", "description": "Fired when a new window, or a new tab in an existing window, is about to be created to host a navigation.", "parameters": [ { "type": "object", "name": "details", "properties": { "sourceTabId": {"type": "integer", "description": "The ID of the tab in which the navigation is triggered."}, "sourceFrameId": {"type": "integer", "description": "The ID of the frame with sourceTabId in which the navigation is triggered. 0 indicates the main frame."}, "url": {"type": "string", "description": "The URL to be opened in the new window."}, "tabId": {"type": "integer", "description": "The ID of the tab in which the url is opened"}, "timeStamp": {"type": "number", "description": "The time when the browser was about to create a new view, in milliseconds since the epoch."} } } ] } ] }, { "namespace": "experimental.webRequest", "types": [ { "id": "RequestFilter", "type": "object", "description": "An object describing filters to apply to webRequest events.", "properties": { "urls": { "type": "array", "optional": true, "description": "A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.", "items": { "type": "string" } }, "types": { "type": "array", "optional": true, "description": "A list of request types. Requests that cannot match any of the types will be filtered out.", "items": { "type": "string", "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"] } }, "tabId": { "type": "integer", "optional": true }, "windowId": { "type": "integer", "optional": true } } }, { "id": "HttpHeaders", "type": "array", "description": "An array of HTTP headers, in the form of name/value pairs.", "items": { "type": "object", "properties": { "name": {"type": "string"}, "value": {"type": "string"} } } }, { "id": "BlockingResponse", "type": "object", "description": "Returns value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests.", "properties": { "cancel": { "type": "boolean", "optional": true, "description": "If true, the request is cancelled. Used in onBeforeRequest, this prevents the request from being sent." }, "redirectUrl": { "type": "string", "optional": true, "description": "Only used as a response to the onBeforeRequest event. If set, the original request is prevented from being sent and is instead redirected to the given URL." }, "requestHeaders": { "$ref": "HttpHeaders", "optional": true, "description": "Only used as a response to the onBeforeSendHeaders event. If set, the request is made with these request headers instead." } } } ], "functions": [ { "name": "addEventListener", "nodoc": true, "type": "function", "description": "Used internally to implement the special form of addListener for the webRequest events.", "parameters": [ {"type": "function", "name": "callback"}, { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["requestLine", "requestHeaders", "statusLine", "responseHeaders", "blocking"] } }, {"type": "string", "name": "eventName"}, {"type": "string", "name": "subEventName"} ] }, { "name": "eventHandled", "nodoc": true, "type": "function", "description": "Used internally to send a response for a blocked event.", "parameters": [ {"type": "string", "name": "eventName"}, {"type": "string", "name": "subEventName"}, {"type": "string", "name": "requestId"}, { "$ref": "BlockingResponse", "optional": true, "name": "response" } ] } ], "events": [ { "name": "onBeforeRequest", "type": "function", "description": "Fired when a request is about to occur.", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "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."}, "url": {"type": "string"}, "method": {"type": "string", "description": "Standard HTTP method."}, "frameId": {"type": "integer", "description": "0 indicates 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."}, "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to null if the request isn't related to a tab."}, "type": {"type": "string", "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"], "description": "How the requested resource will be used."}, "timeStamp": {"type": "number", "description": "The time when the browser was about to make the request, in milliseconds since the epoch."} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["blocking"] } } ], "returns": { "$ref": "BlockingResponse", "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", "optional": true } }, { "name": "onBeforeSendHeaders", "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. ", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "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."}, "url": {"type": "string"}, "timeStamp": {"type": "number", "description": "The time when the browser was about to send headers, in milliseconds since the epoch."}, "requestHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP request headers that are going to be sent out with this request."} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["requestLine", "requestHeaders", "blocking"] } } ], "returns": { "$ref": "BlockingResponse", "description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.", "optional": true } }, { "name": "onSendHeaders", "type": "function", "description": "Fired just before a request is going to be sent to the server (modifications of prvious onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "description": "The ID of the request."}, "url": {"type": "string"}, "timeStamp": {"type": "number", "description": "The time when the browser finished sending the request, in milliseconds since the epoch."}, "requestHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP request headers that have been sent out with this request."} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["requestLine", "requestHeaders"] } } ] }, { "name": "onAuthRequired", "type": "function", "description": "Fired when an authentication failure was received. Depending on whether the user provides credentials, the request is either reissued or cancelled.", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "description": "The ID of the request."}, "url": {"type": "string"}, "scheme": {"type": "string", "description": "The authentication scheme, e.g. Basic or Digest."}, "realm": {"type": "string", "description": "The authentication realm provided by the server, if there is one.", "optional": true}, "isProxy": {"type": "boolean", "description": "True for Proxy-Authenticate, false for WWW-Authenticate."}, "timeStamp": {"type": "number", "description": "The time when the status line and response headers were received, in milliseconds since the epoch."}, "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP response headers that were received along with this response."}, "statusLine": {"type": "string", "optional": true, "description": "HTTP status line of the response"} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["statusLine", "responseHeaders"] } } ] }, { "name": "onResponseStarted", "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.", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "description": "The ID of the request."}, "url": {"type": "string"}, "ip": {"type": "string", "optional": true, "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address."}, "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, "statusCode": {"type": "integer", "description": "Standard HTTP status code returned by the server."}, "timeStamp": {"type": "number", "description": "The time when the status line and response headers were received, in milliseconds since the epoch."}, "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP response headers that were received along with this response."}, "statusLine": {"type": "string", "optional": true, "description": "HTTP status line of the response"} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["statusLine", "responseHeaders"] } } ] }, { "name": "onBeforeRedirect", "type": "function", "description": "Fired when a server initiated redirect is about to occur.", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "description": "The ID of the request."}, "url": {"type": "string", "description": "The URL of the current request."}, "ip": {"type": "string", "optional": true, "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address."}, "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, "statusCode": {"type": "integer", "description": "Standard HTTP status code returned by the server."}, "redirectUrl": {"type": "string", "description": "The new URL."}, "timeStamp": {"type": "number", "description": "The time when the browser was about to make the redirect, in milliseconds since the epoch."}, "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP response headers that were received along with this redirect."}, "statusLine": {"type": "string", "optional": true, "description": "HTTP status line of the response"} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["statusLine", "responseHeaders"] } } ] }, { "name": "onCompleted", "type": "function", "description": "Fired when a request is completed.", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "description": "The ID of the request."}, "url": {"type": "string", "description": "The URL of the current request."}, "ip": {"type": "string", "optional": true, "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address."}, "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, "statusCode": {"type": "integer", "description": "Standard HTTP status code returned by the server."}, "timeStamp": {"type": "number", "description": "The time when the response was received completely, in milliseconds since the epoch."}, "responseHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP response headers that were received along with this response."}, "statusLine": {"type": "string", "optional": true, "description": "HTTP status line of the response"} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." }, { "type": "array", "optional": true, "name": "extraInfoSpec", "description": "Array of extra information that should be passed to the listener function.", "items": { "type": "string", "enum": ["statusLine", "responseHeaders"] } } ] }, { "name": "onErrorOccurred", "type": "function", "description": "Fired when an error occurs.", "parameters": [ { "type": "object", "name": "details", "properties": { "requestId": {"type": "string", "description": "The ID of the request."}, "url": {"type": "string", "description": "The URL of the current request."}, "ip": {"type": "string", "optional": true, "description": "The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address."}, "fromCache": {"type": "boolean", "description": "Indicates if this response was fetched from disk cache."}, "error": {"type": "string", "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."}, "timeStamp": {"type": "number", "description": "The time when the error occurred, in milliseconds since the epoch."} } } ], "extraParameters": [ { "$ref": "RequestFilter", "optional": true, "name": "filter", "description": "A set of filters that restricts the events that will be sent to this listener." } ] } ] }, { "namespace": "test", "nodoc": true, "types": [], "functions": [ { "name": "getConfig", "type": "function", "description": "Gives configuration options set by the test.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "type": "object", "name": "testConfig", "properties": { "testServer": { "type": "object", "optional": true, "description": "Details on the test server used to mock network responses. Will be set only if test calls ExtensionApiTest::StartTestServer().", "properties": { "port": { "type": "integer", "description": "The port on which the test server is listening.", "minimum": 1024, "maximum": 65535 } } } } } ] } ] }, { "name": "notifyFail", "type": "function", "description": "Notifies 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": "Notifies 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": "Resets 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"} ] }, { "name": "sendMessage", "type": "function", "description": "Sends a string message to the browser process, generating a Notification that C++ test code can wait for.", "parameters": [ {"type": "string", "name": "message"}, { "type": "function", "name": "callback", "optional": true, "parameters": [ {"type": "string", "name": "response"} ] } ] } ], "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": "proxy", "types": [ { "id": "ProxyServer", "type": "object", "description": "An object encapsulating a single proxy server's specification.", "properties": { "scheme": {"type": "string", "optional": true, "enum": ["http", "https", "socks4", "socks5"], "description": "The scheme (protocol) of the proxy server itself. Defaults to 'http'."}, "host": {"type": "string", "description": "The URI of the proxy server. This must be an ASCII hostname (in Punycode format). IDNA is not supported, yet."}, "port": {"type": "integer", "optional": true, "description": "The port of the proxy server. Defaults to a port that depends on the scheme."} } }, { "id": "ProxyRules", "type": "object", "description": "An object encapsulating the set of proxy rules for all protocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHttps', 'proxyForFtp' and 'fallbackProxy'.", "properties": { "singleProxy": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for all per-URL requests (that is http, https, and ftp)."}, "proxyForHttp": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for HTTP requests."}, "proxyForHttps": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for HTTPS requests."}, "proxyForFtp": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for FTP requests."}, "fallbackProxy": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for everthing else or if any of the specific proxyFor... is not specified."}, "bypassList": {"type": "array", "items": {"type": "string"}, "optional": true, "description": "List of servers to connect to without a proxy server."} } }, { "id": "PacScript", "type": "object", "description": "An object holding proxy auto-config information. Exactly one of the fields should be non-empty.", "properties": { "url": {"type": "string", "optional": true, "description": "URL of the PAC file to be used."}, "data": {"type": "string", "optional": true, "description": "A PAC script."}, "mandatory": {"type": "boolean", "optional": true, "description": "If true, an invalid PAC script will prevent the network stack from falling back to direct connections. Defaults to false."} } }, { "id": "ProxyConfig", "type": "object", "description": "An object encapsulating a complete proxy configuration.", "properties": { "rules": {"$ref": "ProxyRules", "optional": true, "description": "The proxy rules describing this configuration. Use this for 'fixed_servers' mode."}, "pacScript": {"$ref": "PacScript", "optional": true, "description": "The proxy auto-config (PAC) script for this configuration. Use this for 'pac_script' mode."}, "mode": { "type": "string", "enum": ["direct", "auto_detect", "pac_script", "fixed_servers", "system"], "description": "'direct' = Never use a proxy
'auto_detect' = Auto detect proxy settings
'pac_script' = Use specified PAC script
'fixed_servers' = Manually specify proxy servers
'system' = Use system proxy settings" } } } ], "properties": { "settings": { "$ref": "ChromeSetting", "description": "Proxy settings to be used. The value of this setting is a ProxyConfig object.", "value": [ "proxy", {"$ref": "ProxyConfig"} ] } }, "events": [ { "name": "onProxyError", "type": "function", "description": "Notifies about proxy errors.", "parameters": [ { "type": "object", "name": "details", "properties": { "fatal": { "type": "boolean", "description": "If true, the error was fatal and the network transaction was aborted. Otherwise, a direct connection is used instead." }, "error": { "type": "string", "description": "The error description." }, "details": { "type": "string", "description": "Additional details about the error such as a JavaScript runtime error." } } } ] } ] }, { "namespace": "experimental.sidebar", "types": [], "functions": [ { "name": "hide", "type": "function", "description": "Hides sidebar's mini tab for the specified tab and collapses sidebar if it was in 'active' state (see getState). Has no effect if the sidebar is already hidden.", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." } } } ] }, { "name": "show", "type": "function", "description": "Shows sidebar mini tab (in 'shown' state) for the specified tab. Has no effect if already expanded, otherwise changes status to 'shown'.", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." } } } ] }, { "name": "expand", "type": "function", "description": "Expands sidebar and switches to the specified content (if it was displaying another extension's sidebar content) for the specified tab. Extension is allowed to expand sidebar only in response to an explicit user gesture.", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." } } } ] }, { "name": "collapse", "type": "function", "description": "Collapses sidebar for the specified tab. Has no effect if sidebar is not in its 'active' state (see getState).", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." } } } ] }, { "name": "navigate", "type": "function", "description": "Loads the the specified html file into the sidebar for the specified tab.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." }, "path": { "type": "string", "description": "Relative path to the html file in the extension to show in the sidebar." } } } ] }, { "name": "getState", "type": "function", "description": "Returns current sidebar state for the specified tab.", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." } } }, { "type": "function", "name": "callback", "parameters": [ { "name": "state", "type": "string", "enum": ["hidden", "shown", "active"], "description": "'hidden' indicates sidebar is not defined for the specified tab (show was never called or hide() was called). Nothing is displayed for this sidebar.
'shown' means sidebar is defined for the specified tab; mini tab is displayed for this sidebar. Sidebar UI is either collapsed or displaying a content of some other extension's sidebar.
'active' indicates that sidebar is defined for the specified tab; sidebar UI is expanded and displaying this sidebar's content." } ] } ] }, { "name": "setBadgeText", "type": "function", "description": "Sets sidebar's mini tab badge text for the specified tab.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." }, "text": { "type": "string", "description": "The sidebar's badge text. The badge is displayed on top of the sidebar's icon on the mini tab. Any number of characters can be passed, but only about four can fit in the space." } } } ] }, { "name": "setIcon", "type": "function", "description": "Sets sidebar's mini tab icon for the specified tab.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." }, "imageData": { "type": "object", "isInstanceOf": "ImageData", "properties": {}, "additionalProperties": { "type": "any" }, "description": "Pixel data for an image to show on the sidebar's mini tab. Must be an ImageData object (for example, from a canvas element). Only one of the imagePath/imageData parameters all owed. The extension's icon is used by default. The preferred size of the icon is 16x16 pixels, any other size will be scaled to 16x16.", "optional": true }, "path": { "type": "string", "optional": true, "description": "Relative path to an image in the extension to show on the sidebar's mini tab. Only one of the imagePath/imageData parameters all owed. The extension's icon is used by default. The preferred size of the icon is 16x16 pixels, any other size will be scaled to 16x16." } } } ] }, { "name": "setTitle", "type": "function", "description": "Sets sidebar's mini tab title for the specified tab.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": { "type": "integer", "minimum": 0, "optional": true, "description": "Defaults to the selected tab of the current window." }, "title": { "type": "string", "description": "The sidebar's title. It is displayed in a tooltip over the sidebar's mini tab." } } } ] } ], "events": [ { "name": "onStateChanged", "unprivileged": true, "type": "function", "description": "Notifies about sidebar state changes.", "parameters": [ { "type": "object", "name": "details", "properties": { "tabId": { "type": "integer", "minimum": 0 }, "state": { "type": "string", "enum": ["hidden", "shown", "active"] } } } ] } ] }, { "namespace": "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 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." } } } ], "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": { "type": "object", "additionalProperties": { "type": "any" } } } ] }, { "name": "setDefaultSuggestion", "type": "function", "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.", "parameters": [ { "type": "object", "name": "suggestion", "description": "A partial SuggestResult object, without the 'content' parameter. See SuggestResult for a description of the parameters.", "properties": { "description": { "type": "string", "minLength": 1, "description": "The text to display in the default suggestion. The placeholder string '%s' can be included and will be replaced with the user's input." } } } ] } ], "events": [ { "name": "onInputStarted", "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", "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": "array", "description": "Array of suggest results", "items": { "$ref": "SuggestResult" } } ] } ] }, { "name": "onInputEntered", "type": "function", "description": "User has accepted what is typed into the omnibox.", "parameters": [ { "type": "string", "name": "text" } ] }, { "name": "onInputCancelled", "type": "function", "description": "User has ended the keyword input session without accepting the input.", "parameters": [] } ] }, { "namespace":"management", "types": [ { "id": "IconInfo", "description": "Information about an icon belonging to an extension or app.", "type": "object", "properties": { "size": { "type": "integer", "description": "A number representing the width and height of the icon. Likely values include (but are not limited to) 128, 48, 24, and 16." }, "url": { "type": "string", "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." } } }, { "id": "ExtensionInfo", "description": "Information about an installed extension or app.", "type": "object", "properties": { "id": { "description": "The extension's unique identifier.", "type": "string" }, "name": { "description": "The name of this extension or app.", "type": "string" }, "description": { "description": "The description of this extension or app.", "type": "string" }, "version": { "description": "The version of this extension or app.", "type": "string" }, "mayDisable": { "description": "Whether this extension can be disabled or uninstalled by the user.", "type": "boolean" }, "enabled": { "description": "Whether it is currently enabled or disabled.", "type": "boolean" }, "isApp": { "description": "True if this is an app.", "type": "boolean" }, "appLaunchUrl": { "description": "The launch url (only present for apps).", "type": "string", "optional": true }, "homepageUrl": { "description": "The URL of the homepage of this extension or app", "type": "string", "optional": true }, "optionsUrl": { "description": "The url for the item's options page, if it has one.", "type": "string" }, "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.", "type": "array", "optional": true, "items": { "$ref": "IconInfo" } }, "permissions": { "description": "Returns a list of API based permissions.", "type": "array", "items" : { "type": "string" } }, "hostPermissions": { "description": "Returns a list of host based permissions.", "type": "array", "items" : { "type": "string" } } } } ], "functions": [ { "name": "getAll", "description": "Returns a list of information about installed extensions and apps.", "parameters": [ { "type": "function", "name": "callback", "optional": true, "parameters": [ { "type": "array", "name": "result", "items": { "$ref": "ExtensionInfo" } } ] } ] }, { "name": "get", "description": "Returns information about the installed extension or app that has the given ID.", "parameters": [ { "name": "id", "type": "string", "description": "The ID from an item of $ref:ExtensionInfo." }, { "type": "function", "name": "callback", "optional": "true", "parameters": [ { "name": "result", "$ref": "ExtensionInfo" } ] } ] }, { "name": "getPermissionWarningsById", "description": "Returns a list of permission warnings for the given extension id.", "parameters": [ { "name": "id", "type": "string", "description": "The ID of an already installed extension." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [ { "name": "permissionWarnings", "type": "array", "items": { "type": "string" } } ] } ] }, { "name": "getPermissionWarningsByManifest", "description": "Returns a list of permission warnings for the given extension manifest string. Note: This function can be used without requesting the 'management' permission in the manifest.", "parameters": [ { "name": "manifestStr", "type": "string", "description": "Extension manifest JSON string." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [ { "name": "permissionWarnings", "type": "array", "items": { "type": "string" } } ] } ] }, { "name": "setEnabled", "description": "Enables or disables an app or extension.", "parameters": [ { "name": "id", "type": "string", "description": "This should be the id from an item of $ref:ExtensionInfo." }, { "name": "enabled", "type": "boolean", "description": "Whether this item should be enabled or disabled." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [] } ] }, { "name": "uninstall", "description": "Uninstalls a currently installed app or extension.", "parameters": [ { "name": "id", "type": "string", "description": "This should be the id from an item of $ref:ExtensionInfo." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [] } ] }, { "name": "launchApp", "description": "Launches an application.", "parameters": [ { "name": "id", "type": "string", "description": "The extension id of the application." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [] } ] } ], "events": [ { "name": "onInstalled", "description": "Fired when an app or extension has been installed.", "type": "function", "parameters": [{"name": "info", "$ref":"ExtensionInfo"}] }, { "name": "onUninstalled", "description": "Fired when an app or extension has been uninstalled.", "type": "function", "parameters": [ { "name": "id", "type": "string", "description": "The id of the extension or app that was uninstalled." } ] }, { "name": "onEnabled", "description": "Fired when an app or extension has been enabled.", "type": "function", "parameters": [{"name": "info", "$ref":"ExtensionInfo"}] }, { "name": "onDisabled", "description": "Fired when an app or extension has been disabled", "type": "function", "parameters": [{"name": "info", "$ref":"ExtensionInfo"}] } ] }, { "namespace":"fileBrowserHandler", "types": [ { "id": "FileHandlerExecuteEventDetails", "type": "object", "description": "Event details payload for fileBrowserHandler.onExecute event.", "properties": { "entries": { "type": "any", "description": "Array of Entry instances representing files that are targets of this action (selected in ChromeOS file browser)." }, "tab_id" : { "type": "integer", "optional": true, "description": "The ID of the tab that raised this event. Tab IDs are unique within a browser session." } } } ], "events": [ { "name": "onExecute", "type": "function", "description": "Fired when file system action is executed from ChromeOS file browser.", "parameters": [ { "name": "id", "type": "string", "description": "File browser action id as specified in the listener component's manifest." }, { "name": "details", "$ref": "FileHandlerExecuteEventDetails", "description": "File handler execute event details." } ] } ] }, { "namespace":"fileBrowserPrivate", "nodoc": "true", "types": [ { "id": "FileBrowserTask", "type": "object", "description": "Represents information about available browser tasks. A task is an abstraction of an operation that the file browser can perform over a selected file set.", "properties": { "taskId": {"type": "string", "description": "The unique identifier of the task."}, "title": {"type": "string", "description": "Task title."}, "iconUrl": {"type": "string", "description": "Task icon url (from chrome://extension-icon/...)"} } }, { "id": "VolumeInfo", "type": "object", "description": "Mounted disk volume information.", "properties": { "mountPath": { "type": "string", "description": "Disk volume mount point path. The value corresponds to its Entry.fullPath in File API." }, "devicePath": { "type": "string", "description": "Disk volume device path." }, "label": { "type": "string", "description": "Volume label." }, "deviceType": { "type": "string", "enum": ["flash", "hdd", "optical", "undefined"], "description": "Device type." }, "readOnly": { "type": "boolean", "description": "Flag that specifies if volume is mounted in read-only mode." }, "totalSizeKB": { "type": "integer", "description": "Total disk volume size in KBs" } } }, { "id": "MountPointInfo", "type": "object", "description": "Mounted point information.", "properties": { "mountPath": { "type": "string", "optional": true, "description": "Disk volume mount point path. The value corresponds to its Entry.fullPath in File API." }, "sourceUrl": { "type": "string", "description": "The path to the mounted devicem, url of the mounted archive file or network resource." }, "mountType": { "type": "string", "enum": ["device", "file", "network"], "description": "Type of the mount." } } }, { "id": "VolumeMetadata", "type": "object", "description": "Mounted disk volume metadata.", "properties": { "mountPath": { "type": "string", "description": "Disk volume mount point path." }, "devicePath": { "type": "string", "description": "Disk volume device path." }, "systemPath": { "type": "string", "description": "Disk volume system path." }, "filePath": { "type": "string", "description": "Disk volume file path." }, "deviceLabel": { "type": "string", "description": "Volume label." }, "driveLabel": { "type": "string", "description": "Volume's disk label." }, "deviceType": { "type": "string", "enum": ["flash", "hdd", "optical", "undefined"], "description": "Device type." }, "isParent": { "type": "boolean", "description": "Flag that specifies if volume is a parent device." }, "isReadOnly": { "type": "boolean", "description": "Flag that specifies if volume is mounted in read-only mode." }, "hasMedia": { "type": "boolean", "description": "Flag that specifies if volume has any media." }, "isOnBootDevice": { "type": "boolean", "description": "Flag that specifies if volume is on boot device." }, "totalSize": { "type": "integer", "description": "Total disk volume size." } } }, { "id": "MountEvent", "type": "object", "description": "Payload data for disk mount / unmount event.", "properties": { "eventType": { "type": "string", "enum": ["added", "removed"], "description": "Event type that tells listeners which disk volume even was raised." }, "volumeInfo": { "$ref": "VolumeInfo", "description":"Volume information that this mount event applies to." } } }, { "id": "MountCompletedEvent", "type": "object", "description": "Payload data for mount event.", "properties": { "eventType": { "type": "string", "enum": ["mount", "unmount"], "description": "Is the event raised for mounting or unmounting." }, "status": { "type": "string", "enum": ["success", "error_unknown", "error_internal", "error_unknown_filesystem", "error_unsuported_filesystem", "error_invalid_archive", "error_libcros_missing"], "description": "Event type that tells listeners if mount was successfull or an error occurred. It also specifies the error." }, "sourceUrl": { "type": "string", "description": "Path that has been mounted." }, "mountPath": { "type": "string", "optional": true, "description": "Path that sourcePath was mounted to." }, "mountType": { "type": "string", "enum": ["device", "file", "network"], "description": "Type of the mount." } } }, { "id": "FileWatchEvent", "type": "object", "description": "Payload data for disk mount / unmount event.", "properties": { "eventType": { "type": "string", "enum": ["changed", "error"], "description": "Specifies type of event that is raised." }, "fileUrl": { "type": "string", "description":"URL of watched file" } } } ], "functions": [ { "name": "cancelDialog", "type": "function", "description": "Cancels file selection.", "parameters": [] }, { "name": "executeTask", "description": "Executes file browser task over selected files", "parameters": [ { "name": "taskId", "type": "string", "description": "The unique identifier of task to execute." }, { "name": "fileURLs", "type": "array", "description": "Array of file URLs", "items": { "type": "string" } }, { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name": "success", "type": "boolean", "optional": "true", "description": "True of task execution was successfully initiated." } ] } ] }, { "name": "getFileTasks", "description": "Gets the of tasks that can be performed over selected files.", "parameters": [ { "name": "fileURLs", "type": "array", "description": "Array of selected file URLs", "items": { "type": "string" } }, { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name": "tasks", "type": "array", "items": {"$ref": "FileBrowserTask"}, "description": "The list of available tasks that can be performed on all of the passed file paths." } ] } ] }, { "name": "getStrings", "type": "function", "description": "Gets Strings.", "parameters": [ { "type": "function", "name": "callback", "parameters": [ { "type": "object", "properties": {}, "additionalProperties": {"type": "string"} } ] } ] }, { "name": "addFileWatch", "description": "Adds file watch.", "parameters": [ { "name": "fileUrl", "type": "string", "description": "URL of file to watch" }, { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name" : "success", "type": "boolean", "optional": "true", "description": "True when file watch is successfully added." } ] } ] }, { "name": "removeFileWatch", "description": "Removes file watch.", "parameters": [ { "name": "fileUrl", "type": "string", "description": "URL of watched file to remove" }, { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name" : "success", "type": "boolean", "optional": "true", "description": "True when file watch is successfully removed." } ] } ] }, { "name": "requestLocalFileSystem", "description": "Requests access to local file system", "parameters": [ { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name" : "fileSystem", "type": "object", "optional": "true", "description": "A DOMFileSystem instance for local file system access. null if the caller has no appropriate permissions." } ] } ] }, { "name": "selectFiles", "type": "function", "description": "Selects multiple files.", "parameters": [ { "type": "array", "description": "Array of selected paths", "items": {"type": "string"} } ] }, { "name": "selectFile", "type": "function", "description": "Selects a file.", "parameters": [ { "type": "string", "description": "A selected path" }, { "type": "integer", "description": "Index of Filter" } ] }, { "name": "viewFiles", "type": "function", "description": "Views multiple files.", "parameters": [ { "name": "fileUrls", "type": "array", "description": "Array of selected paths", "items": {"type": "string"} }, { "name": "id", "type": "string", "description": "File browser handler id as for internal tasks." } ] }, { "name": "getVolumeMetadata", "description": "Requests volume's metadata", "parameters": [ { "name": "devicePath", "type": "string", "description": "Device path of the volume." }, { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name" : "volumeMetadata", "$ref": "VolumeMetadata", "optional": "true", "description": "A requested metadata dictionary object. null if there is no volume with selected devicePath" } ] } ] }, { "name": "addMount", "description": "Mount a resource or a file.", "parameters": [ { "name": "source", "type": "string", "description": "Mount point source. For compressed files it is relative file path within external file system" }, { "name": "mountType", "type": "string", "enum": ["device", "file", "network"], "description": "Mount point type. 'file' for compressed files" }, { "name": "options", "type": "object", "description": "Name/value pairs for source specific options", "optional": "true" } ] }, { "name": "removeMount", "description": "Unmounts a mounted resource.", "parameters": [ { "name": "mountPath", "type": "string", "description": "A path of the mount." } ] }, { "name": "getMountPoints", "description": "Get the list of mount points.", "parameters": [ { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name" : "mountPoints", "type": "array", "items": {"$ref": "MountPointInfo"}, "description": "The list of MountPointInfo representing mounted devices." } ] } ] }, { "name": "formatDevice", "description": "Formats a mounted device", "parameters": [ { "name": "mountPath", "type": "string", "description": "Device's mount path." } ] } ], "events": [ { "name": "onDiskChanged", "type": "function", "description": "Fired when disk mount/unmount event is detected.", "parameters": [ { "$ref": "MountEvent", "name": "event", "description": "Mount event information." } ] }, { "name": "onMountCompleted", "type": "function", "description": "Fired when mount event is detected.", "parameters": [ { "$ref": "MountCompletedEvent", "name": "event", "description": "MountCompleted event information." } ] }, { "name": "onFileChanged", "type": "function", "description": "Fired when watched file change event is detected.", "parameters": [ { "$ref": "FileWatchEvent", "name": "event", "description": "File watch event information." } ] } ] }, { "namespace": "mediaPlayerPrivate", "nodoc": "true", "types": [ { "id": "Playlist", "type": "object", "description": "Mediaplayer playlist stored in the browser (it extsts even if the mediaplayer is closed).", "properties": { "items": { "name": "items", "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "description": "URL of mediafile (in 'filesystem:' scheme for local files)." }, "error": { "type": "boolean", "description": "True if the file has failed to play ('playbackError' with its URL called)." } } } }, "position": { "type": "integer", "description": "Index of item in the 'items' array to play next." }, "pendingPlaybackRequest": { "type": "boolean", "optional": "true", "description": "Informs that a request to play current item has been received. This flag is reset automatically." } } } ], "functions": [ { "name": "playAt", "description": "Sets playlist positions and sets flag of pending play request. Then fires the onPlaylistChanged event.", "parameters": [ { "name": "position", "type": "integer", "description": "New position in the playlist." } ] }, { "name": "setPlaybackError", "description": "Marks the URL as failed to play one. Mediaplayer will visually marks such an item. Then fires the onPlaylistChanged event.", "parameters": [ { "name": "url", "type": "string", "description": "URL failed to play." } ] }, { "name": "getPlaylist", "type": "function", "description": "Returns current play list, position and flag of penging play request.", "parameters": [ { "name": "resetPendingPlaybackRequest", "type": "boolean", "description": "If true the result will include pending playback request status and this status will be reset." }, { "name": "callback", "type": "function", "description": "Callback to retrieve the playlist.", "parameters": [ { "name": "playlist", "$ref": "Playlist", "description": "Mediaplayer playlist stored in the browser (it extsts even if the mediaplayer is closed)." } ] } ] }, { "name": "togglePlaylistPanel", "description": "Shows or hides the playlist panel.", "parameters": [] }, { "name": "toggleFullscreen", "description": "Switches fullscreen mode on/off for the mediaplayer.", "parameters": [] }, { "name": "showPlaylistPanel", "description": "Shows the playlist panel.", "parameters": [] } ], "events": [ { "name": "onPlaylistChanged", "type": "function", "descrition": "Notifies that playlist content or state has been changed. Data could be retrieved via 'getPlaylist'.", "parameters": [] } ] }, { "namespace":"webstorePrivate", "nodoc": "true", "functions": [ { "name": "install", "description": "Installs the extension corresponding to the given id", "parameters": [ { "name": "expected_id", "type": "string", "description": "The id of the extension to install." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [] } ] }, { "name": "beginInstall", "description": "Initiates the install process for the given extension id", "parameters": [ { "name": "expected_id", "type": "string", "description": "The id of the extension to be installled. Must be called during a user gesture." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [] } ] }, { "name": "beginInstallWithManifest2", "description": "Initiates the install process for the given extension. This must be called during a user gesture.", "parameters": [ { "name": "details", "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extension to be installled.", "minLength": 32, "maxLength": 32 }, "manifest": { "type": "string", "description": "A string with the contents of the extension's manifest.json file. During the install process, the browser will check that the downloaded extension's manifest matches what was passed in here.", "minLength": 1 }, "iconData": { "type": "string", "optional": true, "description": "An icon as a base64-encoded image, displayed in a confirmation dialog." }, "localizedName": { "type": "string", "optional": true, "description": "A string to use instead of the raw value of the 'name' key from manifest.json." }, "locale": { "type": "string", "optional": true, "description": "The name of the locale used for generating localizedName. This should be the name of one of the directories in the _locales folder of the extension, or the default_locale setting from the manifest." } } }, { "name": "callback", "type": "function", "description": "Called when the user has either accepted/rejected the dialog, or some error occurred (such as invalid manifest or icon image data).", "optional": "true", "parameters": [ { "name": "result", "type": "string", "description": "A string result code, which will be empty upon success. The possible values in the case of errors include 'unknown_error', 'user_cancelled', 'manifest_error', 'icon_error', 'invalid_id', 'permission_denied', and 'no_gesture'." } ] } ] }, { "name": "completeInstall", "description": "", "parameters": [ { "name": "expected_id", "type": "string", "description": "The id of the extension to be installled. This should match a previous call to beginInstall." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [] } ] }, { "name": "getBrowserLogin", "description": "Returns the logged-in sync user login if there is one, or the empty string otherwise.", "parameters": [ { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name": "info", "type": "object", "properties": { "login": { "type": "string" }, "token": { "type": "string", "optional": true } } } ] } ] }, { "name": "getStoreLogin", "description": "Returns the previous value set by setStoreLogin, or the empty string if there is none.", "parameters": [ { "name": "callback", "type": "function", "optional": "false", "parameters": [ { "name": "login", "type": "string" } ] } ] }, { "name": "setStoreLogin", "description": "Sets a preference value with the store login.", "parameters": [ { "name": "login", "type": "string" }, { "name": "callback", "type": "function", "optional": "true" } ] }, { "name": "promptBrowserLogin", "description": "Causes the browser to bring up the browser login UI.", "parameters": [ { "name": "preferred_email", "type": "string", "description": "The email address to use to pre-populate the login dialog (can be an empty string)." }, { "name": "callback", "type": "function", "optional": "true", "parameters": [ { "name": "info", "type": "object", "properties": { "login": { "type": "string", "optional": true }, "token": { "type": "string", "optional": true } } } ] } ] } ] }, { "namespace": "webSocketProxyPrivate", "nodoc": true, "types": [], "functions": [ { "name": "getPassportForTCP", "description": "requests authorization token for websocket to TCP proxy.", "parameters": [ { "type": "string", "name": "hostname", "minLength": 1, "description": "hostname to which TCP connection is requested." }, { "type": "integer", "name": "port", "minimum": 1, "maximum": 65535, "description": "TCP port number." }, { "type": "function", "name": "callback", "parameters": [ { "type": "string", "name": "passport", "description": "Passport for passing to proxy." } ] } ] } ], "events": [] }, { "namespace": "types", "types": [ { "id": "ChromeSetting", "type": "object", "customBindings": "ChromeSetting", "description": "An interface which allows access to a Chrome browser setting.", "functions": [ { "name": "get", "type": "function", "description": "Gets the value of a setting.", "parameters": [ { "name": "details", "type": "object", "description": "What setting to consider.", "properties": { "incognito": { "type": "boolean", "optional": true, "description": "Whether to return the setting that applies to the incognito session (default false)." } } }, { "name": "callback", "type": "function", "parameters": [ { "name": "details", "type": "object", "description": "Details of the currently effective value.", "properties": { "value": { "description": "The value of the setting.", "type": "any" }, "levelOfControl": { "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", "type": "string", "enum": ["not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", "controlled_by_this_extension"] }, "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.", "type": "boolean", "optional": true } } } ] } ] }, { "name": "set", "type": "function", "description": "Sets the value of a setting.", "parameters": [ { "name": "details", "type": "object", "description": "What setting to change.", "properties": { "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" }, "scope": { "type": "string", "enum": ["regular", "incognito_persistent", "incognito_session_only"], "optional": true, "description": "Where to set the setting (default: regular). One of
regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
incognito_persistent: setting for incognito profile that survives browser restarts (overrides regular preferences),
incognito_session_only: setting for 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)." } } }, { "name": "callback", "type": "function", "description": "Called after the setting has been set.", "optional": true, "parameters": [] } ] }, { "name": "clear", "type": "function", "description": "Clears the setting. This way default settings can become effective again.", "parameters": [ { "name": "details", "type": "object", "description": "What setting to clear.", "properties": { "scope": { "type": "string", "enum": ["regular", "incognito_persistent", "incognito_session_only"], "optional": true, "description": "Where to clear the setting (default: regular). One of
regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
incognito_persistent: setting for incognito profile that survives browser restarts (overrides regular preferences),
incognito_session_only: setting for 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)." } } }, { "name": "callback", "type": "function", "description": "Called after the setting has been cleared.", "optional": true, "parameters": [] } ] } ], "events": [ { "name": "onChange", "description": "Fired when the value of the setting changes.", "parameters": [ { "type": "object", "name": "details", "properties": { "value": { "description": "The value of the setting.", "type": "any" }, "levelOfControl": { "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", "type": "string", "enum": ["not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", "controlled_by_this_extension"] }, "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.", "type": "boolean", "optional": true } } } ] } ] } ] }, { "namespace": "experimental.contentSettings", "types": [ { "id": "ResourceIdentifier", "type": "object", "properties": { "id": { "type": "string", "description": "The resource identifier for the given content type." }, "description": { "type": "string", "optional": true, "description": "A human readable description of the resource." } }, "description": "Currently, no content types use resource identifiers." }, { "id": "ContentSetting", "type": "object", "functions": [ { "name": "clear", "type": "function", "description": "Clear all content setting rules set by this extension.", "parameters": [ { "name": "details", "type": "object", "properties": { "scope": { "type": "string", "enum": ["regular", "incognito_session_only"], "optional": true, "description": "Where to set the setting (default: regular). One of
regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
incognito_session_only: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings)." } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [] } ] }, { "name": "get", "type": "function", "description": "Gets the current content setting for a given pair of URLs.", "parameters": [ { "name": "details", "type": "object", "properties": { "primaryUrl": { "type": "string", "description": "The primary URL for which the content setting should be retrieved. Note that the meaning of a primary URL depends on the content type." }, "secondaryUrl": { "type": "string", "description": "The secondary URL for which the content setting should be retrieved. Defaults to the primary URL. Note that the meaning of a secondary URL depends on the content type, and not all content types use secondary URLs.", "optional": true }, "resourceIdentifier": { "$ref": "ResourceIdentifier", "optional": true, "description": "A more specific identifier of the type of content for which the settings should be retrieved." }, "incognito": { "type": "boolean", "optional": true, "description": "Whether to check the content settings for an incognito session. (default false)" } } }, { "type": "function", "name": "callback", "parameters": [ { "name": "details", "type": "object", "properties": { "setting": { "type": "any", "description": "The content setting. See the description of the individual ContentSetting objects for the possible values." } } } ] } ] }, { "name": "set", "type": "function", "description": "Applies a new content setting rule.", "parameters": [ { "name": "details", "type": "object", "properties": { "primaryPattern": { "type": "string", "description": "The pattern for the primary URL. For details on the format of a pattern, see Match Patterns." }, "secondaryPattern": { "type": "string", "description": "The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see Match Patterns.", "optional": true }, "resourceIdentifier": { "$ref": "ResourceIdentifier", "optional": true, "description": "The resource identifier for the content type." }, "setting": { "type": "any", "description": "The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values." }, "scope": { "type": "string", "enum": ["regular", "incognito_session_only"], "optional": true, "description": "Where to clear the setting (default: regular). One of
regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
incognito_session_only: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings)." } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [] } ] }, { "name": "getResourceIdentifiers", "type": "function", "description": "", "parameters": [ { "name": "callback", "type": "function", "parameters": [ { "type": "array", "description": "A list of resource identifiers for this content type, or undefined if this content type does not use resource identifiers.", "optional": true, "items": { "$ref": "ResourceIdentifier" } } ] } ] } ] } ], "properties": { "global": { "type": "object", "value": {}, "properties": { "thirdPartyCookiesAllowed": { "$ref": "ChromeSetting", "value": ["thirdPartyCookiesAllowed", {"type": "boolean"}], "description": "Whether third party cookies should be allowed. The value of this preference is of type boolean, and the default value is true." }, "referrersEnabled": { "$ref": "ChromeSetting", "value": ["referrersEnabled", {"type":"boolean"}], "description": "Whether referrers should be enabled. The value of this preference is of type boolean, and the default value is true." }, "hyperlinkAuditingEnabled": { "$ref": "ChromeSetting", "value": ["hyperlinkAuditingEnabled", {"type":"boolean"}], "description": "Whether to enable hyperlink auditing (\"<a ping>\"). The value of this preference is of type boolean, and the default value is true." } } }, "cookies": { "$ref": "ContentSetting", "description": "Whether to allow cookies and other local data to be set by websites. One of
allow: Accept cookies,
block: Block cookies,
session_only: Accept cookies only for the current session. Default is allow.
The primary URL is the URL representing the cookie origin. The secondary URL is the URL of the top-level frame.", "value": [ "cookies", {"type":"string", "enum": ["allow", "block", "session_only"]} ] }, "images": { "$ref": "ContentSetting", "description": "Whether to show images. One of
allow: Show images,
block: Don't show images. Default is allow.
The primary URL is the main-frame URL. The secondary URL is not used.", "value": [ "images", {"type":"string", "enum": ["allow", "block"]} ] }, "javascript": { "$ref": "ContentSetting", "description": "Whether to run Javascript. One of
allow: Run Javascript,
block: Don't run Javascript. Default is allow.
The primary URL is the main-frame URL. The secondary URL is not used.", "value": [ "javascript", {"type":"string", "enum": ["allow", "block"]} ] }, "plugins": { "$ref": "ContentSetting", "description": "Whether to run plug-ins. One of
allow: Run plug-ins automatically,
block: Don't run plug-ins automatically. Default is allow.
The primary URL is the main-frame URL. The secondary URL is not used.", "value": [ "plugins", {"type":"string", "enum": ["allow", "block"]} ] }, "popups": { "$ref": "ContentSetting", "description": "Whether to allow sites to show pop-ups. One of
allow: Allow sites to show pop-ups,
block: Don't allow sites to show pop-ups. Default is block.
The primary URL is the main-frame URL. The secondary URL is not used.", "value": [ "popups", {"type":"string", "enum": ["allow", "block"]} ] }, "notifications": { "$ref": "ContentSetting", "description": "Whether to allow sites to show desktop notifications. One of
allow: Allow sites to show desktop notifications,
block: Don't allow sites to show desktop notifications,
ask: Ask when a site wants to show desktop notifications. Default is ask.
The primary URL is the main-frame URL. The secondary URL is not used.", "value": [ "notifications", {"type":"string", "enum": ["allow", "block", "ask"]} ] } } }, { "namespace": "experimental.debugger", "functions": [ { "name": "attach", "type": "function", "description": "Attaches debugger to the tab with given id.", "parameters": [ { "type": "integer", "name": "tabId", "description": "The id of the tab to which you want to attach." }, { "type": "function", "name": "callback", "optional": true, "parameters": [], "description": "If an error occurs while attaching to the tab, the callback will be called with no arguments and chrome.extension.lastError will be set to the error message." } ] }, { "name": "detach", "type": "function", "description": "Detaches debugger from a tab with given id.", "parameters": [ { "type": "integer", "name": "tabId", "description": "The id of the tab from which you want to detach." }, { "type": "function", "name": "callback", "optional": true, "parameters": [], "description": "If an error occurs while detaching from the tab, the callback will be called with no arguments and chrome.extension.lastError will be set to the error message." } ] }, { "name": "sendRequest", "type": "function", "description": "Sends given request to the debugger.", "parameters": [ { "type": "integer", "name": "tabId", "description": "The id of the tab to which you want to send debugging request." }, { "type": "string", "name": "method", "description": "Method name." }, { "type": "object", "name": "params", "optional": true, "properties": {}, "additionalProperties": { "type": "any" }, "description": "JSON object matching Developer Tools / Web Inspector Protocol scheme." }, { "type": "function", "name": "callback", "optional": true, "parameters": [ { "type": "object", "name": "result", "optional": true, "properties": {}, "additionalProperties": { "type": "any" }, "description": "JSON object with the request response." } ], "description": "Request response body. If an error occurs while posting the message, the callback will be called with no arguments and chrome.extension.lastError will be set to the error message." } ] } ], "events": [ { "name": "onEvent", "type": "function", "description": "Fired whenever debugger issues instrumentation event.", "parameters": [ { "type": "integer", "name": "tabId", "description": "The id of the tab that generated debug evet." }, { "type": "string", "name": "method", "description": "Method name." }, { "type": "object", "name": "params", "optional": true, "properties": {}, "additionalProperties": { "type": "any" }, "description": "JSON object matching Developer Tools / Web Inspector Protocol event data scheme." } ] }, { "name": "onDetach", "type": "function", "description": "Fired when browser terminates debugging session for the tab.", "parameters": [ { "type": "integer", "name": "tabId", "description": "The id of the tab that was detached." } ] } ] }, { "namespace":"experimental.app", "functions": [ { "name": "notify", "type": "function", "description": "Creates a notification from this app.", "parameters": [ { "type": "object", "name": "details", "properties": { "extensionId": { "type": "string", "optional": true, "description": "An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable." }, "title": { "type": "string", "optional": true, "description": "The title of the notification." }, "bodyText": { "type": "string", "optional": true, "description": "The text content of the notification." }, "linkUrl": { "type": "string", "optional": true, "description": "The URL for an optional link to show along with the notification. If you specify a linkUrl, you must also specify a value for linkText." }, "linkText": { "type": "string", "optional": true, "description": "If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short." }, "iconData": { "nodoc": true, "type": "object", "isInstanceOf": "ImageData", "optional": true, "properties": {}, "additionalProperties": { "type": "any" }, "description": "Pixel data for an image to use as the icon for this notification. Must be an ImageData object (for example, from a canvas element)." } } }, { "type": "function", "name": "callback", "optional": true, "parameters": [], "description": "A callback when the function is complete. Any errors will be reported in chrome.extension.lastError." } ] }, { "name": "clearAllNotifications", "type": "function", "description": "Clears all previously sent notifications.", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "extensionId": { "type": "string", "optional": true, "description": "An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable." } } }, { "type": "function", "name": "callback", "optional": true, "description": "A callback when the function is complete. Any errors will be reported in chrome.extension.lastError." } ] }, { "name": "setLaunchIcon", "nodoc": true, "type": "function", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "extensionId": { "type": "string", "optional": true, "description": "An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable." } } }, { "type": "object", "name": "iconData", "isInstanceOf": "ImageData", "optional": true, "properties": {}, "additionalProperties": { "type": "any" }, "description": "Pixel data for an image to replace the launch icon on the New Tab Page. Must be an ImageData object (for example, from a canvas element). See http://code.google.com/chrome/webstore/docs/images.html for more details." }, { "type": "function", "name": "callback", "optional": true, "description": "A callback when the function is complete. Any errors will be reported in chrome.extension.lastError." } ] }, { "name": "resetLaunchIcon", "nodoc": true, "type": "function", "description": "Resets the app's launch icon to its default value as specified in the manifest.json file.", "parameters": [ { "type": "object", "name": "details", "optional": true, "properties": { "extensionId": { "type": "string", "optional": true, "description": "An optional id to do notifications for an app other than the calling app. This is just to allow prototyping with an extension that sends notifications on behalf of apps that don't support notifications yet; this will be removed before the API becomes stable." } } }, { "type": "function", "name": "callback", "optional": true, "description": "A callback when the function is complete. Any errors will be reported in chrome.extension.lastError." } ] } ] }, { "namespace": "chromeAuthPrivate", "nodoc": "true", "functions": [ { "name": "setCloudPrintCredentials", "description": "Sets the login credentials for Cloud Print.", "type": "function", "parameters": [ { "name": "userEmail", "type": "string", "description": "The email address of the user." }, { "name": "robotEmail", "type": "string", "description": "The email address of the robot account." }, { "name": "credentials", "type": "string", "description": "The login credentials(OAuth2 Auth code)." }, { "name": "callback", "type": "function", "description": "Called when a failure happens. Called upon success only in tests.", "optional": "true", "parameters": [ { "name": "result", "type": "string", "description": "A string result code. The value is non-empty on success only in tests.", "optional": "true" } ] } ] } ] } ]