Chromium Code Reviews Chromium Code Reviews
Issue 9617010:
Move chrome.downloads out of experimental to dev (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src| OLD | NEW |
|---|---|
| (Empty) | |
| 1 [ | |
| 2 { | |
| 3 "documentation_permissions_required": [ | |
| 4 "downloads" | |
| 5 ], | |
| 6 "events": [ | |
| 7 { | |
| 8 "description": "This event fires with the DownloadItem object when a dow nload begins.", | |
|
mkearney
2012/06/14 15:12:28
This should link to DownloadItem
benjhayden
2012/06/14 16:44:13
Done.
| |
| 9 "name": "onCreated", | |
| 10 "parameters": [ | |
| 11 { | |
| 12 "$ref": "DownloadItem", | |
| 13 "name": "downloadItem" | |
| 14 } | |
| 15 ], | |
| 16 "type": "function" | |
| 17 }, | |
| 18 { | |
| 19 "description": "Fires with the download id when a download is erased fro m history.", | |
|
mkearney
2012/06/14 15:12:28
I would make this downloadId in code brackets.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 20 "name": "onErased", | |
| 21 "parameters": [ | |
| 22 { | |
| 23 "name": "downloadId", | |
| 24 "type": "integer" | |
| 25 } | |
| 26 ], | |
| 27 "type": "function" | |
| 28 }, | |
| 29 { | |
| 30 "description": "When any of a DownloadItem's properties except <code>byt esReceived</code> changes, this event fires with the download id and an object c ontaining the properties that changed.", | |
|
mkearney
2012/06/14 15:12:28
Again, this should be a link to DownloadItem
mkearney
2012/06/14 15:12:28
Again, make this downloadId in code brackets.
benjhayden
2012/06/14 16:44:13
Done.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 31 "name": "onChanged", | |
| 32 "parameters": [ | |
| 33 { | |
| 34 "name": "downloadDelta", | |
| 35 "properties": { | |
| 36 "danger": { | |
| 37 "description": "Describes a change in a DownloadItem's <code>dan ger</code>.", | |
|
mkearney
2012/06/14 15:12:28
General comment to sweep DownloadItem.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 38 "optional": true, | |
| 39 "properties": { | |
| 40 "current": { | |
| 41 "optional": true, | |
| 42 "type": "string" | |
| 43 }, | |
| 44 "previous": { | |
| 45 "optional": true, | |
| 46 "type": "string" | |
| 47 } | |
| 48 }, | |
| 49 "type": "object" | |
| 50 }, | |
| 51 "dangerAccepted": { | |
| 52 "description": "Describes a change in a DownloadItem's <code>dan gerAccepted</code>.", | |
| 53 "optional": true, | |
| 54 "properties": { | |
| 55 "current": { | |
| 56 "optional": true, | |
| 57 "type": "boolean" | |
| 58 }, | |
| 59 "previous": { | |
| 60 "optional": true, | |
| 61 "type": "boolean" | |
| 62 } | |
| 63 }, | |
| 64 "type": "object" | |
| 65 }, | |
| 66 "endTime": { | |
| 67 "description": "Describes a change in a DownloadItem's <code>end Time</code>.", | |
| 68 "optional": true, | |
| 69 "properties": { | |
| 70 "current": { | |
| 71 "optional": true, | |
| 72 "type": "integer" | |
| 73 }, | |
| 74 "previous": { | |
| 75 "optional": true, | |
| 76 "type": "integer" | |
| 77 } | |
| 78 }, | |
| 79 "type": "object" | |
| 80 }, | |
| 81 "error": { | |
| 82 "description": "Describes a change in a DownloadItem's <code>err or</code>.", | |
| 83 "optional": true, | |
| 84 "properties": { | |
| 85 "current": { | |
| 86 "optional": true, | |
| 87 "type": "integer" | |
| 88 }, | |
| 89 "previous": { | |
| 90 "optional": true, | |
| 91 "type": "integer" | |
| 92 } | |
| 93 }, | |
| 94 "type": "object" | |
| 95 }, | |
| 96 "fileSize": { | |
| 97 "description": "Describes a change in a DownloadItem's <code>fil eSize</code>.", | |
| 98 "optional": true, | |
| 99 "properties": { | |
| 100 "current": { | |
| 101 "optional": true, | |
| 102 "type": "integer" | |
| 103 }, | |
| 104 "previous": { | |
| 105 "optional": true, | |
| 106 "type": "integer" | |
| 107 } | |
| 108 }, | |
| 109 "type": "object" | |
| 110 }, | |
| 111 "filename": { | |
| 112 "description": "Describes a change in a DownloadItem's <code>fil ename</code>.", | |
| 113 "optional": true, | |
| 114 "properties": { | |
| 115 "current": { | |
| 116 "optional": true, | |
| 117 "type": "string" | |
| 118 }, | |
| 119 "previous": { | |
| 120 "optional": true, | |
| 121 "type": "string" | |
| 122 } | |
| 123 }, | |
| 124 "type": "object" | |
| 125 }, | |
| 126 "id": { | |
| 127 "description": "An identifier that is persistent across browser sessions.", | |
| 128 "type": "integer" | |
| 129 }, | |
| 130 "mime": { | |
| 131 "description": "Describes a change in a DownloadItem's <code>mim e</code>.", | |
| 132 "optional": true, | |
| 133 "properties": { | |
| 134 "current": { | |
| 135 "optional": true, | |
| 136 "type": "string" | |
| 137 }, | |
| 138 "previous": { | |
| 139 "optional": true, | |
| 140 "type": "string" | |
| 141 } | |
| 142 }, | |
| 143 "type": "object" | |
| 144 }, | |
| 145 "paused": { | |
| 146 "description": "Describes a change in a DownloadItem's <code>pau sed</code>.", | |
| 147 "optional": true, | |
| 148 "properties": { | |
| 149 "current": { | |
| 150 "optional": true, | |
| 151 "type": "boolean" | |
| 152 }, | |
| 153 "previous": { | |
| 154 "optional": true, | |
| 155 "type": "boolean" | |
| 156 } | |
| 157 }, | |
| 158 "type": "object" | |
| 159 }, | |
| 160 "startTime": { | |
| 161 "description": "Describes a change in a DownloadItem's <code>sta rtTime</code>.", | |
| 162 "optional": true, | |
| 163 "properties": { | |
| 164 "current": { | |
| 165 "optional": true, | |
| 166 "type": "integer" | |
| 167 }, | |
| 168 "previous": { | |
| 169 "optional": true, | |
| 170 "type": "integer" | |
| 171 } | |
| 172 }, | |
| 173 "type": "object" | |
| 174 }, | |
| 175 "state": { | |
| 176 "description": "Describes a change in a DownloadItem's <code>sta te</code>.", | |
| 177 "optional": true, | |
| 178 "properties": { | |
| 179 "current": { | |
| 180 "optional": true, | |
| 181 "type": "string" | |
| 182 }, | |
| 183 "previous": { | |
| 184 "optional": true, | |
| 185 "type": "string" | |
| 186 } | |
| 187 }, | |
| 188 "type": "object" | |
| 189 }, | |
| 190 "totalBytes": { | |
| 191 "description": "Describes a change in a DownloadItem's <code>tot alBytes</code>.", | |
| 192 "optional": true, | |
| 193 "properties": { | |
| 194 "current": { | |
| 195 "optional": true, | |
| 196 "type": "integer" | |
| 197 }, | |
| 198 "previous": { | |
| 199 "optional": true, | |
| 200 "type": "integer" | |
| 201 } | |
| 202 }, | |
| 203 "type": "object" | |
| 204 }, | |
| 205 "url": { | |
| 206 "description": "Describes a change in a DownloadItem's <code>url </code>.", | |
| 207 "optional": true, | |
| 208 "properties": { | |
| 209 "current": { | |
| 210 "optional": true, | |
| 211 "type": "string" | |
| 212 }, | |
| 213 "previous": { | |
| 214 "optional": true, | |
| 215 "type": "string" | |
| 216 } | |
| 217 }, | |
| 218 "type": "object" | |
| 219 } | |
| 220 }, | |
| 221 "type": "object" | |
| 222 } | |
| 223 ], | |
| 224 "type": "function" | |
| 225 } | |
| 226 ], | |
| 227 "functions": [ | |
| 228 { | |
| 229 "description": "Download a URL. If the URL uses the HTTP[S] protocol, th en the request will include all cookies currently set for its hostname. If both <code>filename</code> and <code>saveAs</code> are specified, then the Save As di alog will be displayed, pre-populated with the specified <code>filename</code>. If the download started successfully, <code>callback</code> will be called with the new DownloadItem's <code>downloadId</code>. If there was an error starting t he download, then <code>callback</code> will be called with <code>downloadId=und efined</code> and <a href='extension.html#property-lastError'>chrome.extension.l astError</a> will contain a descriptive string. The error strings are not guaran teed to remain backwards compatible between releases. You must not parse it.", | |
| 230 "name": "download", | |
| 231 "parameters": [ | |
| 232 { | |
| 233 "description": "What to download and how.", | |
| 234 "name": "options", | |
| 235 "properties": { | |
| 236 "body": { | |
| 237 "description": "post body", | |
|
mkearney
2012/06/14 15:12:28
Capitalize post and add a full-stop.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 238 "optional": true, | |
| 239 "type": "string" | |
| 240 }, | |
| 241 "filename": { | |
| 242 "description": "A file path relative to the Downloads directory to contain the downloaded file.", | |
| 243 "optional": true, | |
| 244 "type": "string" | |
| 245 }, | |
| 246 "headers": { | |
| 247 "description": "Extra HTTP headers to send with the request if t he URL uses the HTTP[s] protocol. Each header is represented as a dictionary con taining the keys <code>name</code> and either <code>value</code> or <code>binary Value</code>, restricted to those allowed by XMLHttpRequest.", | |
| 248 "items": { | |
| 249 "properties": { | |
| 250 "name": { | |
| 251 "description": "Name of the HTTP header.", | |
| 252 "type": "string" | |
| 253 }, | |
| 254 "value": { | |
| 255 "description": "Value of the HTTP header.", | |
| 256 "type": "string" | |
| 257 } | |
| 258 }, | |
| 259 "type": "object" | |
| 260 }, | |
| 261 "optional": true, | |
| 262 "type": "array" | |
| 263 }, | |
| 264 "method": { | |
| 265 "description": "The HTTP method to use if the URL uses the HTTP[ S] protocol.", | |
| 266 "enum": [ | |
| 267 "GET", | |
| 268 "POST" | |
| 269 ], | |
| 270 "optional": true, | |
| 271 "type": "string" | |
| 272 }, | |
| 273 "saveAs": { | |
| 274 "description": "Use a file-chooser to allow the user to select a filename.", | |
| 275 "optional": true, | |
| 276 "type": "boolean" | |
| 277 }, | |
| 278 "url": { | |
| 279 "description": "The URL to download.", | |
| 280 "type": "string" | |
| 281 } | |
| 282 }, | |
| 283 "type": "object" | |
| 284 }, | |
| 285 { | |
| 286 "name": "DownloadCallback", | |
| 287 "optional": true, | |
| 288 "parameters": [ | |
| 289 { | |
| 290 "name": "downloadId", | |
| 291 "type": "integer" | |
| 292 } | |
| 293 ], | |
| 294 "type": "function" | |
| 295 } | |
| 296 ], | |
| 297 "type": "function" | |
| 298 }, | |
| 299 { | |
| 300 "description": "Find DownloadItems. Set <code>query</code> to the empty object to get all DownloadItems. To get a specific DownloadItem, set only the <c ode>id</code> field.", | |
| 301 "name": "search", | |
| 302 "parameters": [ | |
| 303 { | |
| 304 "name": "query", | |
| 305 "properties": { | |
| 306 "bytesReceived": { | |
| 307 "description": "Number of bytes received so far from the host, w ithout considering file compression.", | |
| 308 "optional": true, | |
| 309 "type": "integer" | |
| 310 }, | |
| 311 "danger": { | |
| 312 "$ref": "DangerType", | |
| 313 "description": "Indication of whether this download is thought t o be safe or known to be suspicious.", | |
| 314 "optional": true | |
| 315 }, | |
| 316 "dangerAccepted": { | |
| 317 "description": "true if the user has accepted the download's dan ger.", | |
|
mkearney
2012/06/14 15:12:28
Capitalize true.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 318 "optional": true, | |
| 319 "type": "boolean" | |
| 320 }, | |
| 321 "endTime": { | |
| 322 "description": "Number of milliseconds between the unix epoch an d when this download ended.", | |
| 323 "optional": true, | |
| 324 "type": "integer" | |
| 325 }, | |
| 326 "endedAfter": { | |
| 327 "description": "Limits results to downloads that ended after the given ms since the epoch.", | |
| 328 "optional": true, | |
| 329 "type": "integer" | |
| 330 }, | |
| 331 "endedBefore": { | |
| 332 "description": "Limits results to downloads that ended before th e given ms since the epoch.", | |
| 333 "optional": true, | |
| 334 "type": "integer" | |
| 335 }, | |
| 336 "error": { | |
| 337 "description": "Number indicating why a download was interrupted .", | |
| 338 "optional": true, | |
| 339 "type": "integer" | |
| 340 }, | |
| 341 "fileSize": { | |
| 342 "description": "Number of bytes in the whole file post-decompres sion, or -1 if unknown.", | |
| 343 "optional": true, | |
| 344 "type": "integer" | |
| 345 }, | |
| 346 "filename": { | |
| 347 "description": "absolute local path", | |
|
mkearney
2012/06/14 15:12:28
Capitalize absolute and add full-stop.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 348 "optional": true, | |
| 349 "type": "string" | |
| 350 }, | |
| 351 "filenameRegex": { | |
| 352 "description": "Limits results to downloads whose filename match es the given regular expression.", | |
| 353 "optional": true, | |
| 354 "type": "string" | |
| 355 }, | |
| 356 "id": { | |
| 357 "description": "An identifier that is persistent across browser sessions.", | |
| 358 "optional": true, | |
| 359 "type": "integer" | |
| 360 }, | |
| 361 "limit": { | |
| 362 "description": "Setting this integer limits the number of result s. Otherwise, all matching DownloadItems will be returned.", | |
| 363 "optional": true, | |
| 364 "type": "integer" | |
| 365 }, | |
| 366 "mime": { | |
| 367 "description": "The file's MIME type.", | |
| 368 "optional": true, | |
| 369 "type": "string" | |
| 370 }, | |
| 371 "orderBy": { | |
| 372 "description": "Setting this string to a DownloadItem property s orts the DownloadItems prior to applying the above filters. For example, setting <code>orderBy='startTime'</code> sorts the DownloadItems by their start time in ascending order. To specify descending order, prefix <code>orderBy</code> with a hyphen: '-startTime'.", | |
| 373 "optional": true, | |
| 374 "type": "string" | |
| 375 }, | |
| 376 "paused": { | |
| 377 "description": "true if the download has stopped reading data fr om the host, but kept the connection open.", | |
|
mkearney
2012/06/14 15:12:28
Capitalize true.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 378 "optional": true, | |
| 379 "type": "boolean" | |
| 380 }, | |
| 381 "query": { | |
| 382 "description": "This space-separated string of search terms that may be grouped using quotation marks limits results to downloads whose filename or url contain all of the search terms that do not begin with a dash '-' and no ne of the search terms that do begin with a dash.", | |
|
mkearney
2012/06/14 15:12:28
url should be URL.
benjhayden
2012/06/14 16:44:13
I added code tags and a link to DownloadItem inste
| |
| 383 "optional": true, | |
| 384 "type": "string" | |
| 385 }, | |
| 386 "startTime": { | |
| 387 "description": "Number of milliseconds between the unix epoch an d when this download began.", | |
| 388 "optional": true, | |
| 389 "type": "integer" | |
| 390 }, | |
| 391 "startedAfter": { | |
| 392 "description": "Limits results to downloads that started after t he given ms since the epoch.", | |
| 393 "optional": true, | |
| 394 "type": "integer" | |
| 395 }, | |
| 396 "startedBefore": { | |
| 397 "description": "Limits results to downloads that started before the given ms since the epoch.", | |
| 398 "optional": true, | |
| 399 "type": "integer" | |
| 400 }, | |
| 401 "state": { | |
| 402 "$ref": "State", | |
| 403 "description": "Indicates whether the download is progressing, i nterrupted, or complete.", | |
| 404 "optional": true | |
| 405 }, | |
| 406 "totalBytes": { | |
| 407 "description": "Number of bytes in the whole file, without consi dering file compression, or -1 if unknown.", | |
| 408 "optional": true, | |
| 409 "type": "integer" | |
| 410 }, | |
| 411 "totalBytesGreater": { | |
| 412 "description": "Limits results to downloads whose totalBytes is greater than the given integer.", | |
| 413 "optional": true, | |
| 414 "type": "integer" | |
| 415 }, | |
| 416 "totalBytesLess": { | |
| 417 "description": "Limits results to downloads whose totalBytes is less than the given integer.", | |
| 418 "optional": true, | |
| 419 "type": "integer" | |
| 420 }, | |
| 421 "url": { | |
| 422 "description": "absolute URL", | |
|
mkearney
2012/06/14 15:12:28
Capitalize absolute and add full-stop.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 423 "optional": true, | |
| 424 "type": "string" | |
| 425 }, | |
| 426 "urlRegex": { | |
| 427 "description": "Limits results to downloads whose url matches th e given regular expression.", | |
|
mkearney
2012/06/14 15:12:28
url should be URL.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 428 "optional": true, | |
| 429 "type": "string" | |
| 430 } | |
| 431 }, | |
| 432 "type": "object" | |
| 433 }, | |
| 434 { | |
| 435 "name": "SearchCallback", | |
| 436 "parameters": [ | |
| 437 { | |
| 438 "items": { | |
| 439 "$ref": "DownloadItem" | |
| 440 }, | |
| 441 "name": "results", | |
| 442 "type": "array" | |
| 443 } | |
| 444 ], | |
| 445 "type": "function" | |
| 446 } | |
| 447 ], | |
| 448 "type": "function" | |
| 449 }, | |
| 450 { | |
| 451 "description": "Pause the download. If the request was successful the do wnload is in a paused state. Otherwise <a href='extension.html#property-lastErro r'>chrome.extension.lastError</a> contains an error message. The request will fa il if the download is not active.", | |
| 452 "name": "pause", | |
| 453 "parameters": [ | |
| 454 { | |
| 455 "description": "The id of the download to pause.", | |
| 456 "name": "downloadId", | |
| 457 "type": "integer" | |
| 458 }, | |
| 459 { | |
| 460 "name": "NullCallback", | |
| 461 "optional": true, | |
| 462 "parameters": [], | |
| 463 "type": "function" | |
| 464 } | |
| 465 ], | |
| 466 "type": "function" | |
| 467 }, | |
| 468 { | |
| 469 "description": "Resume a paused download. If the request was successful the download is in progress and unpaused. Otherwise <a href='extension.html#prop erty-lastError'>chrome.extension.lastError</a> contains an error message. The re quest will fail if the download is not active.", | |
| 470 "name": "resume", | |
| 471 "parameters": [ | |
| 472 { | |
| 473 "description": "The id of the download to resume.", | |
| 474 "name": "downloadId", | |
| 475 "type": "integer" | |
| 476 }, | |
| 477 { | |
| 478 "name": "NullCallback", | |
| 479 "optional": true, | |
| 480 "parameters": [], | |
| 481 "type": "function" | |
| 482 } | |
| 483 ], | |
| 484 "type": "function" | |
| 485 }, | |
| 486 { | |
| 487 "description": "Cancel a download. When <code>callback</code> is run, th e download is cancelled, completed, interrupted or doesn't exist anymore.", | |
| 488 "name": "cancel", | |
| 489 "parameters": [ | |
| 490 { | |
| 491 "description": "The id of the download to cancel.", | |
| 492 "name": "downloadId", | |
| 493 "type": "integer" | |
| 494 }, | |
| 495 { | |
| 496 "name": "NullCallback", | |
| 497 "optional": true, | |
| 498 "parameters": [], | |
| 499 "type": "function" | |
| 500 } | |
| 501 ], | |
| 502 "type": "function" | |
| 503 }, | |
| 504 { | |
| 505 "description": "Retrieve an icon for the specified download. For new dow nloads, file icons are available after the onCreated event has been received. Th e image returned by this function while a download is in progress may be differe nt from the image returned after the download is complete. Icon retrieval is don e by querying the underlying operating system or toolkit depending on the platfo rm. The icon that is returned will therefore depend on a number of factors inclu ding state of the download, platform, registered file types and visual theme. If a file icon cannot be determined, <a href='extension.html#property-lastError'>c hrome.extension.lastError</a> will contain an error message.", | |
|
mkearney
2012/06/14 15:12:28
onCreated event should link to the event.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 506 "name": "getFileIcon", | |
| 507 "parameters": [ | |
| 508 { | |
| 509 "description": "The identifier for the download.", | |
| 510 "name": "downloadId", | |
| 511 "type": "integer" | |
| 512 }, | |
| 513 { | |
| 514 "name": "options", | |
| 515 "optional": true, | |
| 516 "properties": { | |
| 517 "size": { | |
| 518 "description": "The size of the icon. The returned icon will be square with dimensions size * size pixels. The default size for the icon is 32 x32 pixels.", | |
| 519 "enum": [ | |
| 520 16, | |
| 521 32 | |
| 522 ], | |
| 523 "optional": true, | |
| 524 "type": "integer" | |
| 525 } | |
| 526 }, | |
| 527 "type": "object" | |
| 528 }, | |
| 529 { | |
| 530 "name": "GetFileIconCallback", | |
| 531 "parameters": [ | |
| 532 { | |
| 533 "name": "iconURL", | |
| 534 "optional": true, | |
| 535 "type": "string" | |
| 536 } | |
| 537 ], | |
| 538 "type": "function" | |
| 539 } | |
| 540 ], | |
| 541 "type": "function" | |
| 542 }, | |
| 543 { | |
| 544 "description": "Erase matching DownloadItems from history", | |
| 545 "name": "erase", | |
| 546 "nodoc": true, | |
| 547 "parameters": [ | |
| 548 { | |
| 549 "$ref": "DownloadQuery", | |
| 550 "name": "query" | |
| 551 }, | |
| 552 { | |
| 553 "name": "EraseCallback", | |
| 554 "optional": true, | |
| 555 "parameters": [ | |
| 556 { | |
| 557 "items": { | |
| 558 "type": "integer" | |
| 559 }, | |
| 560 "name": "erasedIds", | |
| 561 "type": "array" | |
| 562 } | |
| 563 ], | |
| 564 "type": "function" | |
| 565 } | |
| 566 ], | |
| 567 "type": "function" | |
| 568 }, | |
| 569 { | |
| 570 "description": "TODO(benjhayden) Comment.", | |
|
mkearney
2012/06/14 15:12:28
Do you still need to add something here?
benjhayden
2012/06/14 16:44:13
This function is nodoc and not yet implemented. I'
| |
| 571 "name": "setDestination", | |
| 572 "nodoc": true, | |
| 573 "parameters": [ | |
| 574 { | |
| 575 "name": "downloadId", | |
| 576 "type": "integer" | |
| 577 }, | |
| 578 { | |
| 579 "name": "relativePath", | |
| 580 "type": "string" | |
| 581 } | |
| 582 ], | |
| 583 "type": "function" | |
| 584 }, | |
| 585 { | |
| 586 "description": "Prompt the user to either accept or cancel a dangerous d ownload. <code>acceptDanger()</code> does not automatically accept dangerous dow nloads.", | |
| 587 "name": "acceptDanger", | |
| 588 "nodoc": true, | |
| 589 "parameters": [ | |
| 590 { | |
| 591 "name": "downloadId", | |
| 592 "type": "integer" | |
| 593 } | |
| 594 ], | |
| 595 "type": "function" | |
| 596 }, | |
| 597 { | |
| 598 "description": "Show the downloaded file in its folder in a file manager .", | |
| 599 "name": "show", | |
| 600 "nodoc": true, | |
| 601 "parameters": [ | |
| 602 { | |
| 603 "name": "downloadId", | |
| 604 "type": "integer" | |
| 605 } | |
| 606 ], | |
| 607 "type": "function" | |
| 608 }, | |
| 609 { | |
| 610 "description": "Open the downloaded file.", | |
| 611 "name": "open", | |
| 612 "nodoc": true, | |
| 613 "parameters": [ | |
| 614 { | |
| 615 "name": "downloadId", | |
| 616 "type": "integer" | |
| 617 } | |
| 618 ], | |
| 619 "type": "function" | |
| 620 }, | |
| 621 { | |
| 622 "description": "Initiate dragging the file to another application.", | |
| 623 "name": "drag", | |
| 624 "nodoc": true, | |
| 625 "parameters": [ | |
| 626 { | |
| 627 "name": "downloadId", | |
| 628 "type": "integer" | |
| 629 } | |
| 630 ], | |
| 631 "type": "function" | |
| 632 } | |
| 633 ], | |
| 634 "namespace": "downloads", | |
| 635 "nodoc": false, | |
| 636 "types": [ | |
| 637 { | |
| 638 "id": "HeaderNameValuePair", | |
| 639 "nodoc": true, | |
| 640 "properties": { | |
| 641 "name": { | |
| 642 "description": "Name of the HTTP header.", | |
| 643 "type": "string" | |
| 644 }, | |
| 645 "value": { | |
| 646 "description": "Value of the HTTP header.", | |
| 647 "type": "string" | |
| 648 } | |
| 649 }, | |
| 650 "type": "object" | |
| 651 }, | |
| 652 { | |
| 653 "description": "", | |
| 654 "enum": [ | |
| 655 "GET", | |
| 656 "POST" | |
| 657 ], | |
| 658 "id": "HttpMethod", | |
| 659 "nodoc": true, | |
| 660 "type": "string" | |
| 661 }, | |
| 662 { | |
| 663 "id": "DownloadOptions", | |
| 664 "nodoc": true, | |
| 665 "properties": { | |
| 666 "body": { | |
| 667 "description": "post body", | |
|
mkearney
2012/06/14 15:12:28
Capitalize post and add full-stop.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 668 "optional": true, | |
| 669 "type": "string" | |
| 670 }, | |
| 671 "filename": { | |
| 672 "description": "A file path relative to the Downloads directory to c ontain the downloaded file.", | |
| 673 "optional": true, | |
| 674 "type": "string" | |
| 675 }, | |
| 676 "headers": { | |
| 677 "description": "Extra HTTP headers to send with the request if the U RL uses the HTTP[s] protocol. Each header is represented as a dictionary contain ing the keys <code>name</code> and either <code>value</code> or <code>binaryValu e</code>, restricted to those allowed by XMLHttpRequest.", | |
| 678 "items": { | |
| 679 "properties": { | |
| 680 "name": { | |
| 681 "description": "Name of the HTTP header.", | |
| 682 "type": "string" | |
| 683 }, | |
| 684 "value": { | |
| 685 "description": "Value of the HTTP header.", | |
| 686 "type": "string" | |
| 687 } | |
| 688 }, | |
| 689 "type": "object" | |
| 690 }, | |
| 691 "optional": true, | |
| 692 "type": "array" | |
| 693 }, | |
| 694 "method": { | |
| 695 "description": "The HTTP method to use if the URL uses the HTTP[S] p rotocol.", | |
| 696 "enum": [ | |
| 697 "GET", | |
| 698 "POST" | |
| 699 ], | |
| 700 "optional": true, | |
| 701 "type": "string" | |
| 702 }, | |
| 703 "saveAs": { | |
| 704 "description": "Use a file-chooser to allow the user to select a fil ename.", | |
| 705 "optional": true, | |
| 706 "type": "boolean" | |
| 707 }, | |
| 708 "url": { | |
| 709 "description": "The URL to download.", | |
| 710 "type": "string" | |
| 711 } | |
| 712 }, | |
| 713 "type": "object" | |
| 714 }, | |
| 715 { | |
| 716 "description": "'file': The download's filename is suspicious. 'url': Th e download's URL is known to be malicious. 'content': The downloaded file is kno wn to be malicious. 'uncommon': The download's URL is not commonly downloaded an d could be dangerous. 'safe': The download presents no known danger to the user' s computer. These string constants will never change, however the set of DangerT ypes may change.", | |
|
mkearney
2012/06/14 15:12:28
Can we format this in a list, rather than a paragr
benjhayden
2012/06/14 16:44:13
Done.
| |
| 717 "enum": [ | |
| 718 "file", | |
| 719 "url", | |
| 720 "content", | |
| 721 "uncommon", | |
| 722 "safe" | |
| 723 ], | |
| 724 "id": "DangerType", | |
| 725 "type": "string" | |
| 726 }, | |
| 727 { | |
| 728 "description": "'in_progress': the download is currently receiving data from the server. 'interrupted': an error broke the connection with the file host . 'complete': the download completed successfully. These string constants will n ever change, however the set of States may change.", | |
|
mkearney
2012/06/14 15:12:28
Can we format this in a list, rather than a paragr
benjhayden
2012/06/14 16:44:13
Done.
| |
| 729 "enum": [ | |
| 730 "in_progress", | |
| 731 "interrupted", | |
| 732 "complete" | |
| 733 ], | |
| 734 "id": "State", | |
| 735 "type": "string" | |
| 736 }, | |
| 737 { | |
| 738 "id": "DownloadItem", | |
| 739 "properties": { | |
| 740 "bytesReceived": { | |
| 741 "description": "Number of bytes received so far from the host, witho ut considering file compression.", | |
| 742 "name": "bytesReceived", | |
| 743 "type": "integer" | |
| 744 }, | |
| 745 "danger": { | |
| 746 "$ref": "DangerType", | |
| 747 "description": "Indication of whether this download is thought to be safe or known to be suspicious.", | |
| 748 "name": "danger" | |
| 749 }, | |
| 750 "dangerAccepted": { | |
| 751 "description": "true if the user has accepted the download's danger. ", | |
|
mkearney
2012/06/14 15:12:28
Capitalize true.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 752 "name": "dangerAccepted", | |
| 753 "optional": true, | |
| 754 "type": "boolean" | |
| 755 }, | |
| 756 "endTime": { | |
| 757 "description": "Number of milliseconds between the unix epoch and wh en this download ended.", | |
| 758 "name": "endTime", | |
| 759 "optional": true, | |
| 760 "type": "integer" | |
| 761 }, | |
| 762 "error": { | |
| 763 "description": "Number indicating why a download was interrupted.", | |
| 764 "name": "error", | |
| 765 "optional": true, | |
| 766 "type": "integer" | |
| 767 }, | |
| 768 "fileSize": { | |
| 769 "description": "Number of bytes in the whole file post-decompression , or -1 if unknown.", | |
| 770 "name": "fileSize", | |
| 771 "type": "integer" | |
| 772 }, | |
| 773 "filename": { | |
| 774 "description": "absolute local path", | |
| 775 "name": "filename", | |
| 776 "type": "string" | |
| 777 }, | |
| 778 "id": { | |
| 779 "description": "An identifier that is persistent across browser sess ions.", | |
| 780 "name": "id", | |
| 781 "type": "integer" | |
| 782 }, | |
| 783 "incognito": { | |
| 784 "description": "False if this download is recorded in the history, t rue if it is not recorded.", | |
| 785 "name": "incognito", | |
| 786 "type": "boolean" | |
| 787 }, | |
| 788 "mime": { | |
| 789 "description": "The file's MIME type.", | |
| 790 "name": "mime", | |
| 791 "type": "string" | |
| 792 }, | |
| 793 "paused": { | |
| 794 "description": "true if the download has stopped reading data from t he host, but kept the connection open.", | |
|
mkearney
2012/06/14 15:12:28
Capitalize true.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 795 "name": "paused", | |
| 796 "type": "boolean" | |
| 797 }, | |
| 798 "startTime": { | |
| 799 "description": "Number of milliseconds between the unix epoch and wh en this download began.", | |
| 800 "name": "startTime", | |
| 801 "type": "integer" | |
| 802 }, | |
| 803 "state": { | |
| 804 "$ref": "State", | |
| 805 "description": "Indicates whether the download is progressing, inter rupted, or complete.", | |
| 806 "name": "state" | |
| 807 }, | |
| 808 "totalBytes": { | |
| 809 "description": "Number of bytes in the whole file, without consideri ng file compression, or -1 if unknown.", | |
| 810 "name": "totalBytes", | |
| 811 "type": "integer" | |
| 812 }, | |
| 813 "url": { | |
| 814 "description": "absolute URL", | |
|
mkearney
2012/06/14 15:12:28
Capitalize absolute and add full-stop.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 815 "name": "url", | |
| 816 "type": "string" | |
| 817 } | |
| 818 }, | |
| 819 "type": "object" | |
| 820 }, | |
| 821 { | |
| 822 "id": "DownloadQuery", | |
| 823 "nodoc": true, | |
| 824 "properties": { | |
| 825 "bytesReceived": { | |
| 826 "description": "Number of bytes received so far from the host, witho ut considering file compression.", | |
| 827 "optional": true, | |
| 828 "type": "integer" | |
| 829 }, | |
| 830 "danger": { | |
| 831 "$ref": "DangerType", | |
| 832 "description": "Indication of whether this download is thought to be safe or known to be suspicious.", | |
| 833 "optional": true | |
| 834 }, | |
| 835 "dangerAccepted": { | |
| 836 "description": "true if the user has accepted the download's danger. ", | |
|
mkearney
2012/06/14 15:12:28
Capitalize true.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 837 "optional": true, | |
| 838 "type": "boolean" | |
| 839 }, | |
| 840 "endTime": { | |
| 841 "description": "Number of milliseconds between the unix epoch and wh en this download ended.", | |
| 842 "optional": true, | |
| 843 "type": "integer" | |
| 844 }, | |
| 845 "endedAfter": { | |
| 846 "description": "Limits results to downloads that ended after the giv en ms since the epoch.", | |
| 847 "optional": true, | |
| 848 "type": "integer" | |
| 849 }, | |
| 850 "endedBefore": { | |
| 851 "description": "Limits results to downloads that ended before the gi ven ms since the epoch.", | |
| 852 "optional": true, | |
| 853 "type": "integer" | |
| 854 }, | |
| 855 "error": { | |
| 856 "description": "Number indicating why a download was interrupted.", | |
| 857 "optional": true, | |
| 858 "type": "integer" | |
| 859 }, | |
| 860 "fileSize": { | |
| 861 "description": "Number of bytes in the whole file post-decompression , or -1 if unknown.", | |
| 862 "optional": true, | |
| 863 "type": "integer" | |
| 864 }, | |
| 865 "filename": { | |
| 866 "description": "absolute local path", | |
|
mkearney
2012/06/14 15:12:28
Capitalize absolute and add full-stop.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 867 "optional": true, | |
| 868 "type": "string" | |
| 869 }, | |
| 870 "filenameRegex": { | |
| 871 "description": "Limits results to downloads whose filename matches t he given regular expression.", | |
| 872 "optional": true, | |
| 873 "type": "string" | |
| 874 }, | |
| 875 "id": { | |
| 876 "description": "An identifier that is persistent across browser sess ions.", | |
| 877 "optional": true, | |
| 878 "type": "integer" | |
| 879 }, | |
| 880 "limit": { | |
| 881 "description": "Setting this integer limits the number of results. O therwise, all matching DownloadItems will be returned.", | |
| 882 "optional": true, | |
| 883 "type": "integer" | |
| 884 }, | |
| 885 "mime": { | |
| 886 "description": "The file's MIME type.", | |
| 887 "optional": true, | |
| 888 "type": "string" | |
| 889 }, | |
| 890 "orderBy": { | |
| 891 "description": "Setting this string to a DownloadItem property sorts the DownloadItems prior to applying the above filters. For example, setting <co de>orderBy='startTime'</code> sorts the DownloadItems by their start time in asc ending order. To specify descending order, prefix <code>orderBy</code> with a hy phen: '-startTime'.", | |
| 892 "optional": true, | |
| 893 "type": "string" | |
| 894 }, | |
| 895 "paused": { | |
| 896 "description": "true if the download has stopped reading data from t he host, but kept the connection open.", | |
|
mkearney
2012/06/14 15:12:28
Capitalize true.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 897 "optional": true, | |
| 898 "type": "boolean" | |
| 899 }, | |
| 900 "query": { | |
| 901 "description": "This space-separated string of search terms that may be grouped using quotation marks limits results to downloads whose filename or url contain all of the search terms that do not begin with a dash '-' and none o f the search terms that do begin with a dash.", | |
| 902 "optional": true, | |
| 903 "type": "string" | |
| 904 }, | |
| 905 "startTime": { | |
| 906 "description": "Number of milliseconds between the unix epoch and wh en this download began.", | |
| 907 "optional": true, | |
| 908 "type": "integer" | |
| 909 }, | |
| 910 "startedAfter": { | |
| 911 "description": "Limits results to downloads that started after the g iven ms since the epoch.", | |
| 912 "optional": true, | |
| 913 "type": "integer" | |
| 914 }, | |
| 915 "startedBefore": { | |
| 916 "description": "Limits results to downloads that started before the given ms since the epoch.", | |
| 917 "optional": true, | |
| 918 "type": "integer" | |
| 919 }, | |
| 920 "state": { | |
| 921 "$ref": "State", | |
| 922 "description": "Indicates whether the download is progressing, inter rupted, or complete.", | |
| 923 "optional": true | |
| 924 }, | |
| 925 "totalBytes": { | |
| 926 "description": "Number of bytes in the whole file, without consideri ng file compression, or -1 if unknown.", | |
| 927 "optional": true, | |
| 928 "type": "integer" | |
| 929 }, | |
| 930 "totalBytesGreater": { | |
| 931 "description": "Limits results to downloads whose totalBytes is grea ter than the given integer.", | |
| 932 "optional": true, | |
| 933 "type": "integer" | |
| 934 }, | |
| 935 "totalBytesLess": { | |
| 936 "description": "Limits results to downloads whose totalBytes is less than the given integer.", | |
| 937 "optional": true, | |
| 938 "type": "integer" | |
| 939 }, | |
| 940 "url": { | |
| 941 "description": "absolute URL", | |
|
mkearney
2012/06/14 15:12:28
Capitalize absolute.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 942 "optional": true, | |
| 943 "type": "string" | |
| 944 }, | |
| 945 "urlRegex": { | |
| 946 "description": "Limits results to downloads whose url matches the gi ven regular expression.", | |
|
mkearney
2012/06/14 15:12:28
url should be URL.
benjhayden
2012/06/14 16:44:13
Done.
| |
| 947 "optional": true, | |
| 948 "type": "string" | |
| 949 } | |
| 950 }, | |
| 951 "type": "object" | |
| 952 }, | |
| 953 { | |
| 954 "id": "DownloadStringDiff", | |
| 955 "nodoc": true, | |
| 956 "properties": { | |
| 957 "current": { | |
| 958 "optional": true, | |
| 959 "type": "string" | |
| 960 }, | |
| 961 "previous": { | |
| 962 "optional": true, | |
| 963 "type": "string" | |
| 964 } | |
| 965 }, | |
| 966 "type": "object" | |
| 967 }, | |
| 968 { | |
| 969 "id": "DownloadLongDiff", | |
| 970 "nodoc": true, | |
| 971 "properties": { | |
| 972 "current": { | |
| 973 "optional": true, | |
| 974 "type": "integer" | |
| 975 }, | |
| 976 "previous": { | |
| 977 "optional": true, | |
| 978 "type": "integer" | |
| 979 } | |
| 980 }, | |
| 981 "type": "object" | |
| 982 }, | |
| 983 { | |
| 984 "id": "DownloadBooleanDiff", | |
| 985 "nodoc": true, | |
| 986 "properties": { | |
| 987 "current": { | |
| 988 "optional": true, | |
| 989 "type": "boolean" | |
| 990 }, | |
| 991 "previous": { | |
| 992 "optional": true, | |
| 993 "type": "boolean" | |
| 994 } | |
| 995 }, | |
| 996 "type": "object" | |
| 997 }, | |
| 998 { | |
| 999 "id": "DownloadDelta", | |
| 1000 "nodoc": true, | |
| 1001 "properties": { | |
| 1002 "danger": { | |
| 1003 "description": "Describes a change in a DownloadItem's <code>danger< /code>.", | |
| 1004 "optional": true, | |
| 1005 "properties": { | |
| 1006 "current": { | |
| 1007 "optional": true, | |
| 1008 "type": "string" | |
| 1009 }, | |
| 1010 "previous": { | |
| 1011 "optional": true, | |
| 1012 "type": "string" | |
| 1013 } | |
| 1014 }, | |
| 1015 "type": "object" | |
| 1016 }, | |
| 1017 "dangerAccepted": { | |
| 1018 "description": "Describes a change in a DownloadItem's <code>dangerA ccepted</code>.", | |
| 1019 "optional": true, | |
| 1020 "properties": { | |
| 1021 "current": { | |
| 1022 "optional": true, | |
| 1023 "type": "boolean" | |
| 1024 }, | |
| 1025 "previous": { | |
| 1026 "optional": true, | |
| 1027 "type": "boolean" | |
| 1028 } | |
| 1029 }, | |
| 1030 "type": "object" | |
| 1031 }, | |
| 1032 "endTime": { | |
| 1033 "description": "Describes a change in a DownloadItem's <code>endTime </code>.", | |
| 1034 "optional": true, | |
| 1035 "properties": { | |
| 1036 "current": { | |
| 1037 "optional": true, | |
| 1038 "type": "integer" | |
| 1039 }, | |
| 1040 "previous": { | |
| 1041 "optional": true, | |
| 1042 "type": "integer" | |
| 1043 } | |
| 1044 }, | |
| 1045 "type": "object" | |
| 1046 }, | |
| 1047 "error": { | |
| 1048 "description": "Describes a change in a DownloadItem's <code>error</ code>.", | |
| 1049 "optional": true, | |
| 1050 "properties": { | |
| 1051 "current": { | |
| 1052 "optional": true, | |
| 1053 "type": "integer" | |
| 1054 }, | |
| 1055 "previous": { | |
| 1056 "optional": true, | |
| 1057 "type": "integer" | |
| 1058 } | |
| 1059 }, | |
| 1060 "type": "object" | |
| 1061 }, | |
| 1062 "fileSize": { | |
| 1063 "description": "Describes a change in a DownloadItem's <code>fileSiz e</code>.", | |
| 1064 "optional": true, | |
| 1065 "properties": { | |
| 1066 "current": { | |
| 1067 "optional": true, | |
| 1068 "type": "integer" | |
| 1069 }, | |
| 1070 "previous": { | |
| 1071 "optional": true, | |
| 1072 "type": "integer" | |
| 1073 } | |
| 1074 }, | |
| 1075 "type": "object" | |
| 1076 }, | |
| 1077 "filename": { | |
| 1078 "description": "Describes a change in a DownloadItem's <code>filenam e</code>.", | |
| 1079 "optional": true, | |
| 1080 "properties": { | |
| 1081 "current": { | |
| 1082 "optional": true, | |
| 1083 "type": "string" | |
| 1084 }, | |
| 1085 "previous": { | |
| 1086 "optional": true, | |
| 1087 "type": "string" | |
| 1088 } | |
| 1089 }, | |
| 1090 "type": "object" | |
| 1091 }, | |
| 1092 "id": { | |
| 1093 "description": "An identifier that is persistent across browser sess ions.", | |
| 1094 "type": "integer" | |
| 1095 }, | |
| 1096 "mime": { | |
| 1097 "description": "Describes a change in a DownloadItem's <code>mime</c ode>.", | |
| 1098 "optional": true, | |
| 1099 "properties": { | |
| 1100 "current": { | |
| 1101 "optional": true, | |
| 1102 "type": "string" | |
| 1103 }, | |
| 1104 "previous": { | |
| 1105 "optional": true, | |
| 1106 "type": "string" | |
| 1107 } | |
| 1108 }, | |
| 1109 "type": "object" | |
| 1110 }, | |
| 1111 "paused": { | |
| 1112 "description": "Describes a change in a DownloadItem's <code>paused< /code>.", | |
| 1113 "optional": true, | |
| 1114 "properties": { | |
| 1115 "current": { | |
| 1116 "optional": true, | |
| 1117 "type": "boolean" | |
| 1118 }, | |
| 1119 "previous": { | |
| 1120 "optional": true, | |
| 1121 "type": "boolean" | |
| 1122 } | |
| 1123 }, | |
| 1124 "type": "object" | |
| 1125 }, | |
| 1126 "startTime": { | |
| 1127 "description": "Describes a change in a DownloadItem's <code>startTi me</code>.", | |
| 1128 "optional": true, | |
| 1129 "properties": { | |
| 1130 "current": { | |
| 1131 "optional": true, | |
| 1132 "type": "integer" | |
| 1133 }, | |
| 1134 "previous": { | |
| 1135 "optional": true, | |
| 1136 "type": "integer" | |
| 1137 } | |
| 1138 }, | |
| 1139 "type": "object" | |
| 1140 }, | |
| 1141 "state": { | |
| 1142 "description": "Describes a change in a DownloadItem's <code>state</ code>.", | |
| 1143 "optional": true, | |
| 1144 "properties": { | |
| 1145 "current": { | |
| 1146 "optional": true, | |
| 1147 "type": "string" | |
| 1148 }, | |
| 1149 "previous": { | |
| 1150 "optional": true, | |
| 1151 "type": "string" | |
| 1152 } | |
| 1153 }, | |
| 1154 "type": "object" | |
| 1155 }, | |
| 1156 "totalBytes": { | |
| 1157 "description": "Describes a change in a DownloadItem's <code>totalBy tes</code>.", | |
| 1158 "optional": true, | |
| 1159 "properties": { | |
| 1160 "current": { | |
| 1161 "optional": true, | |
| 1162 "type": "integer" | |
| 1163 }, | |
| 1164 "previous": { | |
| 1165 "optional": true, | |
| 1166 "type": "integer" | |
| 1167 } | |
| 1168 }, | |
| 1169 "type": "object" | |
| 1170 }, | |
| 1171 "url": { | |
| 1172 "description": "Describes a change in a DownloadItem's <code>url</co de>.", | |
| 1173 "optional": true, | |
| 1174 "properties": { | |
| 1175 "current": { | |
| 1176 "optional": true, | |
| 1177 "type": "string" | |
| 1178 }, | |
| 1179 "previous": { | |
| 1180 "optional": true, | |
| 1181 "type": "string" | |
| 1182 } | |
| 1183 }, | |
| 1184 "type": "object" | |
| 1185 } | |
| 1186 }, | |
| 1187 "type": "object" | |
| 1188 }, | |
| 1189 { | |
| 1190 "id": "GetFileIconOptions", | |
| 1191 "nodoc": true, | |
| 1192 "properties": { | |
| 1193 "size": { | |
| 1194 "description": "The size of the icon. The returned icon will be squ are with dimensions size * size pixels. The default size for the icon is 32x32 pixels.", | |
| 1195 "enum": [ | |
| 1196 16, | |
| 1197 32 | |
| 1198 ], | |
| 1199 "optional": true, | |
| 1200 "type": "integer" | |
| 1201 } | |
| 1202 }, | |
| 1203 "type": "object" | |
| 1204 } | |
| 1205 ] | |
| 1206 } | |
| 1207 ] | |
| OLD | NEW |
