chrome.downloads

Opis

Interfejs API chrome.downloads służy do programowego inicjowania, monitorowania, modyfikowania i wyszukiwania plików do pobrania.

Uprawnienia

downloads

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

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

Przykłady

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

Typy

BooleanDelta

Właściwości

  • obecnie

    Wartość logiczna opcjonalna

  • wstecz

    Wartość logiczna opcjonalna

DangerType

plik

Nazwa pobieranego pliku jest podejrzana.

URL

Adres URL pobieranego pliku jest znany jako szkodliwy.

treść

Pobrany plik jest znany jako szkodliwy.

rzadko

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

host

Pobrano plik z hosta, który rozpowszechnia złośliwe pliki binarne i może być niebezpieczny.

niechciane

Pobieranie może być niechciane lub niebezpieczne. Na przykład: może wprowadzić zmiany w ustawieniach przeglądarki lub komputera.

bezpieczeństwo

Pobranie nie stwarza żadnego znanego zagrożenia dla komputera użytkownika.

zaakceptowano

Użytkownik wyraził zgodę na pobranie niebezpiecznego pliku.

Typ wyliczeniowy

"asyncScanning"

"asyncLocalPasswordScanning"

DoubleDelta

Właściwości

  • obecnie

    liczba opcjonalnie

  • wstecz

    liczba opcjonalnie

DownloadDelta

Właściwości

  • canResume

    BooleanDelta – opcjonalny

    Zmiana w polu canResume, o ile w ogóle miała miejsce.

  • zagrożenie

    StringDelta opcjonalnie

    Zmiana w polu danger, o ile w ogóle miała miejsce.

  • endTime

    StringDelta opcjonalnie

    Zmiana w polu endTime, o ile w ogóle miała miejsce.

  • błąd

    StringDelta opcjonalnie

    Zmiana w polu error, o ile w ogóle miała miejsce.

  • istnieje

    BooleanDelta – opcjonalny

    Zmiana w polu exists, o ile w ogóle miała miejsce.

  • fileSize

    Opcjonalny DoubleDelta

    Zmiana w polu fileSize, o ile w ogóle miała miejsce.

  • nazwa pliku

    StringDelta opcjonalnie

    Zmiana w polu filename, o ile w ogóle miała miejsce.

  • finalUrl

    StringDelta opcjonalnie

    Chrome w wersji 54 lub nowszej

    Zmiana w polu finalUrl, o ile w ogóle miała miejsce.

  • id

    liczba

    id z DownloadItem, które się zmieniły.

  • mim

    StringDelta opcjonalnie

    Zmiana w polu mime, o ile w ogóle miała miejsce.

  • wstrzymana

    BooleanDelta – opcjonalny

    Zmiana w polu paused, o ile w ogóle miała miejsce.

  • startTime

    StringDelta opcjonalnie

    Zmiana w polu startTime, o ile w ogóle miała miejsce.

  • stan

    StringDelta opcjonalnie

    Zmiana w polu state, o ile w ogóle miała miejsce.

  • totalBytes

    Opcjonalny DoubleDelta

    Zmiana w polu totalBytes, o ile w ogóle miała miejsce.

  • URL

    StringDelta opcjonalnie

    Zmiana w polu url, o ile w ogóle miała miejsce.

DownloadItem

