OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 [ | 5 [ |
6 { | 6 { |
7 "namespace": "tabs", | 7 "namespace": "tabs", |
8 "description": "Use the <code>chrome.tabs</code> API to interact with the br
owser's tab system. You can use this API to create, modify, and rearrange tabs i
n the browser.", | 8 "description": "Use the <code>chrome.tabs</code> API to interact with the br
owser's tab system. You can use this API to create, modify, and rearrange tabs i
n the browser.", |
9 "types": [ | 9 "types": [ |
10 { | 10 { |
11 "id": "Tab", | 11 "id": "Tab", |
12 "type": "object", | 12 "type": "object", |
13 "properties": { | 13 "properties": { |
14 "id": {"type": "integer", "minimum": 0, "description": "The ID of the
tab. Tab IDs are unique within a browser session."}, | 14 "id": {"type": "integer", "minimum": 0, "optional": true, "description
": "The ID of the tab. Tab IDs are unique within a browser session. Under some c
ircumstances a Tab may not be assigned an ID, for example when querying foreign
tabs using the $ref:sessions API, in which case a session ID may be present."}, |
15 // TODO(kalman): Investigate how this is ending up as -1 (based on win
dow type? a bug?) and whether it should be optional instead. | 15 // TODO(kalman): Investigate how this is ending up as -1 (based on win
dow type? a bug?) and whether it should be optional instead. |
16 "index": {"type": "integer", "minimum": -1, "description": "The zero-b
ased index of the tab within its window."}, | 16 "index": {"type": "integer", "minimum": -1, "description": "The zero-b
ased index of the tab within its window."}, |
17 "windowId": {"type": "integer", "minimum": 0, "description": "The ID o
f the window the tab is contained within."}, | 17 "windowId": {"type": "integer", "minimum": 0, "description": "The ID o
f the window the tab is contained within."}, |
18 "openerTabId": {"type": "integer", "minimum": 0, "optional": true, "de
scription": "The ID of the tab that opened this tab, if any. This property is on
ly present if the opener tab still exists."}, | 18 "openerTabId": {"type": "integer", "minimum": 0, "optional": true, "de
scription": "The ID of the tab that opened this tab, if any. This property is on
ly present if the opener tab still exists."}, |
19 "selected": {"type": "boolean", "description": "Whether the tab is sel
ected.", "nodoc": true}, | 19 "selected": {"type": "boolean", "description": "Whether the tab is sel
ected.", "nodoc": true}, |
20 "highlighted": {"type": "boolean", "description": "Whether the tab is
highlighted."}, | 20 "highlighted": {"type": "boolean", "description": "Whether the tab is
highlighted."}, |
21 "active": {"type": "boolean", "description": "Whether the tab is activ
e in its window. (Does not necessarily mean the window is focused.)"}, | 21 "active": {"type": "boolean", "description": "Whether the tab is activ
e in its window. (Does not necessarily mean the window is focused.)"}, |
22 "pinned": {"type": "boolean", "description": "Whether the tab is pinne
d."}, | 22 "pinned": {"type": "boolean", "description": "Whether the tab is pinne
d."}, |
23 "url": {"type": "string", "optional": true, "description": "The URL th
e tab is displaying. This property is only present if the extension's manifest i
ncludes the <code>\"tabs\"</code> permission."}, | 23 "url": {"type": "string", "optional": true, "description": "The URL th
e tab is displaying. This property is only present if the extension's manifest i
ncludes the <code>\"tabs\"</code> permission."}, |
24 "title": {"type": "string", "optional": true, "optional": true, "descr
iption": "The title of the tab. This property is only present if the extension's
manifest includes the <code>\"tabs\"</code> permission."}, | 24 "title": {"type": "string", "optional": true, "optional": true, "descr
iption": "The title of the tab. This property is only present if the extension's
manifest includes the <code>\"tabs\"</code> permission."}, |
25 "favIconUrl": {"type": "string", "optional": true, "optional": true, "
description": "The URL of the tab's favicon. This property is only present if th
e extension's manifest includes the <code>\"tabs\"</code> permission. It may als
o be an empty string if the tab is loading."}, | 25 "favIconUrl": {"type": "string", "optional": true, "optional": true, "
description": "The URL of the tab's favicon. This property is only present if th
e extension's manifest includes the <code>\"tabs\"</code> permission. It may als
o be an empty string if the tab is loading."}, |
26 "status": {"type": "string", "optional": true, "description": "Either
<em>loading</em> or <em>complete</em>."}, | 26 "status": {"type": "string", "optional": true, "description": "Either
<em>loading</em> or <em>complete</em>."}, |
27 "incognito": {"type": "boolean", "description": "Whether the tab is in
an incognito window."}, | 27 "incognito": {"type": "boolean", "description": "Whether the tab is in
an incognito window."}, |
28 "width": {"type": "integer", "optional": true, "description": "The wid
th of the tab in pixels."}, | 28 "width": {"type": "integer", "optional": true, "description": "The wid
th of the tab in pixels."}, |
29 "height": {"type": "integer", "optional": true, "description": "The he
ight of the tab in pixels."} | 29 "height": {"type": "integer", "optional": true, "description": "The he
ight of the tab in pixels."}, |
| 30 "sessionId": {"type": "string", "optional": true, "description": "The
session ID used to uniquely identify a Tab obtained from the $ref:sessions API."
} |
30 } | 31 } |
31 }, | 32 }, |
32 { | 33 { |
33 "id": "InjectDetails", | 34 "id": "InjectDetails", |
34 "type": "object", | 35 "type": "object", |
35 "description": "Details of the script or CSS to inject. Either the code
or the file property must be set, but both may not be set at the same time.", | 36 "description": "Details of the script or CSS to inject. Either the code
or the file property must be set, but both may not be set at the same time.", |
36 "properties": { | 37 "properties": { |
37 "code": {"type": "string", "optional": true, "description": "JavaScrip
t or CSS code to inject."}, | 38 "code": {"type": "string", "optional": true, "description": "JavaScrip
t or CSS code to inject."}, |
38 "file": {"type": "string", "optional": true, "description": "JavaScrip
t or CSS file to inject."}, | 39 "file": {"type": "string", "optional": true, "description": "JavaScrip
t or CSS file to inject."}, |
39 "allFrames": {"type": "boolean", "optional": true, "description": "If
allFrames is <code>true</code>, implies that the JavaScript or CSS should be inj
ected into all frames of current page. By default, it's <code>false</code> and i
s only injected into the top frame."}, | 40 "allFrames": {"type": "boolean", "optional": true, "description": "If
allFrames is <code>true</code>, implies that the JavaScript or CSS should be inj
ected into all frames of current page. By default, it's <code>false</code> and i
s only injected into the top frame."}, |
(...skipping 892 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
932 "type": "function", | 933 "type": "function", |
933 "description": "Fired when a tab is replaced with another tab due to pre
rendering or instant.", | 934 "description": "Fired when a tab is replaced with another tab due to pre
rendering or instant.", |
934 "parameters": [ | 935 "parameters": [ |
935 {"type": "integer", "name": "addedTabId", "minimum": 0}, | 936 {"type": "integer", "name": "addedTabId", "minimum": 0}, |
936 {"type": "integer", "name": "removedTabId", "minimum": 0} | 937 {"type": "integer", "name": "removedTabId", "minimum": 0} |
937 ] | 938 ] |
938 } | 939 } |
939 ] | 940 ] |
940 } | 941 } |
941 ] | 942 ] |
OLD | NEW |