API参考:chrome.downloads
参数
DownloadOptions
- body(optional string)
- 需要post的body内容
- saveAs(optional boolean)
- 是否弹出路径选择框
- url(string)
- 下载的链接
- filename(optional string)
- 文件名
- headers(暂忽略)
- 暂忽略
- method(optional httpMethod)
- get或者post, 默认为get
DownloadItem
- bytesReceived(integer)
- 接收到了的大小。
- danger(忽略)
- 忽略
- url(string)
- 下载项的url。
- totalBytes(integer)
- 附件的大小。
- dangerAccepted(忽略)
- 忽略。
- filename(string)
- 文件的绝对路径。
- paused(boolean)
- 是否暂停。
- state(State)
- enumerated string["in_progress", "interrupted", "complete"]。
- mime(string)
- MIME
- fileSize(integer)
- 文件的大小。
- startTime(integer)
- 开始下载的时间戳。
- error(optional integer)
- 下载的错误号。
- endTime(optional integer)
- 结束的时间戳。
- id(integer)
- 下载项的id。
- incognito(boolean)
- 忽略。
DownloadQuery
- orderBy(optional string)
- 暂不支持。
- urlRegex(optional string)
- url的正则。
- endedBefore(optional integer)
- 早于给定的结束时间戳。
- totalBytesGreater(optional integer)
- 大于给定的大小。
- danger(optional DangerType)
- 忽略。
- totalBytes(optional integer)
- 总大小。
- paused(optional boolean)
- 是否暂停。
- filenameRegex(optional string)
- 文件名的正则。
- query(optional string)
- 暂不支持。
- totalBytesLess(optional integer)
- 小于给定的大小。
- id(optional integer)
- 下载项的id。
- bytesReceived(optional integer)
- 接收到了的大小。
- endedAfter(optional integer)
- 晚于给定的结束时间戳。
- filename(optional string)
- 文件名。
- state(optional State)
- enumerated string["in_progress", "interrupted", "complete"]。
- startedAfter(optional integer)
- 早于给定的开始时间戳。
- dangerAccepted(optional boolean)
- 忽略。
- mime(optional string)
- MIME
- fileSize(optional integer)
- 文件的大小。
- startTime(optional integer)
- 开始时间戳。
- url(optional string)
- 下载项的url。
- startedBefore(optional integer)
- 早于给定的开始时间戳。
- limit(optional integer)
- 结果项不多于这个值。
- error(optional integer)
- 下载的错误号。
- endTime(optional integer)
- 结束时间。
GetFileIconOptions
- size(optional integer)
- 需要获取的图片的大小。目前仅支持32*32。
方法
download
sogouExplorer.downloads.download(DownloadOptions options, funciton callback)
- 给定参数,使用浏览器下载。
- 参数
- options(DownloadOptions)
- 见上文。
- function callback
- function(integer downloadId) {...};
- downloadId(integer)
search
sogouExplorer.downloads.search(DownloadQuery query, function callback)
- 搜索下载项(DownloadItems)。如果query为空的object,那么就是获取所有的下载项。
- 参数
- query(DownloadQuery)
- 见上文。
- function callback
- function(array of DownloadItem) {...}
pause
sogouExplorer.downloads.pause(integer downloadId, function callback)
- 暂停一个下载任务。
- 参数
- downloadId(integer)
- 下载项的id。
- function callback
- function(boolean success) {...}
resume
sogouExplorer.downloads.resume(integer downloadId, function callback)
- 恢复一个下载任务。
- 参数
- downloadId(integer)
- 下载项的id。
- function callback
- function(boolean success) {...}
cancel
sogouExplorer.downloads.cancel(integer downloadId, function callback)
- 取消一个下载任务。
- 参数
- downloadId(integer)
- 下载项的id。
- function callback
- function(boolean success) {...}
getFileIcon
sogouExplorer.downloads.getFileIcon(integer downloadId, GetFileIconOptions options, function callback)
- 获取下载的附件的图标。
- 参数
- downloadId(integer)
- 下载项的id。
- options(optional GetFileIconOptions)
- 见上文
- function callback
- function(string iconURL) {...}
事件
onCreated
sogouExplorer.downloads.onCreated.addListener(function(DownloadItem downloadItem) {…});
- 当有下载任务被创建的时候会触发这个listener。
onErased
sogouExplorer.downloads.onErased.addListener(function(integer downloadId) {…});
- 下载任务被删除的时候触发。
onChanged
sogouExplorer.downloads.onChanged.addListener(function(DownloadItem downloadItem) {…});
- 下载任务发生暂停、重新开始、下载完毕的时候被触发。参数见上文。