Właściwości

  • byExtensionId

    ciąg znaków opcjonalny

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

  • byExtensionName

    ciąg znaków opcjonalny

    Zlokalizowana nazwa rozszerzenia, które zainicjowało to pobieranie, jeśli zostało zainicjowane przez rozszerzenie. Może ulec zmianie, jeśli nazwa rozszerzenia zmieni się lub użytkownik zmieni język.

  • bytesReceived

    liczba

    Liczba bajtów otrzymanych do tej pory z hosta bez uwzględnienia kompresji plików.

  • canResume

    wartość logiczna

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

  • zagrożenie

    DangerType

    Wskazanie, czy pobieranie jest uważane za bezpieczne lub znane jako podejrzane.

  • endTime

    ciąg znaków opcjonalny

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

  • błąd

    InterruptReason – opcjonalny

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

  • estimatedEndTime

    ciąg znaków opcjonalny

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

  • istnieje

    wartość logiczna

    Wskazuje, czy pobrany plik nadal istnieje. Te informacje mogą być nieaktualne, bo Chrome nie wykrywa automatycznie usuniętych plików. Aby uruchomić sprawdzanie obecności pliku, wywołaj search(). Jeśli plik został usunięty, po zakończeniu sprawdzania pojawi się zdarzenie onChanged. Pamiętaj, że funkcja search() nie czeka na zakończenie sprawdzania przed zwróceniem, więc wyniki z funkcji search() mogą nie odzwierciedlać dokładnie systemu plików. 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 nie jest znana.

  • nazwa pliku

    ciąg znaków

    Ścieżka bezwzględna lokalna.

  • finalUrl

    ciąg znaków

    Chrome w wersji 54 lub nowszej

    Bezwzględny adres URL, z którego pochodzi dane pobieranie, po wszystkich przekierowaniach.

  • id

    liczba

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

  • incognito

    wartość logiczna

    Wartość False, jeśli pobranie zostało zapisane w historii, wartość true (prawda), jeśli pobieranie nie zostanie zarejestrowane.

  • mim

    ciąg znaków

    Typ MIME pliku.

  • wstrzymana

    wartość logiczna

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

  • strona odsyłająca

    ciąg znaków

    Bezwzględny adres URL.

  • startTime

    ciąg znaków

    Godzina rozpoczęcia pobierania w formacie ISO 8601. Można przekazać bezpośrednio do konstruktora daty: 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 nie jest znana.

  • URL

    ciąg znaków

    Bezwzględny adres URL, z którego zainicjowano to pobieranie, przed jakimikolwiek przekierowaniami.

DownloadOptions

Właściwości

  • treść

    ciąg znaków opcjonalny

    Treść posta.

  • conflictAction

    Opcjonalny FilenameConflictAction

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

  • nazwa pliku

    ciąg znaków opcjonalny

    Ścieżka pliku względem katalogu Pobrane pliki, która może zawierać pobrany plik (prawdopodobnie zawiera podkatalogi). Ścieżki bezwzględne, puste i zawierające odwołania wsteczne „..”. spowoduje błąd. onDeterminingFilename umożliwia sugerowanie nazwy pliku po określeniu typu MIME i wstępnej nazwy pliku.

  • nagłówki

    HeaderNameValuePair[] opcjonalny

    Dodatkowe nagłówki HTTP, które mają być wysyłane razem 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 w żądaniu XMLHttpRequest.

  • method

    HttpMethod: opcjonalny

    Metoda HTTP używana, jeśli adres URL używa protokołu HTTP[S].

  • saveAs

    Wartość logiczna opcjonalna

    Użyj modułu wyboru plików, aby zezwolić użytkownikowi na wybór nazwy pliku niezależnie od tego, czy zasada filename jest ustawiona czy już istnieje.

  • URL

    ciąg znaków

    Adres URL pobierania.

DownloadQuery

