chrome.downloads

Deskripsi

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

Izin

downloads

Anda harus menyatakan izin "downloads" dalam manifes ekstensi untuk menggunakan API ini.

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

Contoh

Anda dapat menemukan contoh sederhana penggunaan API chrome.downloads di direktori examples/api/downloads. Untuk contoh lain dan bantuan dalam melihat kode sumber, lihat Contoh.

Jenis

BooleanDelta

Properti

  • current

    boolean opsional

  • sebelumnya

    boolean opsional

DangerType

file

Nama file hasil 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 dikenal mendistribusikan biner berbahaya dan kemungkinan berbahaya.

tidak diinginkan

Hasil download mungkin tidak diinginkan atau tidak aman. Misalnya, setelan ini dapat mengubah setelan browser atau komputer.

aman

Download tidak menunjukkan bahaya yang diketahui terhadap komputer pengguna.

diterima

Pengguna telah menerima download berbahaya.

Enum

"file"

"url"

"host"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"promptForScanning"

"promptForLocalPasswordScanning"

"blockedScanFailed"

DoubleDelta

Properti

  • current

    nomor opsional

  • sebelumnya

    nomor 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+

    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.

  • state

    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

    True jika download sedang berlangsung dan dijeda, atau jika download terhenti dan dapat dilanjutkan, dimulai dari posisi terhenti.

  • bahaya

    Indikasi apakah download ini dianggap aman atau 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

    Penyebab download terganggu. Beberapa jenis error HTTP dapat dikelompokkan ke dalam salah satu error yang dimulai 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 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. Informasi ini mungkin tidak berlaku lagi 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 kembali, 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+

    URL mutlak tempat download ini dibuat, setelah semua pengalihan.

  • id

    angka

    ID yang tetap di seluruh sesi browser.

  • samaran

    boolean

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

  • pantomim

    string

    Jenis MIME file.

  • dijeda

    boolean

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

  • referrer

    string

    URL mutlak.

  • startTime

    string

    Waktu dimulainya download 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))})})

  • state

    Menunjukkan apakah download sedang berlangsung, terganggu, atau selesai.

  • totalBytes

    angka

    Jumlah byte di seluruh file, tanpa mempertimbangkan kompresi file, atau -1 jika tidak diketahui.

  • url

    string

    URL absolut tempat download ini memulai, sebelum pengalihan apa pun.

DownloadOptions

Properti

  • body

    string opsional

    Isi postingan.

  • conflictAction

    Tindakan yang harus diambil jika filename sudah ada.

  • filename

    string opsional

    Jalur file yang terkait dengan direktori Download untuk memuat file yang didownload, 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 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 ditetapkan atau sudah ada.

  • url

    string

    URL untuk mendownload.

DownloadQuery

Properti

  • bytesReceived

    nomor opsional

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

  • bahaya

    DangerType opsional

    Indikasi apakah download ini dianggap aman atau mencurigakan.

  • endTime

    string opsional

    Waktu download berakhir dalam format ISO 8601.

  • endedAfter

    string opsional

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

  • endedBefore

    string opsional

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

  • error

    InterruptReason opsional

    Penyebab download terganggu.

  • ada

    boolean opsional

    Apakah file yang didownload ada;

  • fileSize

    nomor 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+

    URL mutlak tempat download ini dibuat, setelah semua pengalihan.

  • finalUrlRegex

    string opsional

    Chrome 54+

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

  • id

    nomor opsional

    id dari DownloadItem untuk dikueri.

  • batas

    nomor 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 menelusuri 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 menurut 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 koneksi tetap terbuka.

  • kueri

    string[] opsional

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

  • startTime

    string opsional

    Waktu dimulainya download dalam format ISO 8601.

  • startedAfter

    string opsional

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

  • startedBefore

    string opsional

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

  • state

    Negara bagian opsional

    Menunjukkan apakah download sedang berlangsung, terganggu, atau selesai.

  • totalBytes

    nomor opsional

    Jumlah byte di seluruh file, tanpa mempertimbangkan kompresi file, atau -1 jika tidak diketahui.

  • totalBytesGreater

    nomor opsional

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

  • totalBytesLess

    nomor opsional

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

  • url

    string opsional

    URL absolut tempat download ini memulai, sebelum pengalihan apa pun.

  • urlRegex

    string opsional

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

