browser.downloads

Opis

Użyj interfejsu API chrome.downloads, aby automatycznie inicjować, monitorować, modyfikować i wyszukiwać pobierane pliki.

Uprawnienia

downloads

Aby używać tego interfejsu API, musisz zadeklarować uprawnienie "downloads" w pliku manifestu rozszerzenia.

{
  "name": "My extension",
  ...
  "permissions": [
    "downloads"
  ],
}

Przykłady

Proste przykłady użycia interfejsu API browser.downloads znajdziesz w katalogu examples/api/downloads. Inne przykłady i pomoc w wyświetlaniu kodu źródłowego znajdziesz w sekcji Przykłady.

Typy

BooleanDelta

Właściwości

• obecnie

  boolean opcjonalne

• wstecz

  boolean opcjonalne

DangerType

Typ wyliczeniowy

"file"
Nazwa pobieranego pliku jest podejrzana.

"url"
adres URL pobierania jest znany jako szkodliwy.

"content"
Pobrany plik jest znany jako szkodliwy.

"uncommon"
URL pobierania nie jest często pobierany i może być niebezpieczny.

"host"
Plik został pobrany z hosta, który jest znany z rozpowszechniania szkodliwych plików binarnych, i prawdopodobnie jest niebezpieczny.

"unwanted"
Pobierany plik może być niepożądany lub niebezpieczny. Może na przykład wprowadzać zmiany w ustawieniach przeglądarki lub komputera.

"safe"
Pobierany plik nie stanowi znanego zagrożenia dla komputera użytkownika.

"accepted"
Użytkownik zaakceptował niebezpieczny plik do pobrania.

"allowlistedByPolicy"
Wartości związane z firmą.

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepScannedOpenedDangerous"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

"forceSaveToGdrive"
Do użytku przez rozszerzenie Secure Enterprise Browser. W razie potrzeby Chrome zablokuje pobieranie na dysk i pobierze plik bezpośrednio na Dysk Google.

"forceSaveToOnedrive"
Do użytku przez rozszerzenie Secure Enterprise Browser. W razie potrzeby Chrome zablokuje pobieranie na dysk i pobierze plik bezpośrednio do OneDrive.

DoubleDelta

Właściwości

• obecnie

  number optional

• wstecz

  number optional

DownloadDelta

Właściwości

• canResume

  BooleanDelta opcjonalnie

  Zmiana w canResume (jeśli wystąpiła).

• niebezpieczeństwo

  StringDelta opcjonalne

  Zmiana w danger (jeśli wystąpiła).

• endTime

  StringDelta opcjonalne

  Zmiana w endTime (jeśli wystąpiła).

• błąd

  StringDelta opcjonalne

  Zmiana w error (jeśli wystąpiła).

• istnieje

  BooleanDelta opcjonalne

  Zmiana w exists (jeśli wystąpiła).

• fileSize

  DoubleDelta opcjonalny

  Zmiana w fileSize (jeśli wystąpiła).

• nazwa pliku

  StringDelta opcjonalne

  Zmiana w filename (jeśli wystąpiła).

• finalUrl

  StringDelta opcjonalne

  Chrome 54 lub nowsza browser.* od Chrome 148

  Zmiana w finalUrl (jeśli wystąpiła).

• id

  liczba

  id DownloadItem, który uległ zmianie.

• mim

  StringDelta opcjonalne

  Zmiana w mime (jeśli wystąpiła).

• wstrzymana

  BooleanDelta opcjonalnie

  Zmiana w paused (jeśli wystąpiła).

• startTime

  StringDelta opcjonalne

  Zmiana w startTime (jeśli wystąpiła).

• stan

  StringDelta opcjonalne

  Zmiana w state (jeśli wystąpiła).

• totalBytes

  DoubleDelta opcjonalny

  Zmiana w totalBytes (jeśli wystąpiła).

• URL

  StringDelta opcjonalne

  Zmiana w url (jeśli wystąpiła).

DownloadItem

Właściwości

• byExtensionId

  ciąg znaków opcjonalny

  Identyfikator rozszerzenia, które zainicjowało pobieranie, jeśli zostało ono zainicjowane przez rozszerzenie. Nie zmienia się po ustawieniu.

