| OLD | NEW |
|---|
| (Empty) | |
| 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 |
| 3 // found in the LICENSE file. |
| 4 |
| 5 [ |
| 6 { |
| 7 "namespace": "tabs", |
| 8 "dependencies": [ "extension", "windows" ], |
| 9 "types": [ |
| 10 { |
| 11 "id": "Tab", |
| 12 "type": "object", |
| 13 "properties": { |
| 14 "id": {"type": "integer", "minimum": 0, "description": "The ID of the
tab. Tab IDs are unique within a browser session."}, |
| 15 "index": {"type": "integer", "minimum": 0, "description": "The zero-ba
sed index of the tab within its window."}, |
| 16 "windowId": {"type": "integer", "minimum": 0, "description": "The ID o
f the window the tab is contained within."}, |
| 17 "openerTabId": {"type": "integer", "minimum": 0, "optional": true, "de
scription": "The ID of the tab that opened this tab, if any. This will only be p
resent if the opener tab still exists."}, |
| 18 "selected": {"type": "boolean", "description": "Whether the tab is sel
ected.", "nodoc": true}, |
| 19 "highlighted": {"type": "boolean", "description": "Whether the tab is
highlighted."}, |
| 20 "active": {"type": "boolean", "description": "Whether the tab is activ
e in its window."}, |
| 21 "pinned": {"type": "boolean", "description": "Whether the tab is pinne
d."}, |
| 22 "url": {"type": "string", "optional": true, "description": "The URL th
e tab is displaying. This will only be present if the extension has the 'tabs' o
r 'webNavigation' permission."}, |
| 23 "title": {"type": "string", "optional": true, "optional": true, "descr
iption": "The title of the tab. This will only be present if the extension has t
he 'tabs' or 'webNavigation' permission. It may also be an empty string if the t
ab is loading."}, |
| 24 "favIconUrl": {"type": "string", "optional": true, "optional": true, "
description": "The URL of the tab's favicon. This will only be present if the ex
tension has the 'tabs' or 'webNavigation' permission. It may also be an empty st
ring if the tab is loading."}, |
| 25 "status": {"type": "string", "optional": true, "description": "Either
<em>loading</em> or <em>complete</em>."}, |
| 26 "incognito": {"type": "boolean", "description": "Whether the tab is in
an incognito window."} |
| 27 } |
| 28 }, |
| 29 { |
| 30 "id": "InjectDetails", |
| 31 "type": "object", |
| 32 "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.", |
| 33 "properties": { |
| 34 "code": {"type": "string", "optional": true, "description": "JavaScrip
t or CSS code to inject."}, |
| 35 "file": {"type": "string", "optional": true, "description": "JavaScrip
t or CSS file to inject."}, |
| 36 "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 w
ill only be injected into the top frame."}, |
| 37 "runAt": { |
| 38 "type": "string", |
| 39 "optional": true, |
| 40 "enum": ["document_start", "document_end", "document_idle"], |
| 41 "description": "The soonest that the JavaScript or CSS will be injec
ted into the tab. Defaults to \"document_idle\"." |
| 42 } |
| 43 } |
| 44 } |
| 45 ], |
| 46 "functions": [ |
| 47 { |
| 48 "name": "get", |
| 49 "type": "function", |
| 50 "description": "Retrieves details about the specified tab.", |
| 51 "parameters": [ |
| 52 { |
| 53 "type": "integer", |
| 54 "name": "tabId", |
| 55 "minimum": 0 |
| 56 }, |
| 57 { |
| 58 "type": "function", |
| 59 "name": "callback", |
| 60 "parameters": [ |
| 61 {"name": "tab", "$ref": "Tab"} |
| 62 ] |
| 63 } |
| 64 ] |
| 65 }, |
| 66 { |
| 67 "name": "getCurrent", |
| 68 "type": "function", |
| 69 "description": "Gets the tab that this script call is being made from. M
ay be undefined if called from a non-tab context (for example: a background page
or popup view).", |
| 70 "parameters": [ |
| 71 { |
| 72 "type": "function", |
| 73 "name": "callback", |
| 74 "parameters": [ |
| 75 { |
| 76 "name": "tab", |
| 77 "$ref": "Tab", |
| 78 "optional": true |
| 79 } |
| 80 ] |
| 81 } |
| 82 ] |
| 83 }, |
| 84 { |
| 85 "name": "connect", |
| 86 "nocompile": true, |
| 87 "type": "function", |
| 88 "description": "Connects to the content script(s) in the specified tab.
The $ref:runtime.onConnect event 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'>Content Script Messaging</a>.", |
| 89 "parameters": [ |
| 90 { |
| 91 "type": "integer", |
| 92 "name": "tabId", |
| 93 "minimum": 0 |
| 94 }, |
| 95 { |
| 96 "type": "object", |
| 97 "name": "connectInfo", |
| 98 "properties": { |
| 99 "name": { "type": "string", "optional": true, "description": "Will
be passed into onConnect for content scripts that are listening for the connect
ion event." } |
| 100 }, |
| 101 "optional": true |
| 102 } |
| 103 ], |
| 104 "returns": { |
| 105 "$ref": "runtime.Port", |
| 106 "description": "A port that can be used to communicate with the conten
t scripts running in the specified tab. The port's $ref:runtime.Port event is fi
red if the tab closes or does not exist. " |
| 107 } |
| 108 }, |
| 109 { |
| 110 "name": "sendRequest", |
| 111 "nodoc": true, |
| 112 "nocompile": true, |
| 113 "type": "function", |
| 114 "description": "Deprecated: Please use sendMessage.", |
| 115 "parameters": [ |
| 116 { |
| 117 "type": "integer", |
| 118 "name": "tabId", |
| 119 "minimum": 0 |
| 120 }, |
| 121 { |
| 122 "type": "any", |
| 123 "name": "request" |
| 124 }, |
| 125 { |
| 126 "type": "function", |
| 127 "name": "responseCallback", |
| 128 "optional": true, |
| 129 "parameters": [ |
| 130 { |
| 131 "name": "response", |
| 132 "type": "any", |
| 133 "description": "The JSON response object sent by the handler of
the request. If an error occurs while connecting to the specified tab, the callb
ack will be called with no arguments and $ref:runtime.lastError will be set to t
he error message." |
| 134 } |
| 135 ] |
| 136 } |
| 137 ] |
| 138 }, |
| 139 { |
| 140 "name": "sendMessage", |
| 141 "nocompile": true, |
| 142 "type": "function", |
| 143 "description": "Sends a single message to the content script(s) in the s
pecified tab, with an optional callback to run when a response is sent back. Th
e $ref:runtime.onMessage event is fired in each content script running in the sp
ecified tab for the current extension.", |
| 144 "parameters": [ |
| 145 { |
| 146 "type": "integer", |
| 147 "name": "tabId", |
| 148 "minimum": 0 |
| 149 }, |
| 150 { |
| 151 "type": "any", |
| 152 "name": "message" |
| 153 }, |
| 154 { |
| 155 "type": "function", |
| 156 "name": "responseCallback", |
| 157 "optional": true, |
| 158 "parameters": [ |
| 159 { |
| 160 "name": "response", |
| 161 "type": "any", |
| 162 "description": "The JSON response object sent by the handler of
the message. If an error occurs while connecting to the specified tab, the callb
ack will be called with no arguments and $ref:runtime.lastError will be set to t
he error message." |
| 163 } |
| 164 ] |
| 165 } |
| 166 ] |
| 167 }, |
| 168 { |
| 169 "name": "getSelected", |
| 170 "nodoc": true, |
| 171 "type": "function", |
| 172 "description": "Deprecated. Please use query({'active': true}). Gets the
tab that is selected in the specified window.", |
| 173 "parameters": [ |
| 174 { |
| 175 "type": "integer", |
| 176 "name": "windowId", |
| 177 "minimum": -2, |
| 178 "optional": true, |
| 179 "description": "Defaults to the <a href='windows.html#current-window
'>current window</a>." |
| 180 }, |
| 181 { |
| 182 "type": "function", |
| 183 "name": "callback", |
| 184 "parameters": [ |
| 185 {"name": "tab", "$ref": "Tab"} |
| 186 ] |
| 187 } |
| 188 ] |
| 189 }, |
| 190 { |
| 191 "name": "getAllInWindow", |
| 192 "type": "function", |
| 193 "nodoc": true, |
| 194 "description": "Deprecated. Please use query({'windowId': windowId}). Ge
ts details about all tabs in the specified window.", |
| 195 "parameters": [ |
| 196 { |
| 197 "type": "integer", |
| 198 "name": "windowId", |
| 199 "minimum": -2, |
| 200 "optional": true, |
| 201 "description": "Defaults to the <a href='windows.html#current-window
'>current window</a>." |
| 202 }, |
| 203 { |
| 204 "type": "function", |
| 205 "name": "callback", |
| 206 "parameters": [ |
| 207 {"name": "tabs", "type": "array", "items": { "$ref": "Tab" } } |
| 208 ] |
| 209 } |
| 210 ] |
| 211 }, |
| 212 { |
| 213 "name": "create", |
| 214 "type": "function", |
| 215 "description": "Creates a new tab. Note: This function can be used witho
ut requesting the 'tabs' permission in the manifest.", |
| 216 "parameters": [ |
| 217 { |
| 218 "type": "object", |
| 219 "name": "createProperties", |
| 220 "properties": { |
| 221 "windowId": { |
| 222 "type": "integer", |
| 223 "minimum": -2, |
| 224 "optional": true, |
| 225 "description": "The window to create the new tab in. Defaults to
the <a href='windows.html#current-window'>current window</a>." |
| 226 }, |
| 227 "index": { |
| 228 "type": "integer", |
| 229 "minimum": 0, |
| 230 "optional": true, |
| 231 "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." |
| 232 }, |
| 233 "url": { |
| 234 "type": "string", |
| 235 "optional": true, |
| 236 "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." |
| 237 }, |
| 238 "active": { |
| 239 "type": "boolean", |
| 240 "optional": true, |
| 241 "description": "Whether the tab should become the active tab in
the window. Defaults to <var>true</var>" |
| 242 }, |
| 243 "selected": { |
| 244 "nodoc": true, |
| 245 "type": "boolean", |
| 246 "optional": true, |
| 247 "description": "Whether the tab should become the selected tab i
n the window. Defaults to <var>true</var>" |
| 248 }, |
| 249 "pinned": { |
| 250 "type": "boolean", |
| 251 "optional": true, |
| 252 "description": "Whether the tab should be pinned. Defaults to <v
ar>false</var>" |
| 253 }, |
| 254 "openerTabId": { |
| 255 "type": "integer", |
| 256 "minimum": 0, |
| 257 "optional": true, |
| 258 "description": "The ID of the tab that opened this tab. If speci
fied, the opener tab must be in the same window as the newly created tab." |
| 259 } |
| 260 } |
| 261 }, |
| 262 { |
| 263 "type": "function", |
| 264 "name": "callback", |
| 265 "optional": true, |
| 266 "parameters": [ |
| 267 { |
| 268 "name": "tab", |
| 269 "$ref": "Tab", |
| 270 "description": "Details about the created tab. Will contain the
ID of the new tab." |
| 271 } |
| 272 ] |
| 273 } |
| 274 ] |
| 275 }, |
| 276 { |
| 277 "name": "duplicate", |
| 278 "type": "function", |
| 279 "description": "Duplicates a tab. Note: This function can be used withou
t requesting the 'tabs' permission in the manifest.", |
| 280 "parameters": [ |
| 281 { |
| 282 "type": "integer", |
| 283 "name": "tabId", |
| 284 "minimum": 0, |
| 285 "description": "The ID of the tab which is to be duplicated." |
| 286 }, |
| 287 { |
| 288 "type": "function", |
| 289 "name": "callback", |
| 290 "optional": true, |
| 291 "parameters": [ |
| 292 { |
| 293 "name": "tab", |
| 294 "optional": true, |
| 295 "description": "Details about the duplicated tab. The Tab object
doesn't contain url, title and faviconUrl if the 'tabs' permission has not been
requested.", |
| 296 "$ref": "Tab" |
| 297 } |
| 298 ] |
| 299 } |
| 300 ] |
| 301 }, |
| 302 { |
| 303 "name": "query", |
| 304 "type": "function", |
| 305 "description": "Gets all tabs that have the specified properties, or all
tabs if no properties are specified.", |
| 306 "parameters": [ |
| 307 { |
| 308 "type": "object", |
| 309 "name": "queryInfo", |
| 310 "properties": { |
| 311 "active": { |
| 312 "type": "boolean", |
| 313 "optional": true, |
| 314 "description": "Whether the tabs are active in their windows." |
| 315 }, |
| 316 "pinned": { |
| 317 "type": "boolean", |
| 318 "optional": true, |
| 319 "description": "Whether the tabs are pinned." |
| 320 }, |
| 321 "highlighted": { |
| 322 "type": "boolean", |
| 323 "optional": true, |
| 324 "description": "Whether the tabs are highlighted." |
| 325 }, |
| 326 "currentWindow": { |
| 327 "type": "boolean", |
| 328 "optional": true, |
| 329 "description": "Whether the tabs are in the <a href='windows.htm
l#current-window'>current window</a>." |
| 330 }, |
| 331 "lastFocusedWindow": { |
| 332 "type": "boolean", |
| 333 "optional": true, |
| 334 "description": "Whether the tabs are in the last focused window.
" |
| 335 }, |
| 336 "status": { |
| 337 "type": "string", |
| 338 "optional": true, |
| 339 "enum": ["loading", "complete"], |
| 340 "description": "Whether the tabs have completed loading." |
| 341 }, |
| 342 "title": { |
| 343 "type": "string", |
| 344 "optional": true, |
| 345 "description": "Match page titles against a pattern." |
| 346 }, |
| 347 "url": { |
| 348 "type": "string", |
| 349 "optional": true, |
| 350 "description": "Match tabs against a URL pattern." |
| 351 }, |
| 352 "windowId": { |
| 353 "type": "integer", |
| 354 "optional": true, |
| 355 "minimum": -2, |
| 356 "description": "The ID of the parent window, or $ref:windows.WIN
DOW_ID_CURRENT for the <a href='windows.html#current-window'>current window</a>.
" |
| 357 }, |
| 358 "windowType": { |
| 359 "type": "string", |
| 360 "optional": true, |
| 361 "enum": ["normal", "popup", "panel", "app"], |
| 362 "description": "The type of window the tabs are in." |
| 363 }, |
| 364 "index": { |
| 365 "type": "integer", |
| 366 "optional": true, |
| 367 "minimum": 0, |
| 368 "description": "The position of the tabs within their windows." |
| 369 } |
| 370 } |
| 371 }, |
| 372 { |
| 373 "type": "function", |
| 374 "name": "callback", |
| 375 "parameters": [ |
| 376 { |
| 377 "name": "result", |
| 378 "type": "array", |
| 379 "items": { |
| 380 "$ref": "Tab" |
| 381 } |
| 382 } |
| 383 ] |
| 384 } |
| 385 ] |
| 386 }, |
| 387 { |
| 388 "name": "highlight", |
| 389 "type": "function", |
| 390 "description": "Highlights the given tabs.", |
| 391 "parameters": [ |
| 392 { |
| 393 "type": "object", |
| 394 "name": "highlightInfo", |
| 395 "properties": { |
| 396 "windowId": { |
| 397 "type": "integer", |
| 398 "optional": true, |
| 399 "description": "The window that contains the tabs.", |
| 400 "minimum": -2 |
| 401 }, |
| 402 "tabs": { |
| 403 "description": "One or more tab indices to highlight.", |
| 404 "choices": [ |
| 405 {"type": "array", "items": {"type": "integer", "minimum": 0}}
, |
| 406 {"type": "integer"} |
| 407 ] |
| 408 } |
| 409 } |
| 410 }, |
| 411 { |
| 412 "type": "function", |
| 413 "name": "callback", |
| 414 "parameters": [ |
| 415 { |
| 416 "name": "window", |
| 417 "$ref": "windows.Window", |
| 418 "description": "Contains details about the window whose tabs we
re highlighted." |
| 419 } |
| 420 ] |
| 421 } |
| 422 ] |
| 423 }, |
| 424 { |
| 425 "name": "update", |
| 426 "type": "function", |
| 427 "description": "Modifies the properties of a tab. Properties that are no
t specified in <var>updateProperties</var> are not modified. Note: This function
can be used without requesting the 'tabs' permission in the manifest.", |
| 428 "parameters": [ |
| 429 { |
| 430 "type": "integer", |
| 431 "name": "tabId", |
| 432 "minimum": 0, |
| 433 "optional": true, |
| 434 "description": "Defaults to the selected tab of the <a href='windows
.html#current-window'>current window</a>." |
| 435 }, |
| 436 { |
| 437 "type": "object", |
| 438 "name": "updateProperties", |
| 439 "properties": { |
| 440 "url": { |
| 441 "type": "string", |
| 442 "optional": true, |
| 443 "description": "A URL to navigate the tab to." |
| 444 }, |
| 445 "active": { |
| 446 "type": "boolean", |
| 447 "optional": true, |
| 448 "description": "Whether the tab should be active." |
| 449 }, |
| 450 "highlighted": { |
| 451 "type": "boolean", |
| 452 "optional": true, |
| 453 "description": "Adds or removes the tab from the current selecti
on." |
| 454 }, |
| 455 "selected": { |
| 456 "nodoc": true, |
| 457 "type": "boolean", |
| 458 "optional": true, |
| 459 "description": "Whether the tab should be selected." |
| 460 }, |
| 461 "pinned": { |
| 462 "type": "boolean", |
| 463 "optional": true, |
| 464 "description": "Whether the tab should be pinned." |
| 465 }, |
| 466 "openerTabId": { |
| 467 "type": "integer", |
| 468 "minimum": 0, |
| 469 "optional": true, |
| 470 "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." |
| 471 } |
| 472 } |
| 473 }, |
| 474 { |
| 475 "type": "function", |
| 476 "name": "callback", |
| 477 "optional": true, |
| 478 "parameters": [ |
| 479 { |
| 480 "name": "tab", |
| 481 "$ref": "Tab", |
| 482 "optional": true, |
| 483 "description": "Details about the updated tab, or <code>null</co
de> if the 'tabs' permission has not been requested." |
| 484 } |
| 485 ] |
| 486 } |
| 487 ] |
| 488 }, |
| 489 { |
| 490 "name": "move", |
| 491 "type": "function", |
| 492 "description": "Moves one or more tabs to a new position within its wind
ow, or to a new window. Note that tabs can only be moved to and from normal (win
dow.type === \"normal\") windows.", |
| 493 "parameters": [ |
| 494 { |
| 495 "name": "tabIds", |
| 496 "description": "The tab or list of tabs to move.", |
| 497 "choices": [ |
| 498 {"type": "integer", "minimum": 0}, |
| 499 {"type": "array", "items": {"type": "integer", "minimum": 0}} |
| 500 ] |
| 501 }, |
| 502 { |
| 503 "type": "object", |
| 504 "name": "moveProperties", |
| 505 "properties": { |
| 506 "windowId": { |
| 507 "type": "integer", |
| 508 "minimum": -2, |
| 509 "optional": true, |
| 510 "description": "Defaults to the window the tab is currently in." |
| 511 }, |
| 512 "index": { |
| 513 "type": "integer", |
| 514 "minimum": -1, |
| 515 "description": "The position to move the window to. -1 will plac
e the tab at the end of the window." |
| 516 } |
| 517 } |
| 518 }, |
| 519 { |
| 520 "type": "function", |
| 521 "name": "callback", |
| 522 "optional": true, |
| 523 "parameters": [ |
| 524 { |
| 525 "name": "tabs", |
| 526 "description": "Details about the moved tabs.", |
| 527 "choices": [ |
| 528 {"$ref": "Tab"}, |
| 529 {"type": "array", "items": {"$ref": "Tab"}} |
| 530 ] |
| 531 } |
| 532 ] |
| 533 } |
| 534 ] |
| 535 }, |
| 536 { |
| 537 "name": "reload", |
| 538 "type": "function", |
| 539 "description": "Reload a tab.", |
| 540 "parameters": [ |
| 541 {"type": "integer", "name": "tabId", "optional": true, "description":
"The ID of the tab to reload; defaults to the selected tab of the current window
."}, |
| 542 { |
| 543 "type": "object", |
| 544 "name": "reloadProperties", |
| 545 "optional": true, |
| 546 "properties": { |
| 547 "bypassCache": { |
| 548 "type": "boolean", |
| 549 "optional": true, |
| 550 "description": "Whether using any local cache. Default is false.
" |
| 551 } |
| 552 } |
| 553 }, |
| 554 {"type": "function", "name": "callback", "optional": true, "parameters
": []} |
| 555 ] |
| 556 }, |
| 557 { |
| 558 "name": "remove", |
| 559 "type": "function", |
| 560 "description": "Closes one or more tabs. Note: This function can be used
without requesting the 'tabs' permission in the manifest.", |
| 561 "parameters": [ |
| 562 { |
| 563 "name": "tabIds", |
| 564 "description": "The tab or list of tabs to close.", |
| 565 "choices": [ |
| 566 {"type": "integer", "minimum": 0}, |
| 567 {"type": "array", "items": {"type": "integer", "minimum": 0}} |
| 568 ] |
| 569 }, |
| 570 {"type": "function", "name": "callback", "optional": true, "parameters
": []} |
| 571 ] |
| 572 }, |
| 573 { |
| 574 "name": "detectLanguage", |
| 575 "type": "function", |
| 576 "description": "Detects the primary language of the content in a tab.", |
| 577 "parameters": [ |
| 578 { |
| 579 "type": "integer", |
| 580 "name": "tabId", |
| 581 "minimum": 0, |
| 582 "optional": true, |
| 583 "description": "Defaults to the active tab of the <a href='windows.h
tml#current-window'>current window</a>." |
| 584 }, |
| 585 { |
| 586 "type": "function", |
| 587 "name": "callback", |
| 588 "parameters": [ |
| 589 { |
| 590 "type": "string", |
| 591 "name": "language", |
| 592 "description": "An ISO language code such as <code>en</code> or
<code>fr</code>. For a complete list of languages supported by this method, see
<a href='http://src.chromium.org/viewvc/chrome/trunk/src/third_party/cld/languag
es/internal/languages.cc'>kLanguageInfoTable</a>. The 2nd to 4th columns will be
checked and the first non-NULL value will be returned except for Simplified Chi
nese for which zh-CN will be returned. For an unknown language, <code>und</code>
will be returned." |
| 593 } |
| 594 ] |
| 595 } |
| 596 ] |
| 597 }, |
| 598 { |
| 599 "name": "captureVisibleTab", |
| 600 "type": "function", |
| 601 "description": "Captures the visible area of the currently active tab in
the specified window. You must have <a href='manifest.html#permissions'>host pe
rmission</a> for the URL displayed by the tab.", |
| 602 "parameters": [ |
| 603 { |
| 604 "type": "integer", |
| 605 "name": "windowId", |
| 606 "minimum": -2, |
| 607 "optional": true, |
| 608 "description": "The target window. Defaults to the <a href='windows.
html#current-window'>current window</a>." |
| 609 }, |
| 610 { |
| 611 "type": "object", |
| 612 "name": "options", |
| 613 "optional": true, |
| 614 "description": "Set parameters of image capture, such as the format
of the resulting image.", |
| 615 "properties": { |
| 616 "format": { |
| 617 "type": "string", |
| 618 "optional": true, |
| 619 "enum": ["jpeg", "png"], |
| 620 "description": "The format of the resulting image. Default is j
peg." |
| 621 }, |
| 622 "quality": { |
| 623 "type": "integer", |
| 624 "optional": true, |
| 625 "minimum": 0, |
| 626 "maximum": 100, |
| 627 "description": "When format is 'jpeg', controls the quality of t
he resulting image. This value is ignored for PNG images. As quality is decrea
sed, the resulting image will have more visual artifacts, and the number of byte
s needed to store it will decrease." |
| 628 } |
| 629 } |
| 630 }, |
| 631 { |
| 632 "type": "function", "name": "callback", "parameters": [ |
| 633 {"type": "string", "name": "dataUrl", "description": "A data URL w
hich encodes an image of the visible area of the captured tab. May be assigned t
o the 'src' property of an HTML Image element for display."} |
| 634 ] |
| 635 } |
| 636 ] |
| 637 }, |
| 638 { |
| 639 "name": "executeScript", |
| 640 "type": "function", |
| 641 "description": "Injects JavaScript code into a page. For details, see th
e <a href='content_scripts.html#pi'>programmatic injection</a> section of the co
ntent scripts doc.", |
| 642 "parameters": [ |
| 643 {"type": "integer", "name": "tabId", "optional": true, "description":
"The ID of the tab in which to run the script; defaults to the active tab of the
current window."}, |
| 644 { |
| 645 "$ref": "tabs.InjectDetails", |
| 646 "name": "details", |
| 647 "description": "Details of the script to run." |
| 648 }, |
| 649 { |
| 650 "type": "function", |
| 651 "name": "callback", |
| 652 "optional": true, |
| 653 "description": "Called after all the JavaScript has been executed.", |
| 654 "parameters": [ |
| 655 { |
| 656 "name": "result", |
| 657 "optional": true, |
| 658 "type": "array", |
| 659 "items": {"type": "any", "minimum": 0}, |
| 660 "description": "The result of the script in every injected frame
." |
| 661 } |
| 662 ] |
| 663 } |
| 664 ] |
| 665 }, |
| 666 { |
| 667 "name": "insertCSS", |
| 668 "type": "function", |
| 669 "description": "Injects CSS into a page. For details, see the <a href='c
ontent_scripts.html#pi'>programmatic injection</a> section of the content script
s doc.", |
| 670 "parameters": [ |
| 671 {"type": "integer", "name": "tabId", "optional": true, "description":
"The ID of the tab in which to insert the CSS; defaults to the active tab of the
current window."}, |
| 672 { |
| 673 "$ref": "tabs.InjectDetails", |
| 674 "name": "details", |
| 675 "description": "Details of the CSS text to insert." |
| 676 }, |
| 677 { |
| 678 "type": "function", |
| 679 "name": "callback", |
| 680 "optional": true, |
| 681 "description": "Called when all the CSS has been inserted.", |
| 682 "parameters": [] |
| 683 } |
| 684 ] |
| 685 } |
| 686 ], |
| 687 "events": [ |
| 688 { |
| 689 "name": "onCreated", |
| 690 "type": "function", |
| 691 "description": "Fired when a tab is created. Note that the tab's URL may
not be set at the time this event fired, but you can listen to onUpdated events
to be notified when a URL is set.", |
| 692 "parameters": [ |
| 693 { |
| 694 "$ref": "Tab", |
| 695 "name": "tab", |
| 696 "description": "Details of the tab that was created." |
| 697 } |
| 698 ] |
| 699 }, |
| 700 { |
| 701 "name": "onUpdated", |
| 702 "type": "function", |
| 703 "description": "Fired when a tab is updated.", |
| 704 "parameters": [ |
| 705 {"type": "integer", "name": "tabId", "minimum": 0}, |
| 706 { |
| 707 "type": "object", |
| 708 "name": "changeInfo", |
| 709 "description": "Lists the changes to the state of the tab that was u
pdated.", |
| 710 "properties": { |
| 711 "status": { |
| 712 "type": "string", |
| 713 "optional": true, |
| 714 "description": "The status of the tab. Can be either <em>loading
</em> or <em>complete</em>." |
| 715 }, |
| 716 "url": { |
| 717 "type": "string", |
| 718 "optional": true, |
| 719 "description": "The tab's URL if it has changed." |
| 720 }, |
| 721 "pinned": { |
| 722 "type": "boolean", |
| 723 "optional": true, |
| 724 "description": "The tab's new pinned state." |
| 725 } |
| 726 } |
| 727 }, |
| 728 { |
| 729 "$ref": "Tab", |
| 730 "name": "tab", |
| 731 "description": "Gives the state of the tab that was updated." |
| 732 } |
| 733 ] |
| 734 }, |
| 735 { |
| 736 "name": "onMoved", |
| 737 "type": "function", |
| 738 "description": "Fired when a tab is moved within a window. Only one move
event is fired, representing the tab the user directly moved. Move events are n
ot fired for the other tabs that must move in response. This event is not fired
when a tab is moved between windows. For that, see $ref:onDetached.", |
| 739 "parameters": [ |
| 740 {"type": "integer", "name": "tabId", "minimum": 0}, |
| 741 { |
| 742 "type": "object", |
| 743 "name": "moveInfo", |
| 744 "properties": { |
| 745 "windowId": {"type": "integer", "minimum": 0}, |
| 746 "fromIndex": {"type": "integer", "minimum": 0}, |
| 747 "toIndex": {"type": "integer", "minimum": 0} |
| 748 } |
| 749 } |
| 750 ] |
| 751 }, |
| 752 { |
| 753 "name": "onSelectionChanged", |
| 754 "nodoc": true, |
| 755 "type": "function", |
| 756 "description": "Deprecated. Please use onActivated.", |
| 757 "parameters": [ |
| 758 { |
| 759 "type": "integer", |
| 760 "name": "tabId", |
| 761 "minimum": 0, |
| 762 "description": "The ID of the tab that has become active." |
| 763 }, |
| 764 { |
| 765 "type": "object", |
| 766 "name": "selectInfo", |
| 767 "properties": { |
| 768 "windowId": { |
| 769 "type": "integer", |
| 770 "minimum": 0, |
| 771 "description": "The ID of the window the selected tab changed in
side of." |
| 772 } |
| 773 } |
| 774 } |
| 775 ] |
| 776 }, |
| 777 { |
| 778 "name": "onActiveChanged", |
| 779 "nodoc": true, |
| 780 "type": "function", |
| 781 "description": "Deprecated. Please use onActivated.", |
| 782 "parameters": [ |
| 783 { |
| 784 "type": "integer", |
| 785 "name": "tabId", |
| 786 "minimum": 0, |
| 787 "description": "The ID of the tab that has become active." |
| 788 }, |
| 789 { |
| 790 "type": "object", |
| 791 "name": "selectInfo", |
| 792 "properties": { |
| 793 "windowId": { |
| 794 "type": "integer", |
| 795 "minimum": 0, |
| 796 "description": "The ID of the window the selected tab changed in
side of." |
| 797 } |
| 798 } |
| 799 } |
| 800 ] |
| 801 }, |
| 802 { |
| 803 "name": "onActivated", |
| 804 "type": "function", |
| 805 "description": "Fires when the active tab in a window changes. Note that
the tab's URL may not be set at the time this event fired, but you can listen t
o onUpdated events to be notified when a URL is set.", |
| 806 "parameters": [ |
| 807 { |
| 808 "type": "object", |
| 809 "name": "activeInfo", |
| 810 "properties": { |
| 811 "tabId": { |
| 812 "type": "integer", |
| 813 "minimum": 0, |
| 814 "description": "The ID of the tab that has become active." |
| 815 }, |
| 816 "windowId": { |
| 817 "type": "integer", |
| 818 "minimum": 0, |
| 819 "description": "The ID of the window the active tab changed insi
de of." |
| 820 } |
| 821 } |
| 822 } |
| 823 ] |
| 824 }, |
| 825 { |
| 826 "name": "onHighlightChanged", |
| 827 "type": "function", |
| 828 "nodoc": true, |
| 829 "description": "Deprecated. Please use onHighlighted.", |
| 830 "parameters": [ |
| 831 { |
| 832 "type": "object", |
| 833 "name": "selectInfo", |
| 834 "properties": { |
| 835 "windowId": { |
| 836 "type": "integer", |
| 837 "minimum": 0, |
| 838 "description": "The window whose tabs changed." |
| 839 }, |
| 840 "tabIds": { |
| 841 "type": "array", |
| 842 "name": "tabIds", |
| 843 "items": {"type": "integer", "minimum": 0}, |
| 844 "description": "All highlighted tabs in the window." |
| 845 } |
| 846 } |
| 847 } |
| 848 ] |
| 849 }, |
| 850 { |
| 851 "name": "onHighlighted", |
| 852 "type": "function", |
| 853 "description": "Fired when the highlighted or selected tabs in a window
changes.", |
| 854 "parameters": [ |
| 855 { |
| 856 "type": "object", |
| 857 "name": "highlightInfo", |
| 858 "properties": { |
| 859 "windowId": { |
| 860 "type": "integer", |
| 861 "minimum": 0, |
| 862 "description": "The window whose tabs changed." |
| 863 }, |
| 864 "tabIds": { |
| 865 "type": "array", |
| 866 "name": "tabIds", |
| 867 "items": {"type": "integer", "minimum": 0}, |
| 868 "description": "All highlighted tabs in the window." |
| 869 } |
| 870 } |
| 871 } |
| 872 ] |
| 873 }, |
| 874 { |
| 875 "name": "onDetached", |
| 876 "type": "function", |
| 877 "description": "Fired when a tab is detached from a window, for example
because it is being moved between windows.", |
| 878 "parameters": [ |
| 879 {"type": "integer", "name": "tabId", "minimum": 0}, |
| 880 { |
| 881 "type": "object", |
| 882 "name": "detachInfo", |
| 883 "properties": { |
| 884 "oldWindowId": {"type": "integer", "minimum": 0}, |
| 885 "oldPosition": {"type": "integer", "minimum": 0} |
| 886 } |
| 887 } |
| 888 ] |
| 889 }, |
| 890 { |
| 891 "name": "onAttached", |
| 892 "type": "function", |
| 893 "description": "Fired when a tab is attached to a window, for example be
cause it was moved between windows.", |
| 894 "parameters": [ |
| 895 {"type": "integer", "name": "tabId", "minimum": 0}, |
| 896 { |
| 897 "type": "object", |
| 898 "name": "attachInfo", |
| 899 "properties": { |
| 900 "newWindowId": {"type": "integer", "minimum": 0}, |
| 901 "newPosition": {"type": "integer", "minimum": 0} |
| 902 } |
| 903 } |
| 904 ] |
| 905 }, |
| 906 { |
| 907 "name": "onRemoved", |
| 908 "type": "function", |
| 909 "description": "Fired when a tab is closed. Note: A listener can be regi
stered for this event without requesting the 'tabs' permission in the manifest."
, |
| 910 "parameters": [ |
| 911 {"type": "integer", "name": "tabId", "minimum": 0}, |
| 912 { |
| 913 "type": "object", |
| 914 "name": "removeInfo", |
| 915 "properties": { |
| 916 "windowId": {"type": "integer", "minimum": 0, "description": "the
window whose tab is closed." }, |
| 917 "isWindowClosing": {"type": "boolean", "description": "True when t
he tab is being closed because its window is being closed." } |
| 918 } |
| 919 } |
| 920 ] |
| 921 }, |
| 922 { |
| 923 "name": "onReplaced", |
| 924 "type": "function", |
| 925 "description": "Fired when a tab is replaced with another tab due to pre
rendering or instant.", |
| 926 "parameters": [ |
| 927 {"type": "integer", "name": "addedTabId", "minimum": 0}, |
| 928 {"type": "integer", "name": "removedTabId", "minimum": 0} |
| 929 ] |
| 930 } |
| 931 ] |
| 932 } |
| 933 ] |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 12261015:
Import chrome idl into third_party (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart