diff options
Diffstat (limited to 'chrome/common/extensions/api/extension_api.json')
| -rw-r--r-- | chrome/common/extensions/api/extension_api.json | 299 |
1 files changed, 0 insertions, 299 deletions
diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json index 4e4c442..68d40b1 100644 --- a/chrome/common/extensions/api/extension_api.json +++ b/chrome/common/extensions/api/extension_api.json @@ -1544,305 +1544,6 @@ ] }, { - "namespace": "experimental.sidebar", - "types": [], - "functions": [ - { - "name": "show", - "type": "function", - "description": "Shows sidebar mini tab for the specified tab and content id. Has no effect if already expanded, otherwise sets status to 'shown'.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to show the sidebar for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - }, - "imagePath": { - "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 allowed. 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." - }, - "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 <code>canvas</code> element). Only one of the imagePath/imageData parameters allowed. 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 - }, - "title": { - "type": "string", - "optional": true, - "description": "Sets the sidebar's title. It is displayed in a tooltip over the sidebar's mini tab." - }, - "badgeText": { - "type": "string", - "optional": true, - "description": "Sets the sidebar's badge text. The badge is displayed on top of the sidebar's icon on the mini tab." - } - } - } - ] - }, - { - "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 and content id. Extension is allowed to expand sidebar only in response to an explicit user gesture.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to expand the sidebar for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content to show. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - } - } - } - ] - }, - { - "name": "collapse", - "type": "function", - "description": "Collapses sidebar for the specified tab and content id. Has no effect if sidebar is not in its 'active' state (see getState).", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to collapse the sidebar for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - } - } - } - ] - }, - { - "name": "hide", - "type": "function", - "description": "Hides sidebar mini tab for the specified tab and content id and collapses sidebar if it was in 'active' state (see getState). Has no effect if the sidebar is already hidden.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to hide the sidebar for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - } - } - } - ] - }, - { - "name": "setIcon", - "type": "function", - "description": "Sets sidebar's mini tab icon for the specified tab and content id.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to set attributes for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - }, - "imagePath": { - "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 allowed. 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." - }, - "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 <code>canvas</code> element). Only one of the imagePath/imageData parameters allowed. 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 - } - } - } - ] - }, - { - "name": "setTitle", - "type": "function", - "description": "Sets sidebar's mini tab title for the specified tab and content id.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to set attributes for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - }, - "title": { - "type": "string", - "description": "The sidebar's title. It is displayed in a tooltip over the sidebar's mini tab." - } - } - } - ] - }, - { - "name": "setBadgeText", - "type": "function", - "description": "Sets sidebar's mini tab badge text for the specified tab and content id.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to set attributes for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - }, - "badgeText": { - "type": "string", - "description": "The sidebar's badge text. The badge is displayed on top of the sidebar's icon on the mini tab." - } - } - } - ] - }, - { - "name": "navigateTo", - "type": "function", - "description": "Navigates sidebar for the specified tab and content id to the specified URL.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to navigate sidebar for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - }, - "url": { - "type": "string", - "description": "URL to navigate sidebar content to." - } - } - } - ] - }, - { - "name": "getState", - "type": "function", - "description": "Returns current sidebar state for the specified tab and content id.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "optional": true, - "description": "The tab id for the tab to check sidebar visibility for. Uses the current selected tab when omitted." - }, - "contentId": { - "type": "string", - "optional": true, - "description": "An arbitrary string identifying the sidebar content. Used for identification purposes only in case of multiple sidebars, invisible for a user. Defaults to the extension's Id." - } - } - }, - { - "type": "function", - "name": "callback", - "parameters": [ - { - "name": "result", "type": "string", "enum": ["hidden", "shown", "active"], - "description": "'hidden' indicates sidebar is not defined for the specified tab and content id (show was never called or hide() was called). Nothing is displayed for this sidebar.<br/>'shown' means sidebar is defined for the specified tab and content id; mini tab is displayed for this sidebar. Sidebar UI is either collapsed or displaying a content of some other extension's sidebar.<br/>'active' indicates that sidebar is defined for the specified tab and content id; sidebar UI is expanded and displaying this sidebar's content." - } - ] - } - ] - } - ], - "events": [ - { - "name": "onStateChanged", - "type": "function", - "description": "Notifies about sidebar state changes.", - "parameters": [ - { - "name": "details", - "type": "object", - "properties": { - "tabId": { - "type": "integer", - "description": "The tab id for the tab to sidebar state changed for." - }, - "contentId": { - "type": "string", - "description": "The content Id of the sidebar which state has changed." - }, - "state": { - "type": "string", - "enum": ["hidden", "shown", "active"], - "description": "See getState() for more details." - } - } - } - ] - } - ] - }, - { "namespace": "bookmarks", "types": [ { |