• byExtensionName

  ciąg znaków opcjonalny

  Zlokalizowana nazwa rozszerzenia, które zainicjowało pobieranie, jeśli pobieranie zostało zainicjowane przez rozszerzenie. Może się zmienić, jeśli rozszerzenie zmieni nazwę lub użytkownik zmieni ustawienia regionalne.

• bytesReceived

  liczba

  Liczba bajtów odebranych do tej pory z hosta, bez uwzględnienia kompresji pliku.

• canResume

  wartość logiczna

  Wartość „Prawda”, jeśli pobieranie jest w toku i zostało wstrzymane lub jeśli zostało przerwane i można je wznowić od miejsca, w którym zostało przerwane.

• niebezpieczeństwo

  DangerType

  Wskazanie, czy pobierany plik jest uważany za bezpieczny czy podejrzany.

• endTime

  ciąg znaków opcjonalny

  Czas zakończenia pobierania w formacie ISO 8601. Można przekazać bezpośrednio do konstruktora Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

• błąd

  InterruptReason opcjonalny

  Powody przerwania pobierania. Kilka rodzajów błędów HTTP może być zgrupowanych pod jednym z błędów zaczynających się od SERVER_. Błędy związane z siecią zaczynają się od NETWORK_, błędy związane z procesem zapisywania pliku w systemie plików zaczynają się od FILE_, a przerwy zainicjowane przez użytkownika zaczynają się od USER_.

• estimatedEndTime

  ciąg znaków opcjonalny

  Szacowany czas zakończenia pobierania w formacie ISO 8601. Można przekazać bezpośrednio do konstruktora Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

• istnieje

  wartość logiczna

  Czy pobrany plik nadal istnieje. Te informacje mogą być nieaktualne, ponieważ Chrome nie sprawdza automatycznie, czy pliki zostały usunięte. Wywołaj funkcję search(), aby sprawdzić, czy plik istnieje. Jeśli po zakończeniu sprawdzania okaże się, że plik został usunięty, zostanie wywołane zdarzenie onChanged. Pamiętaj, że funkcja search() nie czeka na zakończenie sprawdzania istnienia przed zwróceniem wyników, więc wyniki z funkcji search() mogą nie odzwierciedlać dokładnie systemu plików. Funkcję search() można wywoływać tak często, jak to konieczne, ale nie będzie ona sprawdzać istnienia pliku częściej niż raz na 10 sekund.

• fileSize

  liczba

  Liczba bajtów w całym pliku po dekompresji lub -1, jeśli jest nieznana.

• nazwa pliku

  tekst

  Bezwzględna ścieżka lokalna.

• finalUrl

  tekst

  Chrome 54 lub nowsza browser.* od Chrome 148

  Bezwzględny URL, z którego następuje pobieranie, po wszystkich przekierowaniach.

• id

  liczba

  Identyfikator, który jest zachowywany w różnych sesjach przeglądarki.

• incognito

  wartość logiczna

  Wartość „false”, jeśli pobieranie jest zapisane w historii, lub „true”, jeśli nie jest zapisane.

• mim

  tekst

  Typ MIME pliku.

• wstrzymana

  wartość logiczna

  Wartość „true”, jeśli pobieranie przestało odczytywać dane z hosta, ale połączenie pozostało otwarte.

• strona odsyłająca

  tekst

  Bezwzględny URL.

• startTime

  tekst

  Czas rozpoczęcia pobierania w formacie ISO 8601. Można przekazać bezpośrednio do konstruktora Date: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

• stan

  Stan

  Wskazuje, czy pobieranie jest w toku, zostało przerwane czy zakończone.

• totalBytes

  liczba

  Liczba bajtów w całym pliku bez uwzględniania kompresji pliku lub -1, jeśli jest nieznana.

• URL

  tekst

  Bezwzględny URL, z którego rozpoczęto pobieranie, przed przekierowaniami.

DownloadOptions

Właściwości

• treść

  ciąg znaków opcjonalny

  Treść posta.

• conflictAction

  FilenameConflictAction opcjonalny

  Działanie, które należy podjąć, jeśli filename już istnieje.

• nazwa pliku

  ciąg znaków opcjonalny

  Ścieżka pliku względem katalogu Pobrane, w którym ma się znaleźć pobrany plik. Może zawierać podkatalogi. Ścieżki bezwzględne, puste ścieżki i ścieżki zawierające odwołania wsteczne „..” spowodują błąd. onDeterminingFilename umożliwia sugerowanie nazwy pliku po określeniu jego typu MIME i wstępnej nazwy.

