chrome.downloads

Opis

Interfejs API chrome.downloads umożliwia programowe inicjowanie, monitorowanie i wyszukiwanie plików do pobrania oraz manipulowanie nimi.

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 korzystania z interfejsu API chrome.downloads znajdziesz w katalogu examples/api/downloads. Więcej przykładów oraz pomoc dotyczącą wyświetlania kodu źródłowego znajdziesz w artykule Przykłady.

Typy

BooleanDelta

Właściwości

  • obecnie

    wartość logiczna opcjonalna

  • wstecz

    wartość logiczna opcjonalna

DangerType

plik

Nazwa pobieranego pliku jest podejrzana.

URL

Wiadomo, że adres URL pobierania jest złośliwy.

treści, które są

Pobrany plik jest uznawany za złośliwy.

niezbyt częste

Adres URL pliku do pobrania nie jest często pobierany i może być niebezpieczny.

organizator

Plik został pobrany z hosta, o którym wiadomo, że rozpowszechnia złośliwe pliki binarne, i może być niebezpieczny.

niechciane

Pobieranie jest potencjalnie niechciane lub niebezpieczne. Może na przykład zmienić ustawienia przeglądarki lub komputera.

bezpieczeństwo

Pobrany plik nie stanowi znanego zagrożenia dla komputera użytkownika.

akceptowane

Użytkownik zaakceptował niebezpieczne pliki.

Typ wyliczeniowy

"url"

"content"

"host"

"asyncScanning"

"asyncLocalPasswordScanning"

"blockedTooLarge"

"sensitiveContentWarning"

"deepScannedFailed"

"deepScannedSafe"

"promptForScanning"

"promptForLocalPasswordScanning"

DoubleDelta

Właściwości

  • obecnie

    Liczba opcjonalnie

  • wstecz

    Liczba opcjonalnie

DownloadDelta

Właściwości

  • canResume

    Opcjonalny BooleanDelta

    Zmiana w kolumnie canResume (jeśli miała miejsce).

  • zagrożenie

    StringDelta opcjonalnie

    Zmiana w kolumnie danger (jeśli miała miejsce).

  • endTime

    StringDelta opcjonalnie

    Zmiana w kolumnie endTime (jeśli miała miejsce).

  • error

    StringDelta opcjonalnie

    Zmiana w kolumnie error (jeśli miała miejsce).

  • istnieje

    Opcjonalny BooleanDelta

    Zmiana w kolumnie exists (jeśli miała miejsce).

  • fileSize

    DoubleDelta, opcjonalnie

    Zmiana w kolumnie fileSize (jeśli miała miejsce).

  • filename

    StringDelta opcjonalnie

    Zmiana w kolumnie filename (jeśli miała miejsce).

  • finalUrl

    StringDelta opcjonalnie

    Chrome w wersji 54 i nowszych

    Zmiana w kolumnie finalUrl (jeśli miała miejsce).

  • id

    Liczba

    Wartość id elementu DownloadItem, która uległa zmianie.

  • mim

    StringDelta opcjonalnie

    Zmiana w kolumnie mime (jeśli miała miejsce).

  • wstrzymane

    Opcjonalny BooleanDelta

    Zmiana w kolumnie paused (jeśli miała miejsce).

  • startTime

    StringDelta opcjonalnie

    Zmiana w kolumnie startTime (jeśli miała miejsce).

  • state

    StringDelta opcjonalnie

    Zmiana w kolumnie state (jeśli miała miejsce).

  • totalBytes

    DoubleDelta, opcjonalnie

    Zmiana w kolumnie totalBytes (jeśli miała miejsce).

  • URL

    StringDelta opcjonalnie

    Zmiana w kolumnie url (jeśli miała miejsce).

DownloadItem

