downloads.pause()

La fonction pause() de l'API downloads interrompt un téléchargement.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

js
var pausing = browser.downloads.pause(
  downloadId, // integer
);

Paramètres

downloadId

Un integer représetant l'id du téléchargement à mettre en pause.

Valeur retournée

Une Promise. Si l'appel a réussi, le téléchargement sera mis en pause et la promesse sera satisfaite sans aucun argument. Si l'appel échoue, la promesse sera rejetée avec un message d'erreur. L'appel échouera si le téléchargement n'est pas actif: par exemple, parce qu'il a fini le téléchargement.

Compatibilité des navigateurs

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
pause

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support

Exemples

js
function onPaused() {
  console.log(`Paused download`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var pausing = browser.downloads.pause(downloadId);
pausing.then(onPaused, onError);

Note :

Cette API est basée sur l'API Chromium chrome.downloads.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.