• nagłówki

  HeaderNameValuePair[] opcjonalny

  Dodatkowe nagłówki HTTP, które mają zostać wysłane z żądaniem, jeśli adres URL używa protokołu HTTP[s]. Każdy nagłówek jest reprezentowany jako słownik zawierający klucze name oraz value lub binaryValue, ograniczone do tych dozwolonych przez XMLHttpRequest.

• method

  HttpMethod opcjonalny

  Metoda HTTP, która ma być używana, jeśli adres URL korzysta z protokołu HTTP[S].

• saveAs

  boolean opcjonalne

  Użyj selektora plików, aby umożliwić użytkownikowi wybranie nazwy pliku niezależnie od tego, czy zasada filename jest skonfigurowana lub już istnieje.

• URL

  tekst

  Adres URL do pobrania.

DownloadQuery

Właściwości

• bytesReceived

  number optional

  Liczba bajtów odebranych do tej pory z hosta, bez uwzględnienia kompresji pliku.

• niebezpieczeństwo

  DangerType opcjonalny

  Wskazanie, czy pobierany plik jest uważany za bezpieczny czy podejrzany.

• endTime

  ciąg znaków opcjonalny

  Czas zakończenia pobierania w formacie ISO 8601.

• endedAfter

  ciąg znaków opcjonalny

  Ogranicza wyniki do DownloadItem, które zakończyły się po podanej liczbie milisekund w formacie ISO 8601

• endedBefore

  ciąg znaków opcjonalny

  Ogranicza wyniki do DownloadItem, które zakończyły się przed podaną liczbą milisekund w formacie ISO 8601.

• błąd

  InterruptReason opcjonalny

  Powody przerwania pobierania.

• istnieje

  boolean opcjonalne

  czy pobrany plik istnieje;

• fileSize

  number optional

  Liczba bajtów w całym pliku po dekompresji lub -1, jeśli jest nieznana.

• nazwa pliku

  ciąg znaków opcjonalny

  Bezwzględna ścieżka lokalna.

• filenameRegex

  ciąg znaków opcjonalny

  Ogranicza wyniki do DownloadItem, których filename pasuje do podanego wyrażenia regularnego.

• finalUrl

  ciąg znaków opcjonalny

  Chrome 54 lub nowsza browser.* od Chrome 148

  Bezwzględny URL, z którego następuje pobieranie, po wszystkich przekierowaniach.

• finalUrlRegex

  ciąg znaków opcjonalny

  Chrome 54 lub nowsza browser.* od Chrome 148

  Ogranicza wyniki do DownloadItem, których finalUrl pasuje do podanego wyrażenia regularnego.

• id

  number optional

  id DownloadItem, którego dotyczy zapytanie.

• limit

  number optional

  Maksymalna liczba zwracanych pasujących obiektów DownloadItem. Domyślna wartość to 1000. Ustaw wartość 0, aby zwrócić wszystkie pasujące DownloadItem. Informacje o tym, jak przeglądać wyniki, znajdziesz w search.

• mim

  ciąg znaków opcjonalny

  Typ MIME pliku.

• orderBy

  string[] opcjonalne

  Aby posortować wyniki wyszukiwania, ustaw elementy tej tablicy na właściwości DownloadItem. Na przykład ustawienie orderBy=['startTime'] sortuje DownloadItem według czasu rozpoczęcia w kolejności rosnącej. Aby określić kolejność malejącą, dodaj łącznik: „-startTime”.

• wstrzymana

  boolean opcjonalne

  Wartość „true”, jeśli pobieranie przestało odczytywać dane z hosta, ale połączenie pozostało otwarte.

• zapytanie

  string[] opcjonalne

  Ta tablica wyszukiwanych haseł ogranicza wyniki do DownloadItem, których filename, url lub finalUrl zawiera wszystkie wyszukiwane hasła, które nie zaczynają się od myślnika „-”, i żadnego z wyszukiwanych haseł, które zaczynają się od myślnika.

• startTime

  ciąg znaków opcjonalny

  Czas rozpoczęcia pobierania w formacie ISO 8601.