Właściwości

  • byExtensionId

    ciąg znaków opcjonalny

    Identyfikator rozszerzenia, które zainicjowało pobieranie, jeśli pobieranie zostało 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 swoją nazwę lub gdy użytkownik zmieni język.

  • bytesReceived

    Liczba

    Liczba bajtów otrzymanych dotąd z hosta bez uwzględniania kompresji plików.

  • canResume

    boolean

    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.

  • zagrożenie

    DangerType

    Informacja o tym, czy pobrany plik został uznany za bezpieczny lub podejrzany.

  • endTime

    ciąg znaków opcjonalny

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

  • error

    InterruptReason (opcjonalnie)

    Przyczyna przerwania pobierania. Kilka rodzajów błędów HTTP może zostać zaliczonych do jednego 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 – od USER_.

  • estimatedEndTime

    ciąg znaków opcjonalny

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

  • istnieje

    boolean

    Informacja, czy pobrany plik nadal istnieje. Te informacje mogą być nieaktualne, ponieważ Chrome nie wykrywa automatycznie usunięcia plików. Wywołaj funkcję search(), aby aktywować sprawdzanie obecności pliku. Jeśli po zakończeniu sprawdzania, czy plik został usunięty, uruchomione zostanie zdarzenie onChanged. Pamiętaj, że funkcja search() nie czeka na zakończenie sprawdzania obecności przed zwróceniem, więc wyniki z funkcji search() mogą nie odzwierciedlać dokładnie systemu plików. Dodatkowo funkcja search() może być wywoływana tak często, jak to konieczne, ale nie sprawdza obecności pliku częściej niż co 10 sekund.

  • fileSize

    Liczba

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

  • filename

    string,

    Ścieżka bezwzględna lokalna.

  • finalUrl

    string,

    Chrome w wersji 54 i nowszych

    Bezwzględny URL, z którego pochodzi ten plik do pobrania, po wszystkich przekierowaniach.

  • id

    Liczba

    Identyfikator, który jest trwały w sesjach przeglądarki.

  • incognito

    boolean

    Fałsz, jeśli pobieranie jest rejestrowane w historii, ma wartość prawda, jeśli nie jest rejestrowane.

  • mim

    string,

    Typ MIME pliku.

  • wstrzymane

    boolean

    Prawda, jeśli pobieranie zatrzymało odczytywanie danych z hosta, ale połączenie nie zostało przerwane.

  • referrer

    string,

    Bezwzględny URL.

  • startTime

    string,

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

  • state

    Stan

    Wskazuje, czy pobieranie jest kontynuowane, przerwane czy zakończone.

  • totalBytes

    Liczba

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

  • URL

    string,

    Bezwzględny URL, od którego zainicjowano pobieranie, przed przekierowaniami.

DownloadOptions

Właściwości

  • body

    ciąg znaków opcjonalny

    Treść posta.

  • conflictAction

    FilenameConflictAction opcjonalnie

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

  • filename

    ciąg znaków opcjonalny

    Ścieżka pliku w stosunku do katalogu Pobrane pliki, który ma zawierać pobrany plik. Może też zawierać podkatalogi. Ścieżki bezwzględne, puste i ścieżki zawierające wsteczne odniesienia „..” będą powodować błąd. onDeterminingFilename umożliwia sugerowanie nazwy pliku po określeniu typu MIME i wstępnej nazwy pliku.

  • headers

    HeaderNameValuePair[] opcjonalny

    Dodatkowe nagłówki HTTP wysyłane z żądaniem, jeśli adres URL korzysta z protokołu HTTP[s]. Każdy nagłówek jest przedstawiany jako słownik zawierający klucze name i value lub binaryValue, z ograniczeniem do tych, na które zezwala XMLHttpRequest.

  • method

    HttpMethod opcjonalny

    Metoda HTTP używana w przypadku adresów URL używających protokołu HTTP[S].

  • saveAs

    wartość logiczna opcjonalna

    Użyj narzędzia do wybierania plików, aby umożliwić użytkownikowi wybranie nazwy pliku niezależnie od tego, czy filename jest ustawiony, czy już istnieje.

  • URL

    string,

    Adres URL pobierania.

DownloadQuery

