chrome.downloads

Deskripsi

Gunakan chrome.downloads API untuk memulai, memantau, memanipulasi, dan menelusuri download secara terprogram.

Izin

downloads

Anda harus mendeklarasikan izin "downloads" di manifes ekstensi untuk menggunakan API ini.

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

Contoh

Anda dapat menemukan contoh sederhana tentang penggunaan API chrome.downloads dalam examples/api/downloads saat ini. Untuk contoh lainnya dan bantuan dalam melihat kode sumber, lihat Contoh.

Jenis

BooleanDelta

Properti

  • current

    boolean opsional

  • sebelumnya

    boolean opsional

DangerType

file

Nama file download mencurigakan.

url

URL download diketahui berbahaya.

konten

File yang didownload diketahui berbahaya.

tidak umum

URL download tidak biasa didownload dan mungkin berbahaya.

host

Download berasal dari host yang diketahui mendistribusikan biner berbahaya dan kemungkinan berbahaya.

tidak diinginkan

Download mungkin tidak diinginkan atau tidak aman. Mis. itu dapat membuat perubahan pada pengaturan browser atau komputer.

aman

Hasil download tidak menimbulkan bahaya yang diketahui terhadap komputer pengguna.

diterima

Pengguna telah menerima download berbahaya.

Enum

"file"

"url"

"konten"

"tidak umum"

"host"

"tidak diinginkan"

"aman"

"diterima"

"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepScannedOpenedada"

"promptForPemindaian"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

DoubleDelta

Properti

  • current

    angka opsional

  • sebelumnya

    angka opsional

DownloadDelta

Properti

  • canResume

    BooleanDelta opsional

    Perubahan dalam canResume, jika ada.

  • bahaya

    StringDelta opsional

    Perubahan dalam danger, jika ada.

  • endTime

    StringDelta opsional

    Perubahan dalam endTime, jika ada.

  • error

    StringDelta opsional

    Perubahan dalam error, jika ada.

  • ada

    BooleanDelta opsional

    Perubahan dalam exists, jika ada.

  • fileSize

    DoubleDelta opsional

    Perubahan dalam fileSize, jika ada.

  • filename

    StringDelta opsional

    Perubahan dalam filename, jika ada.

  • finalUrl

    StringDelta opsional

    Chrome 54 dan yang lebih baru

    Perubahan dalam finalUrl, jika ada.

  • id

    angka

    id dari DownloadItem yang berubah.

  • pantomim

    StringDelta opsional

    Perubahan dalam mime, jika ada.

  • dijeda

    BooleanDelta opsional

    Perubahan dalam paused, jika ada.

  • startTime

    StringDelta opsional

    Perubahan dalam startTime, jika ada.

  • dengan status tersembunyi akhir

    StringDelta opsional

    Perubahan dalam state, jika ada.

  • totalBytes

    DoubleDelta opsional

    Perubahan dalam totalBytes, jika ada.

  • url

    StringDelta opsional

    Perubahan dalam url, jika ada.

DownloadItem