• startedAfter

  ciąg znaków opcjonalny

  Ogranicza wyniki do DownloadItem, które rozpoczęły się po podanej liczbie milisekund w formacie ISO 8601.

• startedBefore

  ciąg znaków opcjonalny

  Ogranicza wyniki do DownloadItem, które rozpoczęły się przed podaną liczbą milisekund w formacie ISO 8601.

• stan

  State opcjonalny

  Wskazuje, czy pobieranie jest w toku, zostało przerwane czy zakończone.

• totalBytes

  number optional

  Liczba bajtów w całym pliku bez uwzględniania kompresji pliku lub -1, jeśli jest nieznana.

• totalBytesGreater

  number optional

  Ogranicza wyniki do DownloadItem, których totalBytes jest większa niż podana liczba całkowita.

• totalBytesLess

  number optional

  Ogranicza wyniki do DownloadItem, których totalBytes jest mniejsza niż podana liczba całkowita.

• URL

  ciąg znaków opcjonalny

  Bezwzględny URL, z którego rozpoczęto pobieranie, przed przekierowaniami.

• urlRegex

  ciąg znaków opcjonalny

  Ogranicza wyniki do DownloadItem, których url pasuje do podanego wyrażenia regularnego.

FilenameConflictAction

uniquify

Aby uniknąć duplikowania, nazwa filename została zmieniona i zawiera licznik przed rozszerzeniem nazwy pliku.

zastąpić

Istniejący plik zostanie zastąpiony nowym.

prompt

Użytkownik zobaczy okno wyboru pliku.

Typ wyliczeniowy

"uniquify"

"overwrite"

"prompt"

FilenameSuggestion

Właściwości

• conflictAction

  FilenameConflictAction opcjonalny

  Działanie, które należy podjąć, jeśli filename już istnieje.

• nazwa pliku

  tekst

  Nowy element docelowy DownloadItem.filename obiektu DownloadItem jako ścieżka względna do domyślnego katalogu pobierania użytkownika, która może zawierać podkatalogi. Ścieżki bezwzględne, puste i zawierające odwołania wsteczne „..” będą ignorowane. filename jest ignorowane, jeśli istnieją detektory onDeterminingFilename zarejestrowane przez rozszerzenia.

GetFileIconOptions

Właściwości

• rozmiar

  number optional

  Rozmiar zwróconej ikony w pikselach niezależnych od gęstości (DIP). Musi to być 16 lub 32 (domyślnie 32). Na wyświetlaczach o wysokiej rozdzielczości zwrócony obraz jest skalowany zgodnie ze współczynnikiem skalowania urządzenia (np. 64 x 64 piksele dla rozmiaru 32 na wyświetlaczu 2x). Wywołania z procesów roboczych usługi w tle domyślnie mają skalę 1x.

HeaderNameValuePair

Właściwości

• nazwa

  tekst

  Nazwa nagłówka HTTP.

• wartość

  tekst

  Wartość nagłówka HTTP.

HttpMethod

Typ wyliczeniowy

"GET"

"POST"

InterruptReason

Typ wyliczeniowy

"FILE_FAILED"

"FILE_ACCESS_DENIED"

"FILE_NO_SPACE"

"FILE_NAME_TOO_LONG"

"FILE_TOO_LARGE"

"FILE_VIRUS_INFECTED"

"FILE_TRANSIENT_ERROR"

"FILE_BLOCKED"

"FILE_SECURITY_CHECK_FAILED"

"FILE_TOO_SHORT"

"FILE_HASH_MISMATCH"

"FILE_SAME_AS_SOURCE"

"NETWORK_FAILED"

"NETWORK_TIMEOUT"

"NETWORK_DISCONNECTED"

"NETWORK_SERVER_DOWN"

"NETWORK_INVALID_REQUEST"

"SERVER_FAILED"

"SERVER_NO_RANGE"

"SERVER_BAD_CONTENT"

"SERVER_UNAUTHORIZED"

"SERVER_CERT_PROBLEM"

"SERVER_FORBIDDEN"

"SERVER_UNREACHABLE"

"SERVER_CONTENT_LENGTH_MISMATCH"

"SERVER_CROSS_ORIGIN_REDIRECT"

"USER_CANCELED"

"USER_SHUTDOWN"

"CRASH"

State

in_progress

Pobieranie obecnie odbiera dane z serwera.

przerwano

Błąd spowodował przerwanie połączenia z hostem pliku.