Właściwości

  • bytesReceived

    Liczba opcjonalnie

    Liczba bajtów otrzymanych dotąd z hosta bez uwzględniania kompresji plików.

  • zagrożenie

    DangerType opcjonalny

    Informacja o tym, czy pobrany plik został uznany za bezpieczny lub podejrzany.

  • endTime

    ciąg znaków opcjonalny

    Godzina zakończenia pobierania w formacie ISO 8601.

  • endedAfter

    ciąg znaków opcjonalny

    Ogranicza wyniki do DownloadItem, które zakończyły się po określonym czasie ms w formacie ISO 8601

  • endedBefore

    ciąg znaków opcjonalny

    Ogranicza wyniki do DownloadItem, które zakończyły się przed podanym czasem w formacie ISO 8601.

  • error

    InterruptReason (opcjonalnie)

    Przyczyny przerwania pobierania.

  • istnieje

    wartość logiczna opcjonalna

    czy pobrany plik istnieje;

  • fileSize

    Liczba opcjonalnie

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

  • filename

    ciąg znaków opcjonalny

    Ścieżka bezwzględna lokalna.

  • filenameRegex

    ciąg znaków opcjonalny

    Ogranicza wyniki do DownloadItem, którego filename pasuje do danego wyrażenia regularnego.

  • finalUrl

    ciąg znaków opcjonalny

    Chrome w wersji 54 i nowszych

    Bezwzględny URL, z którego pochodzi ten plik do pobrania, po wszystkich przekierowaniach.

  • finalUrlRegex

    ciąg znaków opcjonalny

    Chrome w wersji 54 i nowszych

    Ogranicza wyniki do DownloadItem, którego finalUrl pasuje do danego wyrażenia regularnego.

  • id

    Liczba opcjonalnie

    Wartość id DownloadItem, których dotyczy zapytanie.

  • limit

    Liczba opcjonalnie

    Zwrócono maksymalną liczbę pasujących elementów (DownloadItem). Domyślna wartość to 1000. Aby zwrócić wszystkie pasujące elementy DownloadItem, ustaw wartość 0. Aby dowiedzieć się, jak przeglądać wyniki, przeczytaj artykuł search.

  • mim

    ciąg znaków opcjonalny

    Typ MIME pliku.

  • orderBy

    string[] opcjonalny

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

  • wstrzymane

    wartość logiczna opcjonalna

    Prawda, jeśli pobieranie zatrzymało odczytywanie danych z hosta, ale połączenie nie zostało przerwane.

  • zapytanie

    string[] opcjonalny

    Ta tablica wyszukiwanych haseł ogranicza wyniki do DownloadItem, których filename, url lub finalUrl zawierają wszystkie wyszukiwane hasła niepoprzedzone łącznikiem „-” i żadne z wyszukiwanych haseł, które zaczynają się od łącznika.

  • startTime

    ciąg znaków opcjonalny

    Godzina rozpoczęcia pobierania w formacie ISO 8601.

  • startedAfter

    ciąg znaków opcjonalny

    Ogranicza wyniki do DownloadItem, które zostały rozpoczęte po określonym czasie ms w formacie ISO 8601.

  • startedBefore

    ciąg znaków opcjonalny

    Ogranicza wyniki do DownloadItem, które rozpoczęły się przed podanym czasem w formacie ISO 8601.

  • state

    Stan opcjonalny

    Wskazuje, czy pobieranie jest kontynuowane, przerwane czy zakończone.

  • totalBytes

    Liczba opcjonalnie

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

  • totalBytesGreater

    Liczba opcjonalnie

    Ogranicza wyniki do zakresu DownloadItem, którego totalBytes jest większy od podanej liczby całkowitej.

  • totalBytesLess

    Liczba opcjonalnie

    Ogranicza wyniki do funkcji DownloadItem, której totalBytes jest mniejszy od podanej liczby całkowitej.

  • URL

    ciąg znaków opcjonalny

    Bezwzględny URL, od którego zainicjowano pobieranie, przed przekierowaniami.

  • urlRegex

    ciąg znaków opcjonalny

    Ogranicza wyniki do DownloadItem, którego url pasuje do danego wyrażenia regularnego.