Properti

  • byExtensionId

    string opsional

    ID untuk ekstensi yang memulai download ini jika download ini dimulai oleh ekstensi. Tidak berubah setelah disetel.

  • byExtensionName

    string opsional

    Nama ekstensi yang dilokalkan yang memulai download ini jika download ini dimulai oleh ekstensi. Dapat berubah jika ekstensi mengubah namanya atau jika pengguna mengubah lokalnya.

  • bytesReceived

    angka

    Jumlah byte yang diterima sejauh ini dari host, tanpa mempertimbangkan kompresi file.

  • canResume

    boolean

    Benar jika download sedang berlangsung dan dijeda, atau jika download terganggu dan dapat dilanjutkan mulai dari bagian yang terhenti.

  • bahaya

    Indikasi apakah download ini dianggap aman atau diketahui mencurigakan.

  • endTime

    string opsional

    Waktu download berakhir dalam format ISO 8601. Dapat diteruskan langsung ke konstruktor Tanggal: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

  • error

    InterruptReason opsional

    Alasan download terganggu. Beberapa jenis error HTTP dapat dikelompokkan dalam salah satu error yang diawali dengan SERVER_. Error yang terkait dengan jaringan dimulai dengan NETWORK_, error yang terkait dengan proses penulisan file ke sistem file dimulai dengan FILE_, dan gangguan yang dimulai oleh pengguna dimulai dengan USER_.

  • estimatedEndTime

    string opsional

    Perkiraan waktu saat download akan selesai dalam format ISO 8601. Dapat diteruskan langsung ke konstruktor Tanggal: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

  • ada

    boolean

    Apakah file yang didownload masih ada atau tidak. Informasi ini mungkin sudah tidak berlaku karena Chrome tidak otomatis mengawasi penghapusan file. Panggil search() untuk memicu pemeriksaan keberadaan file. Setelah pemeriksaan keberadaan selesai, jika file telah dihapus, peristiwa onChanged akan diaktifkan. Perhatikan bahwa search() tidak menunggu pemeriksaan keberadaan selesai sebelum ditampilkan, sehingga hasil dari search() mungkin tidak mencerminkan sistem file secara akurat. Selain itu, search() dapat dipanggil sesering yang diperlukan, tetapi tidak akan memeriksa keberadaan file lebih sering dari sekali setiap 10 detik.

  • fileSize

    angka

    Jumlah byte di seluruh file pasca-dekompresi, atau -1 jika tidak diketahui.

  • filename

    string

    Jalur lokal absolut.

  • finalUrl

    string

    Chrome 54 dan yang lebih baru

    URL mutlak yang menjadi asal download ini, setelah semua pengalihan.

  • id

    angka

    ID yang persisten di seluruh sesi browser.

  • samaran

    boolean

    Salah jika download ini direkam dalam histori, benar jika tidak direkam.

  • pantomim

    string

    Jenis MIME file.

  • dijeda

    boolean

    True jika download telah berhenti membaca data dari host, tetapi membuat koneksi tetap terbuka.

  • perujuk

    string

    URL mutlak.

  • startTime

    string

    Waktu download dimulai dalam format ISO 8601. Dapat diteruskan langsung ke konstruktor Tanggal: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • dengan status tersembunyi akhir

    Menunjukkan apakah download sedang berlangsung, terhenti, atau selesai.

  • totalBytes

    angka

    Jumlah byte dalam keseluruhan file, tanpa mempertimbangkan kompresi file, atau -1 jika tidak diketahui.

  • url

    string

    URL mutlak yang menjadi tempat download ini dimulai, sebelum pengalihan apa pun.

DownloadOptions

Properti

  • body

    string opsional

    Isi postingan.

  • conflictAction

    Tindakan yang akan dilakukan jika filename sudah ada.

  • filename

    string opsional

    Jalur file yang terkait dengan direktori Download untuk memuat file yang didownload, yang mungkin berisi subdirektori. Jalur absolut, jalur kosong, dan jalur yang berisi referensi balik ".." akan menyebabkan error. onDeterminingFilename memungkinkan saran nama file setelah jenis MIME file dan nama file tentatif telah ditentukan.

  • headers

    Header HTTP tambahan yang akan dikirim dengan permintaan jika URL menggunakan protokol HTTP. Setiap header direpresentasikan sebagai kamus yang berisi kunci name dan value atau binaryValue, yang dibatasi pada yang diizinkan oleh XMLHttpRequest.

  • method

    HttpMethod opsional

    Metode HTTP yang akan digunakan jika URL menggunakan protokol HTTP[S].

  • saveAs

    boolean opsional

    Gunakan pemilih file untuk memungkinkan pengguna memilih nama file, terlepas dari apakah filename sudah disetel atau sudah ada.

  • url

    string

    URL yang akan didownload.

DownloadQuery