zakończono

Pobieranie zostało zakończone.

Typ wyliczeniowy

"in_progress"

"interrupted"

"complete"

StringDelta

Właściwości

• obecnie

  ciąg znaków opcjonalny

• wstecz

  ciąg znaków opcjonalny

UiOptions

Chrome 105 lub nowsza wersja browser.* od Chrome 148

Właściwości

• aktywne

  wartość logiczna

  Włącz lub wyłącz interfejs pobierania.

Metody

acceptDanger()

browser.downloads.acceptDanger(
  downloadId: number,
): Promise<void>

Wyświetl użytkownikowi prośbę o zaakceptowanie niebezpiecznego pobierania. Można ją wywołać tylko z widocznego kontekstu (karty, okna lub wyskakującego okienka działania na stronie/w przeglądarce). Nie akceptuje automatycznie niebezpiecznych plików do pobrania. Jeśli pobieranie zostanie zaakceptowane, zostanie wywołane zdarzenie onChanged. W przeciwnym razie nic się nie stanie. Gdy wszystkie dane zostaną pobrane do pliku tymczasowego, a pobieranie nie jest niebezpieczne lub niebezpieczeństwo zostało zaakceptowane, nazwa pliku tymczasowego zostanie zmieniona na docelową nazwę pliku, state zmieni się na „complete” i zostanie wywołane zdarzenie onChanged.

Parametry

• downloadId

  liczba

  Identyfikator DownloadItem.

Zwroty

• thought Promise<void>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

  Zwraca obietnicę, która jest spełniana po zamknięciu okna z ostrzeżeniem.

cancel()

browser.downloads.cancel(
  downloadId: number,
): Promise<void>

Anulowanie pobierania. Gdy uruchomiono callback, pobieranie zostało anulowane, zakończone, przerwane lub już nie istnieje.

Parametry

• downloadId

  liczba

  Identyfikator pobierania, które chcesz anulować.

Zwroty

• thought Promise<void>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

  Zwraca obietnicę, która zostanie spełniona po zakończeniu żądania anulowania.

download()

browser.downloads.download(
  options: DownloadOptions,
): Promise<number>

pobieranie adresu URL, Jeśli adres URL używa protokołu HTTP[S], żądanie będzie zawierać wszystkie pliki cookie ustawione obecnie dla jego nazwy hosta. Jeśli określono zarówno filename, jak i saveAs, wyświetli się okno Zapisz jako, wstępnie wypełnione określonym filename. Jeśli pobieranie rozpoczęło się pomyślnie, zostanie wywołana funkcja callback z nowym downloadId obiektu DownloadItem. Jeśli podczas rozpoczynania pobierania wystąpił błąd, zostanie wywołana funkcja callback z parametrem downloadId=undefined, a runtime.lastError będzie zawierać ciąg tekstowy z opisem. Nie gwarantujemy, że ciągi błędów będą zgodne wstecznie między wersjami. Rozszerzenia nie mogą go analizować.

Parametry

• Opcje

  DownloadOptions

  Co i jak pobrać.

Zwroty

• Promise<number>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

  Zwraca obiekt Promise, który rozwiązuje się z identyfikatorem nowego obiektu DownloadItem.

erase()

browser.downloads.erase(
  query: DownloadQuery,
): Promise<number[]>

Usuń pasujące pliki DownloadItem z historii bez usuwania pobranego pliku. Zdarzenie onErased zostanie wywołane dla każdego elementu DownloadItem, który pasuje do query, a następnie zostanie wywołane callback.

Parametry

• zapytanie

  DownloadQuery

Zwroty

• thought Promise<number[]>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

getFileIcon()

browser.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
): Promise<string | undefined>

Pobierz ikonę określonego pobierania. W przypadku nowych pobrań ikony plików są dostępne po określeniu docelowej nazwy pliku (np. gdy zdarzenie onChanged jest wywoływane ze zmianą filename). Próba pobrania ikony przed określeniem nazwy pliku spowoduje błąd w runtime.lastError. Obraz zwracany przez tę funkcję podczas pobierania może się różnić od obrazu zwracanego po zakończeniu pobierania. Pobieranie ikon odbywa się przez wysłanie zapytania do systemu operacyjnego lub zestawu narzędzi, w zależności od platformy. Zwracana ikona zależy od wielu czynników, takich jak stan pobierania, platforma, zarejestrowane typy plików i motyw wizualny. Jeśli nie można określić ikony pliku, runtime.lastError będzie zawierać komunikat o błędzie.

