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

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

Issue 179068: Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc (Closed)
Patch Set: touch grd. rendered 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
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 138 matching lines...) Expand 10 before | Expand all | Expand 10 after
149 { 149 {
150 "name": "window", "$ref": "Window" 150 "name": "window", "$ref": "Window"
151 } 151 }
152 ] 152 ]
153 } 153 }
154 ] 154 ]
155 }, 155 },
156 { 156 {
157 "name": "getLastFocused", 157 "name": "getLastFocused",
158 "type": "function", 158 "type": "function",
159 "description": "Get the window that was most recenly focused -- typicall y the window 'on top'.", 159 "description": "Get the window that was most recently focused -- typical ly the window 'on top'.",
160 "parameters": [ 160 "parameters": [
161 { 161 {
162 "type": "function", 162 "type": "function",
163 "name": "callback", 163 "name": "callback",
164 "parameters": [ 164 "parameters": [
165 { 165 {
166 "name": "window", "$ref": "Window" 166 "name": "window", "$ref": "Window"
167 } 167 }
168 ] 168 ]
169 } 169 }
170 ] 170 ]
171 }, 171 },
172 { 172 {
173 "name": "getAll", 173 "name": "getAll",
174 "type": "function", 174 "type": "function",
175 "description": "Get all windows.", 175 "description": "Get all windows.",
176 "parameters": [ 176 "parameters": [
177 { 177 {
178 "type": "object", 178 "type": "object",
179 "name": "getInfo", 179 "name": "getInfo",
180 "optional": true, 180 "optional": true,
181 "description": "", 181 "description": "",
182 "properties": { 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." } 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 <a href='tabs.html#type-Tab'>Tab</a> objects for that window." }
184 } 184 }
185 }, 185 },
186 { 186 {
187 "type": "function", 187 "type": "function",
188 "name": "callback", 188 "name": "callback",
189 "parameters": [ 189 "parameters": [
190 { 190 {
191 "name": "windows", "type": "array", "items": { "$ref": "Window" } 191 "name": "windows", "type": "array", "items": { "$ref": "Window" }
192 } 192 }
193 ] 193 ]
194 } 194 }
195 ] 195 ]
196 }, 196 },
197 { 197 {
198 "name": "create", 198 "name": "create",
199 "type": "function", 199 "type": "function",
200 "description": "Create (open) a new browser with any optional sizing, po sition or default url provided.", 200 "description": "Create (open) a new browser with any optional sizing, po sition or default url provided.",
201 "parameters": [ 201 "parameters": [
202 { 202 {
203 "type": "object", 203 "type": "object",
204 "name": "createData", 204 "name": "createData",
205 "properties": { 205 "properties": {
206 "url": {"type": "string", "optional": true, "description": "The UR L to navigate the first tab to. Defaults to the New Tab Page."}, 206 "url": {"type": "string", "optional": true, "description": "The UR L to navigate the first tab to. 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."},
207 "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." }, 207 "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." },
208 "top": {"type": "integer", "optional": true, "description": "The n umber of pixels to position the new window from the top edge of the screen. If n ot specified, the new window is offset naturally from the last focusd window."}, 208 "top": {"type": "integer", "optional": true, "description": "The n umber of pixels to position the new window from the top edge of the screen. If n ot specified, the new window is offset naturally from the last focusd window."},
209 "width": {"type": "integer", "minimum": 0, "optional": true, "desc ription": "The width in pixels of the new window. If not specified defaults to a natural width."}, 209 "width": {"type": "integer", "minimum": 0, "optional": true, "desc ription": "The width in pixels of the new window. If not specified defaults to a natural width."},
210 "height": {"type": "integer", "minimum": 0, "optional": true, "des cription": "The height in pixels of the new window. If not specified defaults to a natural height."} 210 "height": {"type": "integer", "minimum": 0, "optional": true, "des cription": "The height in pixels of the new window. If not specified defaults to a natural height."}
211 }, 211 },
212 "optional": true 212 "optional": true
213 }, 213 },
214 { 214 {
215 "type": "function", 215 "type": "function",
216 "name": "callback", 216 "name": "callback",
(...skipping 111 matching lines...) Expand 10 before | Expand all | Expand 10 after
328 "name": "callback", 328 "name": "callback",
329 "parameters": [ 329 "parameters": [
330 {"name": "tab", "$ref": "Tab"} 330 {"name": "tab", "$ref": "Tab"}
331 ] 331 ]
332 } 332 }
333 ] 333 ]
334 }, 334 },
335 { 335 {
336 "name": "connect", 336 "name": "connect",
337 "type": "function", 337 "type": "function",
338 "description": "Connects to the content script(s) in the specified tab. The <a href='extension.html#event-onConnect'>chrome.extensions.onConnect</a> is fired in each content script running in the specified tab for the current extens ion. For more details, see <a href='content_scripts.html#messaging'>Content Scri pt Messaging</a>.", 338 "description": "Connects to the content script(s) in the specified tab. The <a href='extension.html#event-onConnect'>chrome.extensions.onConnect</a> eve nt is fired in each content script running in the specified tab for the current extension. For more details, see <a href='content_scripts.html#messaging'>Conten t Script Messaging</a>.",
339 "parameters": [ 339 "parameters": [
340 { 340 {
341 "type": "integer", 341 "type": "integer",
342 "name": "tabId", 342 "name": "tabId",
343 "minimum": 0 343 "minimum": 0
344 }, 344 },
345 { 345 {
346 "type": "object", 346 "type": "object",
347 "name": "connectInfo", 347 "name": "connectInfo",
348 "properties": { 348 "properties": {
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after
415 }, 415 },
416 "index": { 416 "index": {
417 "type": "integer", 417 "type": "integer",
418 "minimum": 0, 418 "minimum": 0,
419 "optional": true, 419 "optional": true,
420 "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." 420 "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."
421 }, 421 },
422 "url": { 422 "url": {
423 "type": "string", 423 "type": "string",
424 "optional": true, 424 "optional": true,
425 "description": "The URL to navigate the tab to initially. Defaul ts to the New Tab Page." 425 "description": "The URL to navigate the tab to initially. Fully- qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.goo gle.com'). Relative URLs will be relative to the current page within the extensi on. Defaults to the New Tab Page."
426 }, 426 },
427 "selected": { 427 "selected": {
428 "type": "boolean", 428 "type": "boolean",
429 "optional": true, 429 "optional": true,
430 "description": "Whether the tab should become the selected tab i n the window. Defaults to <var>true</var>" 430 "description": "Whether the tab should become the selected tab i n the window. Defaults to <var>true</var>"
431 } 431 }
432 } 432 }
433 }, 433 },
434 { 434 {
435 "type": "function", 435 "type": "function",
(...skipping 82 matching lines...) Expand 10 before | Expand all | Expand 10 after
518 "name": "language", 518 "name": "language",
519 "description": "An ISO language code like <var>en</var> or <var> fr</var>." 519 "description": "An ISO language code like <var>en</var> or <var> fr</var>."
520 } 520 }
521 ] 521 ]
522 } 522 }
523 ] 523 ]
524 }, 524 },
525 { 525 {
526 "name": "captureVisibleTab", 526 "name": "captureVisibleTab",
527 "type": "function", 527 "type": "function",
528 "description": "Captures the visible area of the visible tab in a window .", 528 "description": "Captures the visible area of the currently selected tab in the specified window.",
529 "parameters": [ 529 "parameters": [
530 { 530 {
531 "type": "integer", 531 "type": "integer",
532 "name": "windowId", 532 "name": "windowId",
533 "minimum": 0, 533 "minimum": 0,
534 "optional": true, 534 "optional": true,
535 "description": "The target window. Defaults to the <a href='windows. html#current-window'>current window</a>." 535 "description": "The target window. Defaults to the <a href='windows. html#current-window'>current window</a>."
536 }, 536 },
537 { 537 {
538 "type": "function", "name": "callback", "parameters": [ 538 "type": "function", "name": "callback", "parameters": [
539 {"type": "string", "name": "dataUrl", "description": "a data url e ncoding of the captured tab."} 539 {"type": "string", "name": "dataUrl", "description": "A data URL o f a JPEG encoding of the visible area of the captured tab. May be assigned to th e 'src' property of an HTML Image element for display."}
540 ] 540 ]
541 } 541 }
542 ] 542 ]
543 } 543 }
544 ], 544 ],
545 "events": [ 545 "events": [
546 { 546 {
547 "name": "onCreated", 547 "name": "onCreated",
548 "type": "function", 548 "type": "function",
549 "description": "Fires when a tab is created.", 549 "description": "Fires when a tab is created.",
(...skipping 499 matching lines...) Expand 10 before | Expand all | Expand 10 after
1049 "type": "function", 1049 "type": "function",
1050 "description": "Logs a message during internal unit testing.", 1050 "description": "Logs a message during internal unit testing.",
1051 "parameters": [ 1051 "parameters": [
1052 {"type": "string", "name": "message"} 1052 {"type": "string", "name": "message"}
1053 ] 1053 ]
1054 } 1054 }
1055 ], 1055 ],
1056 "events": [] 1056 "events": []
1057 } 1057 }
1058 ] 1058 ]
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698