downloads.onChanged

L'événement onChanged() de l'API downloads est déclenché lorsque l'une des propriétés de downloads.DownloadItem change (à l'exception de bytesReceived).

L'écouteur reçoit un fichier downloadDelta en tant que paramètre — un objet contenant le downloadId de l'objet downloads.DownloadItem en question, plus le statut de toutes les propriétés qui ont changé.

Syntaxe

browser.downloads.onChanged.addListener(listener)
browser.downloads.onChanged.removeListener(listener)
browser.downloads.onChanged.hasListener(listener)

Les événements ont trois fonctions :

addListener(callback)
Ajoute un écouteur à cet événement.
removeListener(listener)
Arrêtez d'écouter cet événement. L'argument listener est l'écouteur à supprimer.
hasListener(listener)
Vérifiez si un listener donné est enregistré pour cet événement. Renvoie true s'il écoute, sinon false.

Syntaxe addListener

Parameters

callback

Une fonction de rappel qui sera appelée lorsque cet événement se produira. Cette fonction recevra les arguments suivants :

downloadDelta
Un objet représentant l'objet downloads.DownloadItem qui a été modifié, ainsi que l'état de toutes les propriétés qui y ont été modifiées.

Objets supplémentaires

downloadDelta

L'objet downloadDelta a les propriétés suivantes disponibles :

id
Un integer représentant l'identifiant de l'id  downloads.DownloadItem qui a changé.
urlFacultatif
Un objet downloads.StringDelta décrivant une modification d'une  url downloads.DownloadItem.
filenameFacultatif
Un objet downloads.StringDelta décrivant un changement dans un filename downloads.DownloadItem
dangerFacultatif
Un objet downloads.StringDelta décrivant un changement dans un danger downloads.DownloadItem.
mimeFacultatif
Un objet downloads.StringDelta décrivant un changement dans un mime downloads.DownloadItem
startTimeFacultatif
Un objet downloads.StringDelta décrivant un changement dans un startTime downloads.DownloadItem.
endTimeFacultatif
Un objet downloads.StringDelta décrivant un changement dans un  endTime downloads.DownloadItem.
stateFacultatif
Un objet downloads.StringDelta décrivant un changement dans un état downloads.DownloadItem
canResumeFacultatif
Un objet downloads.BooleanDelta décrivant un changement dans un état downloads.DownloadItem canResume.
pausedFacultatif
Un objet downloads.BooleanDelta décrivant un changement dans un état en pause downloads.DownloadItem.
errorFacultatif
Un objet downloads.StringDelta décrivant un changement dans un état d'erreur downloads.DownloadItem.
totalBytesFacultatif
Un objet downloads.DoubleDelta décrivant un changement dans un totalBytes downloads.DownloadItem.
fileSizeFacultatif
Un objet  downloads.DoubleDelta décrivant une modification d'un  fileSize downloads.DownloadItem.
existsFacultatif
Un objet downloads.BooleanDelta décrivant un changement dans un état downloads.DownloadItem.

Compatibilité du navigateur

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxOperaFirefox pour Android
Support simpleChrome Support complet OuiEdge Aucun support NonFirefox Support complet 47Opera Support complet OuiFirefox Android Support complet 48

Légende

Support complet  
Support complet
Aucun support  
Aucun support

Exemples

Enregistrez un message lorsque les téléchargements sont terminés :

function handleChanged(delta) {
  if (delta.state && delta.state.current === "complete") {
    console.log(`Download ${delta.id} has completed.`);
  }
}

browser.downloads.onChanged.addListener(handleChanged);

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.

Étiquettes et contributeurs liés au document

Contributeurs à cette page : hellosct1
Dernière mise à jour par : hellosct1,