Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(586)

Side by Side Diff: chrome/common/extensions/api/extension_api.json

Issue 180016: Extension API Renaming/Consistency changes (Closed)
Patch Set: render docs Created 11 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « chrome/common/common_resources.grd ('k') | chrome/common/extensions/docs/api_other.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 [ 1 [
2 { 2 {
3 "namespace": "extension", 3 "namespace": "extension",
4 "types": [ 4 "types": [
5 { 5 {
6 "id": "Port", 6 "id": "Port",
7 "type": "object", 7 "type": "object",
8 "description": "An object which allows two way communication with other pages.", 8 "description": "An object which allows two way communication with other pages.",
9 "properties": { 9 "properties": {
10 "name": {"type": "string"}, 10 "name": {"type": "string"},
(...skipping 13 matching lines...) Expand all
24 } 24 }
25 } 25 }
26 }, 26 },
27 "functions": [ 27 "functions": [
28 { 28 {
29 "name": "connect", 29 "name": "connect",
30 "type": "function", 30 "type": "function",
31 "description": "Attempts to connect to other listeners within the extens ion (listeners may be toolstrips or the extension's background page). This is pr imarily useful for content scripts connecting to their extension processes. Exte nsions may connect to content scripts embedded in tabs via <a href='broken'><var >chrome.tabs.connectToTab</var></a>.", 31 "description": "Attempts to connect to other listeners within the extens ion (listeners may be toolstrips or the extension's background page). This is pr imarily useful for content scripts connecting to their extension processes. Exte nsions may connect to content scripts embedded in tabs via <a href='broken'><var >chrome.tabs.connectToTab</var></a>.",
32 "parameters": [ 32 "parameters": [
33 { 33 {
34 "name": "name", 34 "type": "object",
35 "type": "string", 35 "name": "connectInfo",
36 "description": "Will be passed into onConnect for extension processe s that are listening for the connection event.", 36 "properties": {
37 "name": { "type": "string", "optional": true, "description": "Will be passed into onConnect for extension processes that are listening for the con nection event." }
38 },
37 "optional": true 39 "optional": true
38 } 40 }
39 ], 41 ],
40 "returns": { 42 "returns": {
41 "$ref": "Port", 43 "$ref": "Port",
42 "description": "Port through which messages can be sent and received w ith the extension." 44 "description": "Port through which messages can be sent and received w ith the extension."
43 } 45 }
44 }, 46 },
45 { 47 {
46 "name": "getViews", 48 "name": "getViews",
(...skipping 116 matching lines...) Expand 10 before | Expand all | Expand 10 after
163 { 165 {
164 "name": "window", "$ref": "Window" 166 "name": "window", "$ref": "Window"
165 } 167 }
166 ] 168 ]
167 } 169 }
168 ] 170 ]
169 }, 171 },
170 { 172 {
171 "name": "getAll", 173 "name": "getAll",
172 "type": "function", 174 "type": "function",
173 "description": "Get all windows. If <var>populate</var> is true, each wi ndow object will have a <var>tabs</var> property that contains a list of the Tab objects for that window.", 175 "description": "Get all windows.",
174 "parameters": [ 176 "parameters": [
175 {"type": "boolean", "name": "populate", "optional": true}, 177 {
178 "type": "object",
179 "name": "getInfo",
180 "optional": true,
181 "description": "",
182 "properties": {
183 "populate": {"type": "boolean", "optional": true, "description": " If true, each window object will have a <var>tabs</var> property that contains a list of the Tab objects for that window." }
184 }
185 },
176 { 186 {
177 "type": "function", 187 "type": "function",
178 "name": "callback", 188 "name": "callback",
179 "parameters": [ 189 "parameters": [
180 { 190 {
181 "name": "windows", "type": "array", "items": { "$ref": "Window" } 191 "name": "windows", "type": "array", "items": { "$ref": "Window" }
182 } 192 }
183 ] 193 ]
184 } 194 }
185 ] 195 ]
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after
250 {"type": "function", "name": "callback", "optional": true, "parameters ": []} 260 {"type": "function", "name": "callback", "optional": true, "parameters ": []}
251 ] 261 ]
252 } 262 }
253 ], 263 ],
254 "events": [ 264 "events": [
255 { 265 {
256 "name": "onCreated", 266 "name": "onCreated",
257 "type": "function", 267 "type": "function",
258 "description": "", 268 "description": "",
259 "parameters": [ 269 "parameters": [
260 {"type": "integer", "name": "windowId", "minimum": 0} 270 {
271 "type": "object",
272 "name": "createInfo",
273 "properties": {
274 "id": {"type": "integer", "minimum": 0}
275 }
276 }
261 ] 277 ]
262 }, 278 },
263 { 279 {
264 "name": "onRemoved", 280 "name": "onRemoved",
265 "type": "function", 281 "type": "function",
266 "description": "", 282 "description": "",
267 "parameters": [ 283 "parameters": [
268 {"type": "integer", "name": "windowId", "minimum": 0} 284 {"type": "integer", "name": "windowId", "minimum": 0}
269 ] 285 ]
270 }, 286 },
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after
311 ] 327 ]
312 } 328 }
313 ] 329 ]
314 }, 330 },
315 { 331 {
316 "name": "connect", 332 "name": "connect",
317 "type": "function", 333 "type": "function",
318 "description": "", 334 "description": "",
319 "parameters": [ 335 "parameters": [
320 {"type": "integer", "name": "tabId", "optional": true, "minimum": 0}, 336 {"type": "integer", "name": "tabId", "optional": true, "minimum": 0},
321 {"type": "string", "name": "name", "optional": true} 337 {
338 "type": "object",
339 "name": "connectInfo",
340 "properties": {
341 "name": { "type": "string", "optional": true, "description": "Will be passed into onConnect for content scripts that are listening for the connect ion event." }
342 },
343 "optional": true
344 }
322 ], 345 ],
323 "returns": { 346 "returns": {
324 "$ref": "Port" 347 "$ref": "Port"
325 } 348 }
326 }, 349 },
327 { 350 {
328 "name": "getSelected", 351 "name": "getSelected",
329 "type": "function", 352 "type": "function",
330 "description": "", 353 "description": "",
331 "parameters": [ 354 "parameters": [
(...skipping 426 matching lines...) Expand 10 before | Expand all | Expand 10 after
758 "type": "function", 781 "type": "function",
759 "description": "", 782 "description": "",
760 "parameters": [ 783 "parameters": [
761 {"type": "string", "name": "id"}, 784 {"type": "string", "name": "id"},
762 {"type": "function", "name": "callback", "optional": true, "parameters ": []} 785 {"type": "function", "name": "callback", "optional": true, "parameters ": []}
763 ] 786 ]
764 } 787 }
765 ], 788 ],
766 "events": [ 789 "events": [
767 { 790 {
768 "name": "onAdded", 791 "name": "onCreated",
769 "type": "function", 792 "type": "function",
770 "description": "", 793 "description": "",
771 "parameters": [ 794 "parameters": [
772 {"type": "string", "name": "id"}, 795 {"type": "string", "name": "id"},
773 { 796 {
774 "$ref": "BookmarkTreeNode", 797 "$ref": "BookmarkTreeNode",
775 "name": "bookmark" 798 "name": "bookmark"
776 } 799 }
777 ] 800 ]
778 }, 801 },
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
825 } 848 }
826 ] 849 ]
827 }, 850 },
828 { 851 {
829 "name": "onChildrenReordered", 852 "name": "onChildrenReordered",
830 "type": "function", 853 "type": "function",
831 "description": "", 854 "description": "",
832 "parameters": [ 855 "parameters": [
833 {"type": "string", "name": "id"}, 856 {"type": "string", "name": "id"},
834 { 857 {
835 "type": "array", 858 "type": "object",
836 "name": "childIds", 859 "name": "reorderInfo",
837 "items": { "type": "string" } 860 "properties": {
861 "childIds": { "type": "array", "items": { "type": "string" } }
862 }
838 } 863 }
839 ] 864 ]
840 } 865 }
841 ] 866 ]
842 }, 867 },
843 { 868 {
844 "namespace": "toolstrip", 869 "namespace": "toolstrip",
845 "types": [], 870 "types": [],
846 "functions": [ 871 "functions": [
847 { 872 {
848 "name": "expand", 873 "name": "expand",
849 "type": "function", 874 "type": "function",
850 "description": "", 875 "description": "",
851 "parameters": [ 876 "parameters": [
852 {"type": "integer", "name": "height", "minimum": 0}, 877 {
853 {"type": "string", "name": "url", "optional": true}, 878 "type": "object",
879 "name": "expandInfo",
880 "properties": {
881 "height": { "type": "integer", "minimum": 0, "description": "The v ertical pixel height required of the toolstrip area." },
882 "url": { "type": "string", "optional": true, "description": "If pr esent, the toolstrip mole will change it's content to the provided url. Otherwis e, the current page will just be expanded in size." }
883 }
884 },
854 {"type": "function", "name": "callback", "optional": true, "parameters ": []} 885 {"type": "function", "name": "callback", "optional": true, "parameters ": []}
855 ] 886 ]
856 }, 887 },
857 { 888 {
858 "name": "collapse", 889 "name": "collapse",
859 "type": "function", 890 "type": "function",
860 "description": "", 891 "description": "",
861 "parameters": [ 892 "parameters": [
862 {"type": "string", "name": "url", "optional": true}, 893 {
894 "type": "object",
895 "name": "collapseInfo",
896 "optional": true,
897 "properties": {
898 "url": { "type": "string", "optional": true, "description": "If pr esent, the toolstrip mole will change it's content to the provided url. Otherwis e, the current page will just be collapsed in size." }
899 }
900 },
863 {"type": "function", "name": "callback", "optional": true, "parameters ": []} 901 {"type": "function", "name": "callback", "optional": true, "parameters ": []}
864 ] 902 ]
865 } 903 }
866 ], 904 ],
867 "events": [] 905 "events": []
868 }, 906 },
869 { 907 {
870 "namespace": "devtools", 908 "namespace": "devtools",
871 "types": [ 909 "types": [
872 ], 910 ],
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
904 { 942 {
905 "name": "pass", 943 "name": "pass",
906 "type": "function", 944 "type": "function",
907 "description": "Notify the browser process that test code running in the extension passed. This is only used for internal unit testing.", 945 "description": "Notify the browser process that test code running in the extension passed. This is only used for internal unit testing.",
908 "parameters": [] 946 "parameters": []
909 } 947 }
910 ], 948 ],
911 "events": [] 949 "events": []
912 } 950 }
913 ] 951 ]
OLDNEW
« no previous file with comments | « chrome/common/common_resources.grd ('k') | chrome/common/extensions/docs/api_other.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698