browser.downloads

Opis

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

Uprawnienia

downloads

Aby korzystać z tego interfejsu API, musisz zadeklarować uprawnienie "downloads" w pliku manifestu rozszerzenia.

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

Przykłady

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

Typy

BooleanDelta

Właściwości

  • obecnie

    wartość logiczna opcjonalna

  • wstecz

    wartość logiczna opcjonalna

DangerType

Typ wyliczeniowy

„file”
Nazwa pobranego pliku jest podejrzana.

„url”
Adres URL pobierania jest znany jako złośliwy.

„content”
Pobrany plik jest znany jako złośliwy.

„rzadko pobierany”
Adres URL pobieranego pliku jest rzadko pobierany i może być niebezpieczny.

„host”
Plik został pobrany z hosta, który rozpowszechnia szkodliwe pliki binarne i jest prawdopodobnie niebezpieczny.

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

„bezpieczny”
Pobieranie nie stanowi znanego zagrożenia dla komputera użytkownika.

„accepted”
Użytkownik zaakceptował niebezpieczne pobieranie.

„allowlistedByPolicy”
Wartości związane z przedsiębiorstwem.

"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 opcjonalny

  • wstecz

    number opcjonalny

DownloadDelta

Właściwości

  • canResume

    BooleanDelta opcjonalny

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

  • zagrożenie,

    StringDelta opcjonalnie

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

  • endTime

    StringDelta opcjonalnie

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

  • błąd

    StringDelta opcjonalnie

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

  • istnieje

    BooleanDelta opcjonalny

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

  • fileSize

    DoubleDelta opcjonalny

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

  • nazwa pliku

    StringDelta opcjonalnie

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

  • finalUrl

    StringDelta opcjonalnie

    Chrome 54 lub nowsza

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

  • id

    liczba

    id elementu DownloadItem, który uległ zmianie.

  • mim

    StringDelta opcjonalnie

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

  • wstrzymana

    BooleanDelta opcjonalny

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

  • startTime

    StringDelta opcjonalnie

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

  • stan

    StringDelta opcjonalnie

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

  • totalBytes

    DoubleDelta opcjonalny

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

  • URL

    StringDelta opcjonalnie

    Zmiana wartości 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 to pobieranie, jeśli zostało ono 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ść „true”, jeśli pobieranie jest w trakcie i zostało wstrzymane lub przerwane i można je wznowić od miejsca, w którym zostało przerwane.

  • zagrożenie,

    DangerType

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

  • endTime

    ciąg znaków opcjonalny

    Godzina zakończenia pobierania w formacie ISO 8601. Można go 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

    Dlaczego pobieranie zostało przerwane. Kilka rodzajów błędów HTTP może być zgrupowanych w jednym z błędów zaczynających się od symbolu 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 go 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 uruchomić sprawdzanie, czy plik istnieje. Po zakończeniu sprawdzania, czy plik istnieje, jeśli został on usunięty, zostanie wywołane zdarzenie onChanged. Pamiętaj, że funkcja search() nie czeka na zakończenie sprawdzania istnienia pliku przed zwróceniem wyniku, więc wyniki 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

    Bezwzględny URL, z którego pobierany jest plik, po wszystkich przekierowaniach.

  • id

    liczba

    Identyfikator, który jest stały w różnych sesjach przeglądarki.

  • incognito

    wartość logiczna

    Fałsz, jeśli to pobieranie jest zapisane w historii, prawda, 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

    Godzina rozpoczęcia pobierania w formacie ISO 8601. Można go 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ędnienia kompresji lub -1, jeśli jest nieznana.

  • URL

    tekst

    Bezwzględny adres URL, z którego rozpoczęło się 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ę znajdować pobrany plik. Może zawierać podkatalogi. Ścieżki bezwzględne, puste i zawierające odwołania wsteczne „..” spowodują błąd. onDeterminingFilename umożliwia sugerowanie nazwy pliku po określeniu typu MIME pliku i wstępnej nazwy pliku.

  • nagłówki,

    HeaderNameValuePair[] opcjonalnie

    Dodatkowe nagłówki HTTP, które mają zostać wysłane wraz 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, które są dozwolone przez XMLHttpRequest.

  • method

    HttpMethod opcjonalne

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

  • saveAs

    wartość logiczna opcjonalna

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

  • URL

    tekst

    Adres URL do pobrania.

DownloadQuery