FilenameConflictAction

Uniquify

Aby uniknąć duplikowania pliku, parametr filename został zmieniony tak, aby zawierał licznik przed rozszerzeniem pliku.

zastąpić

Istniejący plik zostanie zastąpiony nowym plikiem.

prośba

Użytkownik zobaczy okno wyboru plików.

Typ wyliczeniowy

"uniquify"

"prompt"

FilenameSuggestion

Właściwości

  • conflictAction

    FilenameConflictAction opcjonalnie

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

  • filename

    string,

    Nowy element docelowy DownloadItem.filename elementu DownloadItem, podany jako ścieżka względem domyślnego katalogu Pobrane pliki użytkownika, prawdopodobnie zawierający podkatalogi. Ścieżki bezwzględne, puste i ścieżki zawierające wsteczne odniesienia „..” będą ignorowane. Tag filename jest ignorowany, jeśli jakieś rozszerzenia zarejestrowały detektor onDeterminingFilename.

GetFileIconOptions

Właściwości

  • rozmiar

     opcjonalnie

    Rozmiar zwróconej ikony. Ikona będzie kwadratowa o wymiarach rozmiar * rozmiar w pikselach. Domyślny i największy rozmiar ikony to 32 x 32 piksele. Jedyne obsługiwane rozmiary to 16 i 32. Określenie innego rozmiaru to błąd.

HeaderNameValuePair

Właściwości

  • nazwa

    string,

    Nazwa nagłówka HTTP.

  • value

    string,

    Wartość nagłówka HTTP.

HttpMethod

Typ wyliczeniowy

InterruptReason

Typ wyliczeniowy

State

in_progress

Do pobierania są aktualnie odbierane dane z serwera.

przerwano

Błąd zerwał połączenie z hostem plików.

zakończono

Pobieranie ukończone.

Typ wyliczeniowy

"in_progress"

StringDelta

Właściwości

  • obecnie

    ciąg znaków opcjonalny

  • wstecz

    ciąg znaków opcjonalny

UiOptions

Chrome 105 i nowsze wersje

Właściwości

  • włączone

    boolean

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

Metody

acceptDanger()

Obietnica 
chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
)

Wyświetl użytkownikowi prośbę o zaakceptowanie niebezpiecznego pobrania. Można je wywoływać tylko z widocznego kontekstu (karty, okna lub wyskakującego okienka działań na stronie/przeglądarce). Nie akceptuje automatycznie niebezpiecznych plików. Jeśli pobieranie zostanie zaakceptowane, uruchomi się zdarzenie onChanged. W przeciwnym razie nic się nie wydarzy. Gdy wszystkie dane zostaną pobrane do pliku tymczasowego i jego pobieranie nie jest niebezpieczne lub zagrożenie zostało zaakceptowane, nazwa pliku tymczasowego zmienia się na docelowy plik, a plik state zmienia się na „zakończony” i uruchamia się onChanged.

Parametry

  • downloadId

    Liczba

    Identyfikator DownloadItem.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Zwroty

  • Promise<void>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

cancel()

Obietnica 
chrome.downloads.cancel(
  downloadId: number,
  callback?: function,
)

Anulowanie pobierania. Po uruchomieniu callback pobieranie jest anulowane, ukończone, przerwane lub już nie istnieje.

Parametry

  • downloadId

    Liczba

    Identyfikator pobierania do anulowania.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Zwroty

  • Promise<void>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

download()

Obietnica 
chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
)

Pobierz adres 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 podasz zarówno parametr filename, jak i saveAs, wyświetli się okno Zapisz jako z wstępnie wypełnionym polem filename. Jeśli pobieranie się rozpoczęło, funkcja callback zostanie wywołana z nowym identyfikatorem klienta DownloadItem (downloadId). Jeśli podczas pobierania wystąpił błąd, funkcja callback zostanie wywołana z metodą downloadId=undefined, a runtime.lastError będzie zawierać ciąg opisowy. Nie ma gwarancji, że ciągi błędów będą zgodne wstecznie między wersjami. Rozszerzenia nie mogą ich analizować.