Properti

  • bytesReceived

    angka opsional

    Jumlah byte yang diterima sejauh ini dari host, tanpa mempertimbangkan kompresi file.

  • bahaya

    DangerType opsional

    Indikasi apakah download ini dianggap aman atau diketahui mencurigakan.

  • endTime

    string opsional

    Waktu download berakhir dalam format ISO 8601.

  • endedAfter

    string opsional

    Membatasi hasil ke DownloadItem yang berakhir setelah milidetik tertentu dalam format ISO 8601

  • endedBefore

    string opsional

    Membatasi hasil ke DownloadItem yang berakhir sebelum milidetik tertentu dalam format ISO 8601.

  • error

    InterruptReason opsional

    Alasan download terganggu.

  • ada

    boolean opsional

    Apakah file yang didownload ada atau tidak;

  • fileSize

    angka opsional

    Jumlah byte di seluruh file pasca-dekompresi, atau -1 jika tidak diketahui.

  • filename

    string opsional

    Jalur lokal absolut.

  • filenameRegex

    string opsional

    Membatasi hasil ke DownloadItem yang filename-nya cocok dengan ekspresi reguler yang diberikan.

  • finalUrl

    string opsional

    Chrome 54 dan yang lebih baru

    URL mutlak yang menjadi asal download ini, setelah semua pengalihan.

  • finalUrlRegex

    string opsional

    Chrome 54 dan yang lebih baru

    Membatasi hasil ke DownloadItem yang finalUrl-nya cocok dengan ekspresi reguler yang diberikan.

  • id

    angka opsional

    id dari DownloadItem yang akan dikueri.

  • batas

    angka opsional

    Jumlah maksimum DownloadItem yang cocok yang ditampilkan. Default-nya adalah 1.000. Tetapkan ke 0 untuk menampilkan semua DownloadItem yang cocok. Lihat search untuk mengetahui cara melihat halaman melalui hasil.

  • pantomim

    string opsional

    Jenis MIME file.

  • orderBy

    string[] opsional

    Tetapkan elemen array ini ke properti DownloadItem untuk mengurutkan hasil penelusuran. Misalnya, menyetel orderBy=['startTime'] akan mengurutkan DownloadItem berdasarkan waktu mulainya dalam urutan menaik. Untuk menentukan urutan menurun, awali dengan tanda hubung: '-startTime'.

  • dijeda

    boolean opsional

    True jika download telah berhenti membaca data dari host, tetapi membuat koneksi tetap terbuka.

  • kueri

    string[] opsional

    Array istilah penelusuran ini membatasi hasil untuk DownloadItem yang filename atau url atau finalUrl-nya berisi semua istilah penelusuran yang tidak dimulai dengan tanda hubung '-' dan tidak ada istilah pencarian yang dimulai dengan tanda hubung.

  • startTime

    string opsional

    Waktu download dimulai dalam format ISO 8601.

  • startedAfter

    string opsional

    Membatasi hasil ke DownloadItem yang dimulai setelah milidetik tertentu dalam format ISO 8601.

  • startedBefore

    string opsional

    Membatasi hasil ke DownloadItem yang dimulai sebelum milidetik tertentu dalam format ISO 8601.

  • dengan status tersembunyi akhir

    Negara bagian opsional

    Menunjukkan apakah download sedang berlangsung, terhenti, atau selesai.

  • totalBytes

    angka opsional

    Jumlah byte dalam keseluruhan file, tanpa mempertimbangkan kompresi file, atau -1 jika tidak diketahui.

  • totalBytesGreater

    angka opsional

    Membatasi hasil ke DownloadItem yang totalBytes-nya lebih besar dari bilangan bulat yang diberikan.

  • totalBytesLess

    angka opsional

    Membatasi hasil ke DownloadItem yang totalBytes-nya lebih kecil dari bilangan bulat yang diberikan.

  • url

    string opsional

    URL mutlak yang menjadi tempat download ini dimulai, sebelum pengalihan apa pun.

  • urlRegex

    string opsional

    Membatasi hasil ke DownloadItem yang url-nya cocok dengan ekspresi reguler yang diberikan.

FilenameConflictAction

seragam

Untuk menghindari duplikasi, filename diubah untuk menyertakan penghitung sebelum ekstensi nama file.

timpa

File yang ada akan ditimpa dengan file baru.

perintah

Pengguna akan melihat dialog pemilih file.

Enum

"uniquify"

"timpa"

"perintah"

FilenameSuggestion

Properti

  • conflictAction

    Tindakan yang akan dilakukan jika filename sudah ada.

  • filename

    string

    Target baru DownloadItem DownloadItem.filename, sebagai jalur yang terkait dengan direktori Download default pengguna, mungkin berisi subdirektori. Jalur absolut, jalur kosong, dan jalur yang berisi referensi balik ".." akan diabaikan. filename akan diabaikan jika ada pemroses onDeterminingFilename yang didaftarkan oleh ekstensi apa pun.

GetFileIconOptions

Properti

  • ukuran

    angka opsional

    Ukuran ikon yang ditampilkan. Ikon akan berbentuk persegi dengan dimensi ukuran * piksel ukuran. Ukuran default dan terbesar untuk ikon adalah 32x32 piksel. Satu-satunya ukuran yang didukung adalah 16 dan 32. Terjadi error saat menentukan ukuran lainnya.

HeaderNameValuePair

Properti

  • nama

    string

    Nama header HTTP.

  • nilai

    string

    Nilai header HTTP.

HttpMethod

