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, "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."} , | 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.", "deprecated": "Please use $(ref:tabs.Tab.highlighted)."}, | 19 "selected": {"type": "boolean", "description": "Whether the tab is sel ected.", "deprecated": "Please use $(ref:tabs.Tab.highlighted)."}, |
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 "audible": {"type": "boolean", "optional": true, "description": "Wheth er the tab is audible."}, | |
not at google - send to devlin
2015/03/10 22:30:08
Explain the difference between audible and muted,
Jared Sohn
2015/03/16 02:34:29
Here is my new verbiage (feel free to give feedbac
not at google - send to devlin
2015/03/16 17:47:08
Perfect.
| |
24 "muted": {"type": "boolean", "optional": true, "description": "Whether the tab is muted."}, | |
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."}, | 25 "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."}, | 26 "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."}, | 27 "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>."}, | 28 "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."}, | 29 "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."}, | 30 "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."}, | 31 "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 ."} | 32 "sessionId": {"type": "string", "optional": true, "description": "The session ID used to uniquely identify a Tab obtained from the $(ref:sessions) API ."} |
31 } | 33 } |
32 }, | 34 }, |
(...skipping 326 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
359 "active": { | 361 "active": { |
360 "type": "boolean", | 362 "type": "boolean", |
361 "optional": true, | 363 "optional": true, |
362 "description": "Whether the tabs are active in their windows." | 364 "description": "Whether the tabs are active in their windows." |
363 }, | 365 }, |
364 "pinned": { | 366 "pinned": { |
365 "type": "boolean", | 367 "type": "boolean", |
366 "optional": true, | 368 "optional": true, |
367 "description": "Whether the tabs are pinned." | 369 "description": "Whether the tabs are pinned." |
368 }, | 370 }, |
371 "audible": { | |
372 "type": "boolean", | |
373 "optional": true, | |
374 "description": "Whether the tabs are audible." | |
375 }, | |
376 "muted": { | |
377 "type": "boolean", | |
378 "optional": true, | |
379 "description": "Whether the tabs are muted." | |
380 }, | |
369 "highlighted": { | 381 "highlighted": { |
370 "type": "boolean", | 382 "type": "boolean", |
371 "optional": true, | 383 "optional": true, |
372 "description": "Whether the tabs are highlighted." | 384 "description": "Whether the tabs are highlighted." |
373 }, | 385 }, |
374 "currentWindow": { | 386 "currentWindow": { |
375 "type": "boolean", | 387 "type": "boolean", |
376 "optional": true, | 388 "optional": true, |
377 "description": "Whether the tabs are in the <a href='windows#cur rent-window'>current window</a>." | 389 "description": "Whether the tabs are in the <a href='windows#cur rent-window'>current window</a>." |
378 }, | 390 }, |
(...skipping 128 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
507 "deprecated": "Please use <em>highlighted</em>.", | 519 "deprecated": "Please use <em>highlighted</em>.", |
508 "type": "boolean", | 520 "type": "boolean", |
509 "optional": true, | 521 "optional": true, |
510 "description": "Whether the tab should be selected." | 522 "description": "Whether the tab should be selected." |
511 }, | 523 }, |
512 "pinned": { | 524 "pinned": { |
513 "type": "boolean", | 525 "type": "boolean", |
514 "optional": true, | 526 "optional": true, |
515 "description": "Whether the tab should be pinned." | 527 "description": "Whether the tab should be pinned." |
516 }, | 528 }, |
529 "muted": { | |
530 "type": "boolean", | |
531 "optional": true, | |
532 "description": "Whether the tab should be muted." | |
533 }, | |
517 "openerTabId": { | 534 "openerTabId": { |
518 "type": "integer", | 535 "type": "integer", |
519 "minimum": 0, | 536 "minimum": 0, |
520 "optional": true, | 537 "optional": true, |
521 "description": "The ID of the tab that opened this tab. If speci fied, the opener tab must be in the same window as this tab." | 538 "description": "The ID of the tab that opened this tab. If speci fied, the opener tab must be in the same window as this tab." |
522 } | 539 } |
523 } | 540 } |
524 }, | 541 }, |
525 { | 542 { |
526 "type": "function", | 543 "type": "function", |
(...skipping 327 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
854 "url": { | 871 "url": { |
855 "type": "string", | 872 "type": "string", |
856 "optional": true, | 873 "optional": true, |
857 "description": "The tab's URL if it has changed." | 874 "description": "The tab's URL if it has changed." |
858 }, | 875 }, |
859 "pinned": { | 876 "pinned": { |
860 "type": "boolean", | 877 "type": "boolean", |
861 "optional": true, | 878 "optional": true, |
862 "description": "The tab's new pinned state." | 879 "description": "The tab's new pinned state." |
863 }, | 880 }, |
881 "audible": { | |
882 "type": "boolean", | |
883 "optional": true, | |
884 "description": "The tab's new audible state." | |
885 }, | |
886 "muted": { | |
887 "type": "boolean", | |
888 "optional": true, | |
889 "description": "The tab's new muted state." | |
890 }, | |
891 "cause": { | |
not at google - send to devlin
2015/03/10 22:30:08
I'd rather "mutedCause" because this is muted spec
Jared Sohn
2015/03/16 02:34:29
I had been debating that; "cause" could be reused
| |
892 "type": "string", | |
893 "optional": true, | |
894 "description": "When the muted state changes, indicates what cau sed it ('user', 'capture', or an extension id)." | |
895 }, | |
864 "favIconUrl": { | 896 "favIconUrl": { |
865 "type": "string", | 897 "type": "string", |
866 "optional": true, | 898 "optional": true, |
867 "description": "The tab's new favicon URL." | 899 "description": "The tab's new favicon URL." |
868 } | 900 } |
869 } | 901 } |
870 }, | 902 }, |
871 { | 903 { |
872 "$ref": "Tab", | 904 "$ref": "Tab", |
873 "name": "tab", | 905 "name": "tab", |
(...skipping 208 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
1082 "tabId": {"type": "integer", "minimum": 0}, | 1114 "tabId": {"type": "integer", "minimum": 0}, |
1083 "oldZoomFactor": {"type": "number"}, | 1115 "oldZoomFactor": {"type": "number"}, |
1084 "newZoomFactor": {"type": "number"}, | 1116 "newZoomFactor": {"type": "number"}, |
1085 "zoomSettings": {"$ref": "ZoomSettings"} | 1117 "zoomSettings": {"$ref": "ZoomSettings"} |
1086 } | 1118 } |
1087 }] | 1119 }] |
1088 } | 1120 } |
1089 ] | 1121 ] |
1090 } | 1122 } |
1091 ] | 1123 ] |
OLD | NEW |