Właściwości

  • bytesReceived

    number opcjonalny

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

  • zagrożenie,

    DangerType opcjonalny

    Wskazuje, czy pobierany plik jest uważany 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 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

    Przyczyny przerwania pobierania.

  • istnieje

    wartość logiczna opcjonalna

    czy pobrany plik istnieje;

  • fileSize

    number opcjonalny

    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 danego wyrażenia regularnego.

  • finalUrl

    ciąg znaków opcjonalny

    Chrome 54 lub nowsza

    Bezwzględny URL, z którego pobierany jest plik, po wszystkich przekierowaniach.

  • finalUrlRegex

    ciąg znaków opcjonalny

    Chrome 54 lub nowsza

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

  • id

    number opcjonalny

    id DownloadItem, o które chcesz wysłać zapytanie.

  • limit

    number opcjonalny

    Maksymalna liczba zwracanych pasujących DownloadItem. Domyślna wartość to 1000. Ustaw wartość 0, aby zwrócić wszystkie pasujące elementy DownloadItem. Więcej informacji o przeglądaniu wyników znajdziesz w sekcji search.

  • mim

    ciąg znaków opcjonalny

    Typ MIME pliku.

  • orderBy

    string[] opcjonalnie

    Ustaw elementy tej tablicy na właściwości DownloadItem, aby posortować wyniki wyszukiwania. Na przykład ustawienie orderBy=['startTime'] powoduje posortowanie elementów DownloadItem według czasu rozpoczęcia w kolejności rosnącej. Aby określić kolejność malejącą, dodaj na początku myślnik: „-startTime”.

  • wstrzymana

    wartość logiczna opcjonalna

    Wartość „true”, 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 DownloadItem, których filename lub url lub finalUrl zawierają wszystkie wyszukiwane hasła, które nie zaczynają się od myślnika „-”, i żadne wyszukiwane hasła, 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 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 opcjonalny

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

  • totalBytesGreater

    number opcjonalny

    Ogranicza wyniki do DownloadItem, których totalBytes jest większe od podanej liczby całkowitej.

  • totalBytesLess

    number opcjonalny

    Ogranicza wyniki do DownloadItem, których totalBytes jest mniejsze od podanej liczby całkowitej.

  • URL

    ciąg znaków opcjonalny

    Bezwzględny adres URL, z którego rozpoczęło się pobieranie, przed przekierowaniami.

  • urlRegex

    ciąg znaków opcjonalny

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

FilenameConflictAction

nadawać unikalność,

Aby uniknąć duplikowania, znak filename jest zmieniany tak, aby przed rozszerzeniem nazwy pliku zawierał licznik.

zastąpić

Istniejący plik zostanie zastąpiony nowym.

prompt

Użytkownikowi zostanie wyświetlone okno wyboru plików.

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 cel DownloadItem.filename DownloadItem jako ścieżka względna do domyślnego katalogu pobierania użytkownika, która może zawierać podkatalogi. Ścieżki bezwzględne, puste ścieżki i ścieżki zawierające odwołania wsteczne „..” będą ignorowane. filename jest ignorowany, jeśli jakiekolwiek rozszerzenia zarejestrują detektory onDeterminingFilename.

GetFileIconOptions

Właściwości

  • rozmiar

    number opcjonalny

    Rozmiar zwróconej ikony. Ikona będzie kwadratem o wymiarach rozmiar × rozmiar pikseli. Domyślny i największy rozmiar ikony to 32 x 32 piksele. Obsługiwane są tylko rozmiary 16 i 32. Określenie innego rozmiaru jest błędem.

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 danych z serwera jest w toku.

przerwane,

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

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

Właściwości

  • aktywne

    wartość logiczna

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

Metody

acceptDanger()

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

Poproś użytkownika o zaakceptowanie niebezpiecznego pobierania. Można go wywołać tylko w widocznym kontekście (karta, okno lub wyskakujące okienko działania strony/przeglądarki). Nie akceptuje automatycznie niebezpiecznych pobrań. 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 i pobieranie nie jest niebezpieczne lub użytkownik zaakceptuje ryzyko, plik tymczasowy zostanie przemianowany na nazwę pliku docelowego, stan state zmieni się na „complete” i zostanie wywołane zdarzenie onChanged.

Parametry

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

    Zwraca obiekt Promise, który jest rozwiązywany po zamknięciu okna z ostrzeżeniem o zagrożeniu.

cancel()

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

anulować pobieranie, Gdy uruchomienie callback jest w toku, pobieranie jest anulowane, kończy się, zostaje przerwane lub już nie istnieje.

Parametry

  • downloadId

    liczba

    Identyfikator pobierania do anulowania.

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

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

download()

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

Pobierz adres URL. Jeśli adres URL korzysta z protokołu HTTP[S], żądanie będzie zawierać wszystkie pliki cookie ustawione obecnie dla jego nazwy hosta. Jeśli określono zarówno parametr filename, jak i saveAs, wyświetli się okno Zapisz jako, wstępnie wypełnione podaną wartością filename. Jeśli pobieranie rozpoczęło się prawidłowo, funkcja callback zostanie wywołana z nowym identyfikatorem DownloadItem – downloadId. Jeśli podczas uruchamiania pobierania wystąpił błąd, wywoływana jest funkcja callback z argumentami downloadId=undefined i runtime.lastError zawierającymi ciąg tekstowy z opisem. Nie ma gwarancji, że ciągi błędów będą zgodne wstecznie między wersjami. Rozszerzenia nie mogą go analizować.

Parametry

Zwroty

  • Promise<number>

    Chrome 96 lub nowsza

    Zwraca obietnicę, która jest spełniana z identyfikatorem nowego DownloadItem.

erase()

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

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