Parametry

• downloadId

  liczba

  Identyfikator pobierania.

• Opcje

  GetFileIconOptions opcjonalny

Zwroty

• Promise<string | undefined>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

  Zwraca obiekt Promise, który jest rozwiązywany za pomocą adresu URL obrazu reprezentującego pobieranie.

open()

browser.downloads.open(
  downloadId: number,
): Promise<void>

Otwiera pobrany plik, jeśli DownloadItem jest zakończone. W przeciwnym razie zwraca błąd przez runtime.lastError. Ta metoda wymaga uprawnienia "downloads.open" oraz uprawnienia "downloads". Zdarzenie onChanged jest wywoływane, gdy element jest otwierany po raz pierwszy. Tę metodę można wywołać tylko w odpowiedzi na gest użytkownika.

Parametry

• downloadId

  liczba

  Identyfikator pobranego pliku.

Zwroty

• thought Promise<void>

  Chrome 123 lub nowsza browser.* od Chrome 148

pause()

browser.downloads.pause(
  downloadId: number,
): Promise<void>

Wstrzymaj pobieranie. Jeśli żądanie zostało rozpatrzone pozytywnie, pobieranie zostanie wstrzymane. W przeciwnym razie runtime.lastError zawiera komunikat o błędzie. Jeśli pobieranie nie jest aktywne, żądanie się nie powiedzie.

Parametry

• downloadId

  liczba

  Identyfikator pobierania, które ma zostać wstrzymane.

Zwroty

• thought Promise<void>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

  Zwraca obiekt Promise, który jest spełniany po zakończeniu żądania wstrzymania.

removeFile()

browser.downloads.removeFile(
  downloadId: number,
): Promise<void>

Usuń pobrany plik, jeśli istnieje, a DownloadItem jest zakończone. W przeciwnym razie zwróć błąd za pomocą runtime.lastError.

Parametry

• downloadId

  liczba

Zwroty

• thought Promise<void>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

resume()

browser.downloads.resume(
  downloadId: number,
): Promise<void>

Wznów wstrzymane pobieranie. Jeśli żądanie zostało zrealizowane, pobieranie jest w toku i nie jest wstrzymane. W przeciwnym razie runtime.lastError zawiera komunikat o błędzie. Jeśli pobieranie nie jest aktywne, żądanie się nie powiedzie.

Parametry

• downloadId

  liczba

  Identyfikator pobierania, które ma zostać wznowione.

Zwroty

• thought Promise<void>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

  Zwraca obietnicę, która jest spełniana po zakończeniu żądania wznowienia.

search()

browser.downloads.search(
  query: DownloadQuery,
): Promise<DownloadItem[]>

Znajdź DownloadItem. Ustaw query na pusty obiekt, aby uzyskać wszystkie DownloadItem. Aby uzyskać konkretny element DownloadItem, ustaw tylko pole id. Aby przeglądać dużą liczbę elementów, ustaw orderBy: ['-startTime'], ustaw limit na liczbę elementów na stronie i ustaw startedAfter na startTime ostatniego elementu z ostatniej strony.

Parametry

• zapytanie

  DownloadQuery

Zwroty

• Obiekt Promise<DownloadItem[]>

  Chrome 96 lub nowsza wersja browser.* od Chrome 148

setShelfEnabled()

Wycofane od Chrome 117

browser.downloads.setShelfEnabled(
  enabled: boolean,
): void

Zamiast tego użyj setUiOptions.

Włącz lub wyłącz szarą półkę u dołu każdego okna powiązanego z bieżącym profilem przeglądarki. Półka będzie wyłączona, dopóki co najmniej jedno rozszerzenie będzie ją wyłączać. Włączenie półki, gdy co najmniej jedno inne rozszerzenie ją wyłączyło, spowoduje zwrócenie błędu przez runtime.lastError. Wymaga uprawnienia "downloads.shelf" oraz uprawnienia "downloads".

Parametry

• aktywne

  wartość logiczna

setUiOptions()

Chrome 105 lub nowsza wersja browser.* od Chrome 148

browser.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