Parametry

  • Co i jak pobrać

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (downloadId: number)=>void

    • downloadId

      Liczba

Zwroty

  • Obietnica<number>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

erase()

Obietnica 
chrome.downloads.erase(
  query: DownloadQuery,
  callback?: function,
)

Usuń z historii pasujące elementy (DownloadItem) bez usuwania pobranego pliku. Zdarzenie onErased będzie uruchamiane w przypadku każdego DownloadItem pasującego do query, a następnie wywoływane jest callback.

Parametry

  • zapytanie

    DownloadQuery

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (erasedIds: number[])=>void

    • erasedIds

      liczba[]

Zwroty

  • Obietnica<number[]>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

getFileIcon()

Obietnica 
chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
  callback?: function,
)

Pobierz ikonę określonego pliku do pobrania. W przypadku nowo pobranych plików ikony plików są dostępne po odebraniu zdarzenia onCreated. Obraz zwrócony przez tę funkcję w trakcie pobierania może się różnić od obrazu zwróconego po zakończeniu pobierania. W zależności od platformy ikona jest pobierana za pomocą zapytania o system operacyjny lub zestaw narzędzi. Zwracana ikona zależy więc od wielu czynników, w tym od stanu pobierania, platformy, zarejestrowanych typów plików i motywu wizualnego. Jeśli nie można określić ikony pliku, runtime.lastError wyświetli komunikat o błędzie.

Parametry

  • downloadId

    Liczba

    Identyfikator pobierania.

  • Opcje

    Opcjonalnie GetFileIconOptions

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (iconURL?: string)=>void

    • iconURL

      ciąg znaków opcjonalny

Zwroty

  • Obietnica<string|undefined>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

open()

Obietnica 
chrome.downloads.open(
  downloadId: number,
  callback?: function,
)

Otwiera teraz pobrany plik, jeśli proces DownloadItem jest ukończony. W przeciwnym razie zwraca błąd przez runtime.lastError. Ta metoda wymaga uprawnienia "downloads.open" oraz uprawnienia "downloads". Zdarzenie onChanged jest uruchamiane, gdy element zostanie otwarty po raz pierwszy. Tę metodę można wywoływać tylko w odpowiedzi na gest użytkownika.

Parametry

  • downloadId

    Liczba

    Identyfikator pobranego pliku.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Chrome 123 i nowsze wersje

    Parametr callback wygląda tak: 

    ()=>void

Zwroty

  • Promise<void>

    Chrome 123 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

pause()

Obietnica 
chrome.downloads.pause(
  downloadId: number,
  callback?: function,
)

Wstrzymaj pobieranie. Jeśli żądanie zostało zrealizowane, pobieranie jest wstrzymane. W przeciwnym razie runtime.lastError wyświetli komunikat o błędzie. Jeśli pobieranie nie będzie aktywne, żądanie nie zostanie zrealizowane.

Parametry

  • downloadId

    Liczba

    Identyfikator pobierania do wstrzymania.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Zwroty

  • Promise<void>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

removeFile()

Obietnica 
chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
)

Usuń pobrany plik, jeśli istnieje, a DownloadItem jest kompletny. W przeciwnym razie zwracaj błąd, używając runtime.lastError.

Parametry

  • downloadId

    Liczba

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Zwroty

  • Promise<void>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

resume()

Obietnica 
chrome.downloads.resume(
  downloadId: number,
  callback?: function,
)

Wznawianie wstrzymanego pobierania. Jeśli żądanie zostało zrealizowane, pobieranie trwa i jest wznawiane. W przeciwnym razie runtime.lastError wyświetli komunikat o błędzie. Jeśli pobieranie nie będzie aktywne, żądanie nie zostanie zrealizowane.