Właściwości

  • bytesReceived

    liczba opcjonalnie

    Liczba bajtów otrzymanych do tej pory z hosta bez uwzględnienia kompresji plików.

  • zagrożenie

    DangerType opcjonalny

    Wskazanie, czy pobieranie jest uważane za bezpieczne lub znane jako podejrzane.

  • 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 podanej 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.

  • błąd

    InterruptReason – opcjonalny

    Przyczyny przerwania pobierania.

  • istnieje

    Wartość logiczna opcjonalna

    Wskazuje, czy pobrany plik istnieje.

  • fileSize

    liczba opcjonalnie

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

  • nazwa pliku

    ciąg znaków opcjonalny

    Ścieżka bezwzględna lokalna.

  • filenameRegex

    ciąg znaków opcjonalny

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

  • finalUrl

    ciąg znaków opcjonalny

    Chrome w wersji 54 lub nowszej

    Bezwzględny adres URL, z którego pochodzi dane pobieranie, po wszystkich przekierowaniach.

  • finalUrlRegex

    ciąg znaków opcjonalny

    Chrome w wersji 54 lub nowszej

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

  • id

    liczba opcjonalnie

    id z DownloadItem, którego ma dotyczyć zapytanie.

  • limit

    liczba opcjonalnie

    Zwrócono maksymalną liczbę pasujących wartości DownloadItem. Domyślna wartość to 1000. Aby zwrócić wszystkie pasujące wartości DownloadItem, ustaw wartość 0. Aby dowiedzieć się, jak przeglądać wyniki, otwórz search.

  • mim

    ciąg znaków opcjonalny

    Typ MIME pliku.

  • orderBy

    string[] opcjonalnie

    Aby posortować wyniki wyszukiwania, ustaw dla elementów tej tablicy właściwości DownloadItem. Na przykład ustawienie orderBy=['startTime'] sortuje listę DownloadItem w kolejności rosnącej. Aby określić kolejność malejącą, poprzedź prefiks myślnikiem: „-startTime”.

  • wstrzymana

    Wartość logiczna opcjonalna

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

  • zapytanie

    string[] opcjonalnie

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

  • 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 rozpoczęły się po podanej ms w formacie ISO 8601.

  • startedBefore

    ciąg znaków opcjonalny

    Ogranicza wyniki do DownloadItem, które w formacie ISO 8601 rozpoczęły się przed określoną ms.

  • stan

    Stan opcjonalny

    Wskazuje, czy pobieranie jest w toku, zostało 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 parametru DownloadItem, którego wartość totalBytes jest większa od podanej liczby całkowitej.

  • totalBytesLess

    liczba opcjonalnie

    Ogranicza wyniki do parametru DownloadItem, którego wartość totalBytes jest mniejsza od podanej liczby całkowitej.

  • URL

    ciąg znaków opcjonalny

    Bezwzględny adres URL, z którego zainicjowano to pobieranie, przed jakimikolwiek przekierowaniami.

  • urlRegex

    ciąg znaków opcjonalny

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

FilenameConflictAction

uniwersytecki

Aby uniknąć duplikowania, wartość w polu filename zostaje zmieniona tak, by zawierała licznik przed rozszerzeniem nazwy pliku.

zastąpić

Istniejący plik zostanie zastąpiony nowym.

prompt

Pojawi się okno wyboru plików.

Typ wyliczeniowy

FilenameSuggestion

Właściwości

  • conflictAction

    Opcjonalny FilenameConflictAction

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

  • nazwa pliku

    ciąg znaków

    Nowy element docelowy DownloadItem.filename elementu DownloadItem, jako ścieżka względem domyślnego katalogu pobierania użytkownika, prawdopodobnie zawierającego podkatalogi. Ścieżki bezwzględne, puste i zawierające odwołania wsteczne „..”. zostanie zignorowany. Wartość filename jest ignorowana, jeśli istnieją detektory onDeterminingFilename zarejestrowane przez jakiekolwiek rozszerzenia.

GetFileIconOptions

Właściwości

  • rozmiar

    liczba opcjonalnie

    Rozmiar zwróconej ikony. Będzie ona kwadratowa i będzie miała wymiary: rozmiar * rozmiar w pikselach. Domyślny i największy rozmiar ikony to 32 x 32 piksele. Jedyne obsługiwane rozmiary to 16 i 32. Podanie innego rozmiaru jest błędem.

HeaderNameValuePair

Właściwości

  • nazwa

    ciąg znaków

    Nazwa nagłówka HTTP.

  • wartość

    ciąg znaków

    Wartość nagłówka HTTP.

HttpMethod

Typ wyliczeniowy

InterruptReason

Typ wyliczeniowy

State

in_progress

Pobieranie aktualnie odbiera dane z serwera.

przerwano

Błąd zerwał połączenie z hostem pliku.

zakończono

Pobieranie zostało zakończone.

Typ wyliczeniowy

StringDelta

Właściwości

  • obecnie

    ciąg znaków opcjonalny

  • wstecz

    ciąg znaków opcjonalny