Zmień interfejs pobierania każdego okna powiązanego z bieżącym profilem przeglądarki. Jeśli co najmniej jedno rozszerzenie ma ustawioną wartość UiOptions.enabled na „false”, interfejs pobierania będzie ukryty. Ustawienie właściwości UiOptions.enabled na wartość „true”, gdy co najmniej jedno inne rozszerzenie ją wyłączyło, spowoduje zwrócenie błędu przez runtime.lastError. Wymaga uprawnienia "downloads.ui" oraz uprawnienia "downloads".

Parametry

• Opcje

  UiOptions

  Hermetyzacja zmiany w interfejsie pobierania.

Zwroty

• thought Promise<void>

  Zwraca obietnicę, która jest spełniana po zakończeniu aktualizacji interfejsu.

show()

browser.downloads.show(
  downloadId: number,
): void

Wyświetl pobrany plik w jego folderze w menedżerze plików.

Parametry

• downloadId

  liczba

  Identyfikator pobranego pliku.

showDefaultFolder()

browser.downloads.showDefaultFolder(): void

Wyświetl domyślny folder Pobrane w menedżerze plików.

Wydarzenia

onChanged

browser.downloads.onChanged.addListener(
  callback: function,
)

Gdy zmieni się dowolna właściwość DownloadItem z wyjątkiem bytesReceived i estimatedEndTime, to zdarzenie zostanie wywołane z downloadId i obiektem zawierającym zmienione właściwości.

Parametry

• callback

  funkcja

  Parametr callback wygląda tak:

  (downloadDelta: DownloadDelta) =& gt;void

  • downloadDelta

    DownloadDelta

onCreated

browser.downloads.onCreated.addListener(
  callback: function,
)

To zdarzenie jest wywoływane z obiektem DownloadItem, gdy rozpoczyna się pobieranie.

Parametry

• callback

  funkcja

  Parametr callback wygląda tak:

  (downloadItem: DownloadItem) =& gt;void

  • downloadItem

    DownloadItem

onDeterminingFilename

browser.downloads.onDeterminingFilename.addListener(
  callback: function,
)

Podczas procesu określania nazwy pliku rozszerzenia będą mogły zastąpić docelowy DownloadItem.filename. Każde rozszerzenie może zarejestrować tylko 1 detektor tego zdarzenia. Każdy detektor musi wywołać funkcję suggest dokładnie raz, synchronicznie lub asynchronicznie. Jeśli detektor wywołuje suggest asynchronicznie, musi zwrócić true. Jeśli detektor nie wywoła suggest synchronicznie ani nie zwróci true, funkcja suggest zostanie wywołana automatycznie. Funkcja DownloadItem nie zostanie ukończona, dopóki wszystkie obiekty nasłuchujące nie wywołają funkcji suggest. Detektory mogą wywoływać funkcję suggest bez żadnych argumentów, aby umożliwić pobieranie z użyciem nazwy pliku downloadItem.filename, lub przekazywać obiekt suggestion do funkcji suggest, aby zastąpić docelową nazwę pliku. Jeśli więcej niż 1 rozszerzenie zastępuje nazwę pliku, pierwszeństwo ma ostatnie zainstalowane rozszerzenie, którego detektor przekazuje obiekt suggestion do suggest. Aby uniknąć nieporozumień dotyczących tego, które rozszerzenie będzie miało pierwszeństwo, użytkownicy nie powinni instalować rozszerzeń, które mogą powodować konflikty. Jeśli pobieranie jest inicjowane przez download, a docelowa nazwa pliku jest znana, zanim zostaną określone typ MIME i tymczasowa nazwa pliku, przekaż filename do download.

Parametry

• callback

  funkcja

  Parametr callback wygląda tak:

  (downloadItem: DownloadItem, suggest: function) =& gt;void

  • downloadItem

    DownloadItem

  • zasugeruj

    funkcja

    Parametr suggest wygląda tak:

    (suggestion?: FilenameSuggestion) =& gt;void

    • sugestia

      FilenameSuggestion opcjonalny

onErased

browser.downloads.onErased.addListener(
  callback: function,
)

Uruchamia się z downloadId, gdy pobrany plik zostanie usunięty z historii.

Parametry

• callback

  funkcja

  Parametr callback wygląda tak:

  (downloadId: number) =& gt;void

  • downloadId

    liczba