Parametry

  • downloadId

    Liczba

    Identyfikator pobierania do wznowienia.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Zwroty

  • Promise<void>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

Obietnica 
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
)

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

Parametry

Zwroty

  • Promise<DownloadItem[]>

    Chrome 96 i nowsze wersje

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setShelfEnabled()

Wycofane od Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

Użyj w zamian 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 zostanie wyłączona, dopóki co najmniej jedno rozszerzenie ją wyłączy. Włączenie półki, gdy co najmniej jedno inne rozszerzenie zostało wyłączone, spowoduje zwrócenie błędu do runtime.lastError. Oprócz uprawnienia "downloads" wymaga uprawnienia "downloads.shelf".

Parametry

  • włączone

    boolean

setUiOptions()

Obietnica Chrome w wersji 105 lub nowszej 
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

Zmiana interfejsu pobierania każdego okna powiązanego z bieżącym profilem przeglądarki. Dopóki co najmniej jedno rozszerzenie ma wartość Fałsz, interfejs pobierania jest ukryty dla parametru UiOptions.enabled. Jeśli zasada UiOptions.enabled ma wartość Prawda, gdy co najmniej 1 inne rozszerzenie jest wyłączone, do runtime.lastError zwracany jest błąd. Oprócz uprawnienia "downloads" wymaga uprawnienia "downloads.ui".

Parametry

  • Opcje

    UiOptions

    Wprowadź zmianę w interfejsie pobierania.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Zwroty

  • Promise<void>

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

show()

chrome.downloads.show(
  downloadId: number,
)

Pokaż pobrany plik w folderze w menedżerze plików.

Parametry

  • downloadId

    Liczba

    Identyfikator pobranego pliku.

showDefaultFolder()

chrome.downloads.showDefaultFolder()

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

Wydarzenia

onChanged

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

Gdy zmieni się dowolna z właściwości elementu DownloadItem (oprócz bytesReceived i estimatedEndTime), to zdarzenie jest uruchamiane z downloadId i obiektem zawierającym zmienione właściwości.

Parametry

onCreated

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

To zdarzenie uruchamia się z obiektem DownloadItem po rozpoczęciu pobierania.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (downloadItem: DownloadItem)=>void

onDeterminingFilename

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

Podczas określania nazwy pliku rozszerzenia będą mogły zastąpić element docelowy DownloadItem.filename. Każde rozszerzenie może zarejestrować tylko jeden detektor tego zdarzenia. Każdy detektor musi wywołać suggest dokładnie raz – synchronicznie lub asynchronicznie. Jeśli detektor wywołuje funkcję suggest asynchronicznie, musi zwrócić wartość true. Jeśli detektor nie wywoła funkcji suggest synchronicznie ani nie zwróci metody true, funkcja suggest zostanie wywołana automatycznie. Działanie DownloadItem nie zostanie ukończone, dopóki wszyscy słuchacze nie wywołają funkcji suggest. Detektory mogą wywoływać suggest bez żadnych argumentów, by umożliwić podczas pobierania użycie downloadItem.filename jako nazwy pliku, lub przekazanie obiektu suggestion do suggest, by zastąpić docelową nazwę pliku. Jeśli nazwę pliku zastąpi więcej niż 1 rozszerzenie, wygra ostatnie zainstalowane rozszerzenie, którego odbiornik przekaże obiekt suggestion do interfejsu suggest. Aby uniknąć nieporozumień co do tego, które rozszerzenie wygrało, użytkownicy nie powinni instalować rozszerzeń, które mogą kolidować. Jeśli pobieranie zostało zainicjowane przez download, a nazwa pliku docelowego jest znana przed określeniem typu MIME i wstępnej nazwy pliku, zamiast tego przekaż filename do download.

Parametry

onErased

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

Uruchamiany z wartością downloadId, gdy pobrany plik zostanie usunięty z historii.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (downloadId: number)=>void

    • downloadId

      Liczba