Enum

"GET"

"POSTING"

InterruptReason

Enum

"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

Download saat ini menerima data dari server.

terganggu

Terjadi error pada koneksi dengan host file.

selesai

Download berhasil diselesaikan.

Enum

"dalam proses"

"terganggu"

"selesai"

StringDelta

Properti

  • current

    string opsional

  • sebelumnya

    string opsional

UiOptions

Chrome 105 dan yang lebih baru

Properti

  • diaktifkan

    boolean

    Mengaktifkan atau menonaktifkan UI download.

Metode

acceptDanger()

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

Minta pengguna menerima download yang berbahaya. Hanya dapat dipanggil dari konteks yang terlihat (tab, jendela, atau pop-up tindakan halaman/browser). Tidak menerima download berbahaya secara otomatis. Jika download diterima, peristiwa onChanged akan diaktifkan. Jika tidak, tidak akan terjadi apa-apa. Jika semua data diambil ke dalam file sementara dan hasil download tidak berbahaya atau bahayanya telah diterima, file sementara akan diganti namanya menjadi nama file target, state berubah menjadi 'complete', dan onChanged diaktifkan.

Parameter

  • downloadId

    angka

    ID untuk DownloadItem.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

cancel()

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

Membatalkan download. Saat callback dijalankan, download dibatalkan, selesai, terganggu, atau tidak ada lagi.

Parameter

  • downloadId

    angka

    ID download yang akan dibatalkan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

download()

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

Download URL. Jika URL menggunakan protokol HTTP[S], permintaan akan menyertakan semua cookie yang saat ini ditetapkan untuk nama host-nya. Jika filename dan saveAs ditetapkan, dialog Simpan Sebagai akan ditampilkan, yang telah diisi otomatis dengan filename yang ditentukan. Jika download berhasil dimulai, callback akan dipanggil dengan downloadId DownloadItem yang baru. Jika terjadi error saat memulai download, callback akan dipanggil dengan downloadId=undefined dan runtime.lastError akan berisi string deskriptif. String error tidak dijamin akan tetap kompatibel dengan rilis lama. Ekstensi tidak boleh menguraikannya.

Parameter

  • Konten yang harus didownload dan caranya.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    (downloadId: number) => void

    • downloadId

      angka

Hasil

  • Promise&lt;number&gt;

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

erase()

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

Hapus DownloadItem yang cocok dari histori tanpa menghapus file yang didownload. Peristiwa onErased akan diaktifkan untuk setiap DownloadItem yang cocok dengan query, lalu callback akan dipanggil.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    (erasedIds: number[]) => void

    • erasedIds

      angka[]

Hasil

  • Janji<number[]>

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

getFileIcon()

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

Mengambil ikon untuk download yang ditentukan. Untuk download baru, ikon file tersedia setelah peristiwa onCreated diterima. Gambar yang ditampilkan oleh fungsi ini saat download sedang berlangsung mungkin berbeda dengan gambar yang ditampilkan setelah download selesai. Pengambilan ikon dilakukan dengan mengkueri sistem operasi atau toolkit yang mendasarinya bergantung pada platform. Ikon yang ditampilkan akan bergantung pada sejumlah faktor, termasuk status download, platform, jenis file terdaftar, dan tema visual. Jika ikon file tidak dapat ditentukan, runtime.lastError akan berisi pesan error.

Parameter

  • downloadId

    angka

    ID untuk download.

  • opsi
  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    (iconURL?: string) => void

    • iconURL

      string opsional

Hasil

  • Promise<string | tidak terdefinisi>

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

open()

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

Membuka file yang didownload sekarang jika DownloadItem telah selesai; jika tidak, menampilkan error melalui runtime.lastError. Metode ini memerlukan izin "downloads.open" selain izin "downloads". Peristiwa onChanged diaktifkan saat item dibuka untuk pertama kalinya. Metode ini hanya dapat dipanggil sebagai respons terhadap gestur pengguna.

Parameter

  • downloadId

    angka

    ID untuk file yang didownload.

  • callback

    fungsi opsional

    Chrome 123 dan yang lebih baru

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Chrome 123 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

pause()

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

Jeda download. Jika permintaan berhasil, download akan dijeda. Atau, runtime.lastError akan berisi pesan error. Permintaan akan gagal jika download tidak aktif.

Parameter

  • downloadId

    angka

    ID download yang akan dijeda.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

removeFile()

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