UiOptions

Chrome w wersji 105 lub nowszej

Właściwości

  • włączone

    wartość logiczna

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

Metody

acceptDanger()

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

wyświetlać użytkownikowi prośbę o zaakceptowanie niebezpiecznego pliku do pobrania; Można je wywołać tylko z widocznego kontekstu (na karcie, w oknie lub w wyskakującym okienku z działaniami na stronie bądź przeglądarce). Nie akceptuje automatycznie pobierania 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, a pobranie nie będzie niebezpieczne lub zagrożenie zostało zaakceptowane, nazwa pliku tymczasowego zostanie zmieniona na nazwę docelową, plik state zmieni się na „complete”, a następnie uruchomi się onChanged.

Parametry

  • downloadId

    liczba

    Identyfikator elementu DownloadItem.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

cancel()

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

Anuluj pobieranie. Po uruchomieniu callback pobieranie zostaje anulowane, zakończone, przerwane lub już nie istnieje.

Parametry

  • downloadId

    liczba

    Identyfikator pliku do anulowania.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane 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 zawiera wszystkie pliki cookie ustawione obecnie dla jego nazwy hosta. Jeśli określisz zarówno filename, jak i saveAs, wyświetli się okno Zapisz jako ze wstępnie uzupełnioną wartością filename. Jeśli pobieranie się rozpoczęło, funkcja callback zostanie wywołana z nowym identyfikatorem downloadId DownloadItem. Jeśli podczas rozpoczynania pobierania wystąpił błąd, funkcja callback zostanie wywołana z parametrem downloadId=undefined, a runtime.lastError będzie zawierać ciąg opisowy. Nie ma gwarancji, że ciągi znaków z błędami pozostaną zgodne wstecznie w różnych wersjach. Rozszerzenia nie mogą go analizować.

Parametry

  • Co i jak pobrać.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (downloadId: number) => void

    • downloadId

      liczba

Zwroty

  • Promise<number>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane 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ący plik DownloadItem bez usuwania pobranego pliku. Zdarzenie onErased będzie wywoływane za każdym razem, gdy DownloadItem pasuje do parametru query, a następnie zostanie wywołane zdarzenie callback.

Parametry

  • zapytanie

    DownloadQuery

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (erasedIds: number[]) => void

    • erasedIds

      liczba[]

Zwroty

  • Promise<number[]>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

getFileIcon()

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

Pobranie ikony określonego pobierania. W przypadku nowo pobranych plików ikony plików są dostępne po odebraniu zdarzenia onCreated. Obraz zwracany 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 można pobrać ikonę z wykorzystaniem zapytania do systemu operacyjnego lub zestawu narzędzi. Zwracana ikona zależy więc od kilku 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, ikona runtime.lastError zawiera komunikat o błędzie.

Parametry

  • downloadId

    liczba

    Identyfikator pobierania.

  • Opcje

    Opcjonalne GetFileIconOptions

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (iconURL?: string) => void

    • iconURL

      ciąg znaków opcjonalny

Zwroty

  • Promise<string | niezdefiniowane>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

open()

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

Jeśli proces DownloadItem jest zakończony, otwiera pobrany plik. w przeciwnym razie zwraca błąd do runtime.lastError. Ta metoda wymaga uprawnienia "downloads.open" oraz uprawnienia "downloads". Zdarzenie onChanged jest uruchamiane przy pierwszym otwarciu elementu. Tę metodę można wywołać tylko w odpowiedzi na gest użytkownika.

Parametry

  • downloadId

    liczba

    Identyfikator pobranego pliku.

  • wywołanie zwrotne

    funkcja optional

    Chrome w wersji 123 lub nowszej

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Promise<void>

    Chrome w wersji 123 lub nowszej

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane 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 będzie zawierać komunikat o błędzie. Jeśli pobieranie nie będzie aktywne, żądanie zakończy się niepowodzeniem.

Parametry

  • downloadId

    liczba

    Identyfikator pobierania do wstrzymania.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane 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 gotowy. w przeciwnym razie zwraca błąd do runtime.lastError.