FilenameConflictAction

menyeragamkan

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

timpa

File yang sudah ada akan ditimpa dengan file baru.

perintah

Pengguna akan melihat dialog pemilih file.

Enum

FilenameSuggestion

Properti

  • conflictAction

    Tindakan yang harus diambil jika filename sudah ada.

  • filename

    string

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

GetFileIconOptions

Properti

  • ukuran

     opsional

    Ukuran ikon yang ditampilkan. Ikon akan berbentuk persegi dengan dimensi ukuran * piksel ukuran. Ukuran default dan terbesar untuk ikon adalah 32x32 piksel. Ukuran yang didukung hanya 16 dan 32. Menentukan ukuran lainnya adalah error.

HeaderNameValuePair

Properti

  • name

    string

    Nama header HTTP.

  • value

    string

    Nilai header HTTP.

HttpMethod

Enum

"GET"

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

"USER_CANCELED"

"USER_SHUTDOWN"

"CRASH"

State

in_progress

Download saat ini menerima data dari server.

terganggu

Terjadi error saat memutuskan koneksi dengan host file.

selesai

Download berhasil diselesaikan.

Enum

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()

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

Minta pengguna menyetujui download berbahaya. Hanya dapat dipanggil dari konteks yang terlihat (pop-up tindakan halaman/browser, tab, atau jendela). Tidak otomatis menerima download berbahaya. Jika download diterima, peristiwa onChanged akan diaktifkan. Jika tidak, tidak akan terjadi apa-apa. Jika semua data diambil ke dalam file sementara dan download tidak berbahaya atau bahaya 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:

    ()=>void

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

cancel()

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

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

Parameter

  • downloadId

    angka

    ID download yang akan dibatalkan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    ()=>void

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

download()

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

Download URL. Jika URL menggunakan protokol HTTP[S], permintaan akan menyertakan semua cookie yang saat ini disetel untuk nama host-nya. Jika filename dan saveAs ditentukan, maka dialog Save As 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 versi sebelumnya antar-rilis. Ekstensi tidak boleh mengurainya.

Parameter

  • Apa yang harus didownload dan bagaimana caranya.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    (downloadId: number)=>void

    • downloadId

      angka

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

erase()

Promise
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:

    (erasedIds: number[])=>void

    • erasedIds

      angka[]

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

getFileIcon()

Promise
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 platformnya. Oleh karena itu, ikon yang ditampilkan 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:

    (iconURL?: string)=>void

    • iconURL

      string opsional

Hasil

  • Promise<string|undefined>

    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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

open()

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

Membuka file yang didownload sekarang jika DownloadItem 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:

    ()=>void

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

pause()

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

Jeda download. Jika permintaan berhasil, download akan berada dalam status dijeda. Jika tidak, 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:

    ()=>void

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeFile()

Promise
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:

    ()=>void

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

resume()

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

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

Parameter

  • downloadId

    angka

    ID download untuk dilanjutkan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    ()=>void

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

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

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

Parameter

Hasil

  • Promise<DownloadItem[]>

    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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

setShelfEnabled()

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

Sebagai gantinya, gunakan setUiOptions.

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

Parameter

  • diaktifkan

    boolean

setUiOptions()

Promise Chrome 105+
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

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

Parameter

  • opsi

    Mengenkapsulasi perubahan pada UI download.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti:

    ()=>void

Hasil

  • Promise<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. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

show()

chrome.downloads.show(
  downloadId: number,
)

Tampilkan file yang diunduh di 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,
)

Jika 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

onDeterminingFilename

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

Selama proses penentuan nama file, ekstensi akan diberi kesempatan untuk mengganti target DownloadItem.filename. 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 untuk memungkinkan download menggunakan downloadItem.filename untuk nama filenya, atau meneruskan objek suggestion ke suggest untuk mengganti nama file target. Jika lebih dari satu ekstensi menggantikan nama file, ekstensi terakhir yang diinstal yang pemrosesnya meneruskan objek suggestion ke suggest akan menang. Untuk menghindari kebingungan mengenai ekstensi mana yang akan menang, pengguna sebaiknya tidak memasang ekstensi yang mungkin bentrok. Jika download dimulai oleh download dan nama file target diketahui sebelum jenis MIME dan nama file tentatif 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:

    (downloadId: number)=>void

    • downloadId

      angka