Parametry

Zwroty

  • Promise<number[]>

    Chrome 96 lub nowsza

getFileIcon()

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

Pobieranie ikony określonego pobranego pliku. W przypadku nowych pobrań ikony plików są dostępne po otrzymaniu zdarzenia onCreated. Obraz zwracany przez tę funkcję podczas pobierania może różnić się od obrazu zwracanego po zakończeniu pobierania. Pobieranie ikon odbywa się przez wysyłanie zapytań do systemu operacyjnego lub zestawu narzędzi w zależności od platformy. 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, w obiekcie runtime.lastError pojawi się komunikat o błędzie.

Parametry

Zwroty

  • Promise<string | undefined>

    Chrome 96 lub nowsza

    Zwraca obiekt Promise, który jest rozwiązywany z adresem URL obrazu reprezentującego pobieranie.

open()

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

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

Parametry

  • downloadId

    liczba

    Identyfikator pobranego pliku.

Zwroty

  • Promise<void>

    Chrome 123 lub nowsza

pause()

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

Wstrzymaj pobieranie. Jeśli żądanie zostało zrealizowane, pobieranie jest wstrzymane. W przeciwnym razie zmienna runtime.lastError zawiera komunikat o błędzie. Jeśli pobieranie nie jest aktywne, żądanie zakończy się niepowodzeniem.

Parametry

  • downloadId

    liczba

    Identyfikator pobierania do wstrzymania.

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

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

removeFile()

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

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

Parametry

  • downloadId

    liczba

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

resume()

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

wznowić wstrzymane pobieranie; Jeśli prośba została rozpatrzona pozytywnie, pobieranie jest w toku i nie jest wstrzymane. W przeciwnym razie zmienna runtime.lastError zawiera komunikat o błędzie. Jeśli pobieranie nie jest aktywne, żądanie zakończy się niepowodzeniem.

Parametry

  • downloadId

    liczba

    Identyfikator pobierania, które ma zostać wznowione.

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

    Zwraca obietnicę, która zostanie spełniona po zakończeniu prośby o wznowienie.

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

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

Parametry

Zwroty

setShelfEnabled()

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

Zamiast niej używaj setUiOptions.

Włącz lub wyłącz szary pasek 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" oprócz uprawnienia "downloads".

Parametry

  • aktywne

    wartość logiczna

setUiOptions()

Chrome 105 lub nowsza 
chrome.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

Zmienia interfejs pobierania w każdym oknie powiązanym z bieżącym profilem przeglądarki. Dopóki co najmniej jedno rozszerzenie ma ustawioną wartość UiOptions.enabled na false, interfejs pobierania będzie ukryty. Ustawienie wartości UiOptions.enabled na „true”, gdy co najmniej jedno inne rozszerzenie ma wyłączoną tę funkcję, spowoduje zwrócenie błędu przez runtime.lastError. Wymaga uprawnienia "downloads.ui" oprócz uprawnienia "downloads".

Parametry

  • Opcje

    UiOptions

    Obejmuje zmianę interfejsu pobierania.

Zwroty

  • Promise<void>

    Zwraca obiekt Promise, który zostanie spełniony po zakończeniu aktualizacji interfejsu.

show()

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

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

Parametry

  • downloadId

    liczba

    Identyfikator pobranego pliku.

showDefaultFolder()

chrome.downloads.showDefaultFolder(): void

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

Wydarzenia

onChanged

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

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

Parametry

onCreated

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

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

Parametry

onDeterminingFilename

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

Podczas określania nazwy pliku rozszerzenia będą mogły zastąpić docelowy DownloadItem.filename. Każde rozszerzenie może zarejestrować co najwyżej 1 odbiorcę tego zdarzenia. Każdy odbiorca musi wywołać funkcję suggest dokładnie raz, synchronicznie lub asynchronicznie. Jeśli odbiorca wywołuje suggest asynchronicznie, musi zwrócić wartość true. Jeśli odbiorca nie wywoła synchronicznie funkcji suggest ani nie zwróci wartości true, funkcja suggest zostanie wywołana automatycznie. DownloadItem nie zostanie ukończone, dopóki wszyscy słuchacze nie zadzwonią pod numer suggest. Słuchacze mogą wywołać funkcję suggest bez argumentów, aby umożliwić pobieranie z użyciem downloadItem.filename jako nazwy pliku, lub przekazać obiekt suggestion do funkcji suggest, aby zastąpić docelową nazwę pliku. Jeśli więcej niż 1 rozszerzenie zastępuje nazwę pliku, wygrywa ostatnie zainstalowane rozszerzenie, którego odbiornik przekazuje obiekt suggestion do suggest. Aby uniknąć nieporozumień dotyczących tego, które rozszerzenie będzie działać, użytkownicy nie powinni instalować rozszerzeń, które mogą ze sobą kolidować. Jeśli pobieranie jest inicjowane 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,
)

Wywoływane z parametrem downloadId, gdy pobieranie zostanie usunięte z historii.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

    (downloadId: number) => void

    • downloadId

      liczba