Parametry

  • downloadId

    liczba

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

resume()

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

Wznowienie wstrzymanego pobierania. Jeśli żądanie zostało zrealizowane, pobieranie jest w toku i zostało wznowione. W przeciwnym razie runtime.lastError będzie zawierać komunikat o błędzie. Jeśli pobieranie nie będzie aktywne, żądanie zakończy się niepowodzeniem.

Parametry

  • downloadId

    liczba

    Identyfikator pobierania do wznowienia.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

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

Znajdź DownloadItem. Aby uzyskać wszystkie dane z DownloadItem, ustaw query na pusty obiekt. Aby uzyskać konkretną wartość DownloadItem, ustaw tylko pole id. Aby przeglądać dużą liczbę elementów, ustaw orderBy: ['-startTime'], ustaw limit na liczbę elementów na stronę, a startedAfter na wartość startTime ostatniego elementu na ostatniej stronie.

Parametry

Zwroty

  • Promise<DownloadItem[]>

    Chrome 96 lub nowszy

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

setShelfEnabled()

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

Zamiast niego 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, jeśli wyłączy ją co najmniej 1 rozszerzenie. Włączenie półki, gdy co najmniej 1 inne rozszerzenie będzie wyłączone, spowoduje zwrócenie błędu do runtime.lastError. Wymaga uprawnienia "downloads.shelf" oprócz uprawnienia "downloads".

Parametry

  • włączone

    wartość logiczna

setUiOptions()

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

Zmień interfejs pobierania każdego okna powiązanego z bieżącym profilem przeglądarki. Dopóki co najmniej jedno rozszerzenie będzie miało wartość UiOptions.enabled jako fałsz, interfejs pobierania będzie ukryty. Jeśli zasada UiOptions.enabled ma wartość Prawda, gdy co najmniej 1 inne rozszerzenie jest wyłączone, spowoduje to zwrócenie błędu do runtime.lastError. Wymaga uprawnienia "downloads.ui" oprócz uprawnienia "downloads".

Parametry

  • Opcje

    UiOptions

    Umieść zmianę w interfejsie pobierania.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Promise<void>

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

show()

chrome.downloads.show(
  downloadId: number,
)

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

Parametry

  • downloadId

    liczba

    Identyfikator pobranego pliku.

showDefaultFolder()

chrome.downloads.showDefaultFolder()

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

Wydarzenia

onChanged

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

Gdy zmieni się dowolna z właściwości DownloadItem oprócz bytesReceived i estimatedEndTime, zdarzenie to zostanie uruchomione z elementem downloadId i obiektem zawierającym zmienione właściwości.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (downloadDelta: DownloadDelta) => void

onCreated

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

To zdarzenie jest uruchamiane 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 ustalania nazwy pliku rozszerzenia będą miały możliwość zastąpienia docelowej DownloadItem.filename. Każde rozszerzenie może rejestrować tylko jeden 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łuje synchronicznie funkcji suggest ani nie zwraca parametru true, funkcja suggest zostanie wywołana automatycznie. Zadanie DownloadItem nie zostanie ukończone, dopóki wszyscy słuchacze nie wywołają suggest. Detektory mogą wywołać funkcję suggest bez żadnych argumentów, aby umożliwić pobieranym plikom użycie downloadItem.filename, lub przekazać obiekt suggestion do suggest w celu zastąpienia docelowej nazwy pliku. Jeśli nazwę pliku zastępuje więcej niż 1 rozszerzenie, wygrywa ostatnie zainstalowane rozszerzenie, którego detektor przekazuje obiekt suggestion do suggest. Aby uniknąć nieporozumień, które rozszerzenie wygra, użytkownicy nie powinni instalować rozszerzeń, które mogą powodować konflikty. Jeśli pobieranie zostało zainicjowane przez download, a nazwa pliku docelowego jest znana przed określeniem typu MIME i tymczasowej nazwy pliku, przekaż filename do download.

Parametry

onErased

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

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

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (downloadId: number) => void

    • downloadId

      liczba