Hapus file yang didownload jika ada dan DownloadItem sudah selesai; jika tidak, tampilkan error melalui runtime.lastError.

Parameter

  • downloadId

    angka

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

resume()

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

Melanjutkan download yang dijeda. Jika permintaan berhasil, download sedang berlangsung dan tidak dijeda lagi. Atau, runtime.lastError akan berisi pesan error. Permintaan akan gagal jika download tidak aktif.

Parameter

  • downloadId

    angka

    ID download yang akan dilanjutkan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

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

Cari DownloadItem. Tetapkan query ke objek kosong untuk mendapatkan semua DownloadItem. Untuk mendapatkan DownloadItem tertentu, hanya tetapkan kolom id. Untuk menelusuri sejumlah besar item, setel orderBy: ['-startTime'], tetapkan limit ke jumlah item per halaman, dan tetapkan startedAfter ke startTime item terakhir dari halaman terakhir.

Parameter

Hasil

  • Promise&lt;DownloadItem[]&gt;

    Chrome 96 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

setShelfEnabled()

Tidak digunakan lagi sejak Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

Sebagai gantinya, gunakan setUiOptions.

Mengaktifkan atau menonaktifkan rak abu-abu di bagian bawah setiap jendela yang terkait dengan profil browser saat ini. Galeri akan dinonaktifkan selama setidaknya satu ekstensi telah menonaktifkannya. Mengaktifkan rak saat setidaknya satu ekstensi lain telah menonaktifkannya akan menampilkan error melalui runtime.lastError. Memerlukan izin "downloads.shelf" selain izin "downloads".

Parameter

  • diaktifkan

    boolean

setUiOptions()

Janji Chrome 105 dan yang lebih baru
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

Mengubah UI download setiap jendela yang terkait dengan profil browser saat ini. Selama minimal satu ekstensi telah menetapkan UiOptions.enabled ke salah, UI download akan disembunyikan. Menyetel UiOptions.enabled ke benar (true) saat setidaknya satu ekstensi lain telah menonaktifkannya akan menampilkan error melalui runtime.lastError. Memerlukan izin "downloads.ui" selain izin "downloads".

Parameter

  • opsi

    Mengenkapsulasi perubahan ke UI download.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini:

    () => void

Hasil

  • Janji<void>

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

show()

chrome.downloads.show(
  downloadId: number,
)

Tampilkan file yang didownload dalam foldernya di pengelola file.

Parameter

  • downloadId

    angka

    ID untuk file yang didownload.

showDefaultFolder()

chrome.downloads.showDefaultFolder()

Tampilkan folder Download default di pengelola file.

Acara

onChanged

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

Saat salah satu properti DownloadItem kecuali bytesReceived dan estimatedEndTime berubah, peristiwa ini akan diaktifkan dengan downloadId dan objek yang berisi properti yang berubah.

Parameter

onCreated

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

Peristiwa ini diaktifkan dengan objek DownloadItem saat download dimulai.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini:

    (downloadItem: DownloadItem) => void

onDeterminingFilename

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

Selama proses penentuan nama file, ekstensi akan diberi kesempatan untuk mengganti DownloadItem.filename target. Setiap ekstensi tidak boleh mendaftarkan lebih dari satu pemroses untuk peristiwa ini. Setiap pemroses harus memanggil suggest tepat satu kali, baik secara sinkron maupun asinkron. Jika pemroses memanggil suggest secara asinkron, pemroses harus menampilkan true. Jika pemroses tidak memanggil suggest secara sinkron atau menampilkan true, suggest akan dipanggil secara otomatis. DownloadItem tidak akan selesai hingga semua pemroses memanggil suggest. Pemroses dapat memanggil suggest tanpa argumen apa pun agar download dapat menggunakan downloadItem.filename untuk nama filenya, atau meneruskan objek suggestion ke suggest untuk mengganti nama file target. Jika lebih dari satu ekstensi mengganti nama file, ekstensi terakhir yang diinstal yang pemrosesnya meneruskan objek suggestion ke suggest akan menang. Untuk menghindari kebingungan terkait ekstensi mana yang akan menang, pengguna tidak boleh menginstal ekstensi yang mungkin bertentangan. Jika download dimulai oleh download dan nama file target diketahui sebelum jenis MIME dan nama file sementara ditentukan, teruskan filename ke download.

Parameter

onErased

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

Diaktifkan dengan downloadId saat download dihapus dari histori.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini:

    (downloadId: number) => void

    • downloadId

      angka