Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

downloads.onChanged

この記事はまだボランティアによって 日本語 に翻訳されていません。ぜひ MDN に参加して翻訳を手伝ってください!

The onChanged() event of the downloads API is fired when any of a downloads.DownloadItem's properties changes (except for bytesReceived).

The listener is passed a downloadDelta as a parameter — an object containing the downloadId of the downloads.DownloadItem object in question, plus the status of all the properties that changed.

Syntax

chrome.downloads.onChanged.addListener(function(downloadDelta) {...})
chrome.downloads.onChanged.removeListener(listener)
chrome.downloads.onChanged.hasListener(listener)

This API is also available as browser.downloads.onChanged.*.

Events have three functions:

addListener(callback)
Adds a listener to this event.
removeListener(listener)
Stop listening to this event. The listener argument is the listener to remove.
hasListener(listener)
Check whether a given listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback

A callback function that will be called when this event occurs. This function will be passed the following arguments:

downloadDelta
An object representing the downloads.DownloadItem object that changed, and the status of all the properties that changed in it.

Additional objects

downloadDelta

The downloadDelta object has the following properties available:

id
An integer representing the id of the downloads.DownloadItem that changed.
urlOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's url.
filenameOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's filename.
dangerOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's danger.
mimeOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's mime.
startTimeOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's startTime.
endTimeOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's endTime.
stateOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's state.
canResumeOptional
A downloads.BooleanDelta object describing a change in a downloads.DownloadItem's canResume status.
pausedOptional
A downloads.BooleanDelta object describing a change in a downloads.DownloadItem's paused status.
errorOptional
A downloads.StringDelta object describing a change in a downloads.DownloadItem's error status.
totalBytesOptional
A downloads.DoubleDelta object describing a change in a downloads.DownloadItem's totalBytes.
fileSizeOptional
A downloads.DoubleDelta object describing a change in a downloads.DownloadItem's fileSize.
existsOptional
A downloads.BooleanDelta object describing a change in a downloads.DownloadItem's exists status.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 47.0 48.0 33

Examples

In this snippet we have a single button that when clicked, downloads a file via a call to downloads.download(). We also use the download.onChanged event and an associated handler to listen out for changes to the current downloads.DownloadItem's state property. When the downloads.DownloadItem's current state property is equal to complete (state below is a downloads.StringDelta, and we are checking it's current property), we log a message to the console to say that the download is complete.

var downloadBtn = document.querySelector('.download');

downloadBtn.onclick = function() {
  chrome.downloads.download({ url : 'https://www.example.com/myBigVideo.mp4'});
}

chrome.downloads.onChanged.addListener(function(downloadDelta) {
  if(downloadDelta.state.current === 'complete') {
    console.log('The download has completed.');
  }
});

Acknowledgements

This API is based on Chromium's chrome.downloads API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

ドキュメントのタグと貢献者

 このページの貢献者: Makyen, chrisdavidmills, wbamberg
 最終更新者: Makyen,