downloads.search()
La fonction search()
de l'API downloads
interroge les DownloadItems
disponibles dans le gestionnaire de téléchargements du navigateur, et renvoie celles qui correspondent aux spécifications critères de recherche.
C'est une fonction asynchrone qui renvoie une Promise
.
Syntaxe
var searching = browser.downloads.search(query);
Paramètres
query
-
Un objet
downloads.DownloadQuery
.
Return value
Une Promise
. La promise est remplie avec un tableau d'objets
qui correspondent aux critères donnés.downloads.DownloadItem
Compatibilité des navigateurs
BCD tables only load in the browser
Exemples
En général, vous restreignez les éléments récupérés à l'aide du paramètre de requête
.
Obtenez les téléchargements correspondant à "query"
function logDownloads(downloads) {
for (let download of downloads) {
console.log(download.id);
console.log(download.url);
}
}
function onError(error) {
console.log(`Error: ${error}`);
}
var searching = browser.downloads.search({
query: ["imgur"],
});
searching.then(logDownloads, onError);
Obtenez un article spécifique
Pour obtenir un DownloadItem
, la méthode la plus simple consiste à définir uniquement le champ id
, comme indiqué dans l'extrait ci-dessous :
function logDownloads(downloads) {
for (let download of downloads) {
console.log(download.id);
console.log(download.url);
}
}
function onError(error) {
console.log(`Error: ${error}`);
}
var id = 13;
var searching = browser.downloads.search({ id });
searching.then(logDownloads, onError);
Obtenez tous les téléchargements
Si vous voulez renvoyer tout DownloadItems
, définissez la query
sur un objet vide.
function logDownloads(downloads) {
for (let download of downloads) {
console.log(download.id);
console.log(download.url);
}
}
function onError(error) {
console.log(`Error: ${error}`);
}
var searching = browser.downloads.search({});
searching.then(logDownloads, onError);
Obtenez le téléchargement le plus récent
Vous pouvez obtenir le téléchargement le plus récent en spécifiant les paramètres de recherche suivants :
function logDownloads(downloads) {
for (let download of downloads) {
console.log(download.id);
console.log(download.url);
}
}
function onError(error) {
console.log(`Error: ${error}`);
}
var searching = browser.downloads.search({
limit: 1,
orderBy: ["-startTime"],
});
searching.then(logDownloads, onError);
Vous pouvez voir ce code en action par exemple dans notre dernier téléchargement.
Example extensions
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.