browser.downloads

Mô tả

Sử dụng API chrome.downloads để bắt đầu, theo dõi, thao tác và tìm kiếm tệp tải xuống theo phương thức lập trình.

Quyền

downloads

Bạn phải khai báo quyền "downloads" trong tệp kê khai tiện ích để sử dụng API này.

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

Ví dụ

Bạn có thể tìm thấy các ví dụ đơn giản về cách sử dụng API browser.downloads trong thư mục examples/api/downloads. Để xem các ví dụ khác và được trợ giúp xem mã nguồn, hãy xem phần Mẫu.

Loại

BooleanDelta

Thuộc tính

  • hồ sơ thanh toán

    boolean không bắt buộc

  • trước

    boolean không bắt buộc

DangerType

Enum

"file"
Tên tệp tải xuống có vẻ đáng ngờ.

"url"
URL của tệp tải xuống được xác định là độc hại.

"content"
Tệp đã tải xuống được xác định là độc hại.

"uncommon"
URL của tệp tải xuống không thường được tải xuống và có thể nguy hiểm.

"host"
Tệp tải xuống đến từ một máy chủ lưu trữ được xác định là phân phối tệp nhị phân độc hại và có khả năng gây nguy hiểm.

"unwanted"
Tệp tải xuống có thể không mong muốn hoặc không an toàn. Ví dụ: phần mềm này có thể thay đổi chế độ cài đặt của trình duyệt hoặc máy tính.

"safe"
Tệp tải xuống không gây ra mối nguy hiểm nào đã biết cho máy tính của người dùng.

"accepted"
Người dùng đã chấp nhận tệp tải xuống nguy hiểm.

"allowlistedByPolicy"
Các giá trị liên quan đến doanh nghiệp.

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepScannedOpenedDangerous"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

"forceSaveToGdrive"
Để tiện ích Trình duyệt bảo mật cho doanh nghiệp sử dụng. Khi cần, Chrome sẽ chặn việc tải xuống ổ đĩa và tải tệp trực tiếp xuống Google Drive.

"forceSaveToOnedrive"
Để tiện ích Trình duyệt bảo mật cho doanh nghiệp sử dụng. Khi cần, Chrome sẽ chặn việc tải xuống ổ đĩa và tải tệp trực tiếp xuống OneDrive.

DoubleDelta

Thuộc tính

  • hồ sơ thanh toán

    number không bắt buộc

  • trước

    number không bắt buộc

DownloadDelta

Thuộc tính

  • canResume

    BooleanDelta không bắt buộc

    Sự thay đổi về canResume (nếu có).

  • nguy hiểm

    StringDelta không bắt buộc

    Sự thay đổi về danger (nếu có).

  • endTime

    StringDelta không bắt buộc

    Sự thay đổi về endTime (nếu có).

  • error

    StringDelta không bắt buộc

    Sự thay đổi về error (nếu có).

  • tồn tại

    BooleanDelta không bắt buộc

    Sự thay đổi về exists (nếu có).

  • fileSize

    DoubleDelta không bắt buộc

    Sự thay đổi về fileSize (nếu có).

  • filename

    StringDelta không bắt buộc

    Sự thay đổi về filename (nếu có).

  • finalUrl

    StringDelta không bắt buộc

    Chrome 54 trở lên browser.* kể từ Chrome 148

    Sự thay đổi về finalUrl (nếu có).

  • id

    số

    id của DownloadItem đã thay đổi.

  • điệu bộ

    StringDelta không bắt buộc

    Sự thay đổi về mime (nếu có).

  • tạm dừng

    BooleanDelta không bắt buộc

    Sự thay đổi về paused (nếu có).

  • startTime

    StringDelta không bắt buộc

    Sự thay đổi về startTime (nếu có).

  • tiểu bang

    StringDelta không bắt buộc

    Sự thay đổi về state (nếu có).

  • totalBytes

    DoubleDelta không bắt buộc

    Sự thay đổi về totalBytes (nếu có).

  • url

    StringDelta không bắt buộc

    Sự thay đổi về url (nếu có).

DownloadItem

Thuộc tính

  • byExtensionId

    chuỗi không bắt buộc

    Giá trị nhận dạng của tiện ích đã bắt đầu quá trình tải xuống này (nếu quá trình tải xuống này do một tiện ích bắt đầu). Không thay đổi sau khi được đặt.

  • byExtensionName

    chuỗi không bắt buộc

    Tên đã bản địa hoá của tiện ích bắt đầu quá trình tải xuống này (nếu quá trình tải xuống này do một tiện ích bắt đầu). Có thể thay đổi nếu tiện ích thay đổi tên hoặc nếu người dùng thay đổi ngôn ngữ.

  • bytesReceived

    số

    Số byte đã nhận được từ máy chủ lưu trữ tính đến thời điểm hiện tại, không tính đến việc nén tệp.

  • canResume

    boolean

    Đúng nếu quá trình tải xuống đang diễn ra và bị tạm dừng, hoặc nếu quá trình tải xuống bị gián đoạn và có thể tiếp tục từ thời điểm bị gián đoạn.

  • nguy hiểm

    DangerType

    Cho biết liệu tệp tải xuống này được cho là an toàn hay đáng ngờ.

  • endTime

    chuỗi không bắt buộc

    Thời điểm quá trình tải xuống kết thúc, ở định dạng ISO 8601. Có thể được truyền trực tiếp đến hàm khởi tạo Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

  • error

    InterruptReason không bắt buộc

    Lý do khiến quá trình tải xuống bị gián đoạn. Một số loại lỗi HTTP có thể được nhóm vào một trong các lỗi bắt đầu bằng SERVER_. Lỗi liên quan đến mạng bắt đầu bằng NETWORK_, lỗi liên quan đến quá trình ghi tệp vào hệ thống tệp bắt đầu bằng FILE_ và lỗi gián đoạn do người dùng bắt đầu bằng USER_.

  • estimatedEndTime

    chuỗi không bắt buộc

    Thời gian ước tính khi quá trình tải xuống hoàn tất, ở định dạng ISO 8601. Có thể được truyền trực tiếp đến hàm khởi tạo Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

  • tồn tại

    boolean

    Liệu tệp đã tải xuống có còn tồn tại hay không. Thông tin này có thể đã lỗi thời vì Chrome không tự động theo dõi việc xoá tệp. Gọi search() để kích hoạt quy trình kiểm tra xem tệp có tồn tại hay không. Khi quá trình kiểm tra sự tồn tại hoàn tất, nếu tệp đã bị xoá, thì sự kiện onChanged sẽ kích hoạt. Xin lưu ý rằng search() không đợi quá trình kiểm tra sự tồn tại hoàn tất trước khi trả về, vì vậy, kết quả từ search() có thể không phản ánh chính xác hệ thống tệp. Ngoài ra, search() có thể được gọi thường xuyên nếu cần, nhưng sẽ không kiểm tra sự tồn tại của tệp thường xuyên hơn 10 giây một lần.

  • fileSize

    số

    Số byte trong toàn bộ tệp sau khi giải nén hoặc -1 nếu không xác định được.

  • filename

    chuỗi

    Đường dẫn cục bộ tuyệt đối.

  • finalUrl

    chuỗi

    Chrome 54 trở lên browser.* kể từ Chrome 148

    URL tuyệt đối mà tệp này được tải xuống, sau tất cả các lệnh chuyển hướng.

  • id

    số

    Giá trị nhận dạng không thay đổi trong các phiên trình duyệt.

  • ẩn danh

    boolean

    Sai nếu tệp tải xuống này được ghi lại trong nhật ký, đúng nếu không được ghi lại.

  • điệu bộ

    chuỗi

    Loại MIME của tệp.

  • tạm dừng

    boolean

    True nếu quá trình tải xuống đã ngừng đọc dữ liệu từ máy chủ lưu trữ nhưng vẫn giữ kết nối.

  • người giới thiệu

    chuỗi

    URL tuyệt đối.

  • startTime

    chuỗi

    Thời điểm bắt đầu tải xuống, theo định dạng ISO 8601. Có thể được truyền trực tiếp đến hàm khởi tạo Date: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • tiểu bang

    Trạng thái

    Cho biết quá trình tải xuống đang diễn ra, bị gián đoạn hay đã hoàn tất.

  • totalBytes

    số

    Số byte trong toàn bộ tệp, không tính đến việc nén tệp hoặc -1 nếu không xác định được.

  • url

    chuỗi

    URL tuyệt đối mà tệp tải xuống này bắt đầu, trước mọi lệnh chuyển hướng.

DownloadOptions

Thuộc tính

  • nội dung

    chuỗi không bắt buộc

    Nội dung bài đăng.

  • conflictAction

    FilenameConflictAction không bắt buộc

    Hành động cần thực hiện nếu filename đã tồn tại.

  • filename

    chuỗi không bắt buộc

    Đường dẫn tệp tương ứng với thư mục Tệp đã tải xuống để chứa tệp đã tải xuống, có thể chứa các thư mục con. Đường dẫn tuyệt đối, đường dẫn trống và đường dẫn chứa tham chiếu ngược ".." sẽ gây ra lỗi. onDeterminingFilename cho phép đề xuất tên tệp sau khi xác định được loại MIME của tệp và tên tệp dự kiến.

  • tiêu đề

    HeaderNameValuePair[] không bắt buộc

    Tiêu đề HTTP bổ sung cần gửi cùng với yêu cầu nếu URL sử dụng giao thức HTTP[s]. Mỗi tiêu đề được biểu thị dưới dạng một từ điển chứa các khoá name và value hoặc binaryValue, chỉ giới hạn ở những tiêu đề được XMLHttpRequest cho phép.

  • method

    HttpMethod không bắt buộc

    Phương thức HTTP cần sử dụng nếu URL dùng giao thức HTTP[S].

  • saveAs

    boolean không bắt buộc

    Sử dụng trình chọn tệp để cho phép người dùng chọn tên tệp bất kể filename đã được đặt hay đã tồn tại.

  • url

    chuỗi

    URL cần tải xuống.

DownloadQuery

Thuộc tính

  • bytesReceived

    number không bắt buộc

    Số byte đã nhận được từ máy chủ lưu trữ tính đến thời điểm hiện tại, không tính đến việc nén tệp.

  • nguy hiểm

    DangerType không bắt buộc

    Cho biết liệu tệp tải xuống này được cho là an toàn hay được xác định là đáng ngờ.

  • endTime

    chuỗi không bắt buộc

    Thời điểm quá trình tải xuống kết thúc, ở định dạng ISO 8601.

  • endedAfter

    chuỗi không bắt buộc

    Giới hạn kết quả ở DownloadItem kết thúc sau mili giây đã cho theo định dạng ISO 8601

  • endedBefore

    chuỗi không bắt buộc

    Giới hạn kết quả ở những DownloadItem kết thúc trước mili giây đã cho theo định dạng ISO 8601.

  • error

    InterruptReason không bắt buộc

    Lý do khiến quá trình tải xuống bị gián đoạn.

  • tồn tại

    boolean không bắt buộc

    Tệp đã tải xuống có tồn tại hay không;

  • fileSize

    number không bắt buộc

    Số byte trong toàn bộ tệp sau khi giải nén hoặc -1 nếu không xác định được.

  • filename

    chuỗi không bắt buộc

    Đường dẫn cục bộ tuyệt đối.

  • filenameRegex

    chuỗi không bắt buộc

    Giới hạn kết quả ở DownloadItem có filename khớp với biểu thức chính quy đã cho.

  • finalUrl

    chuỗi không bắt buộc

    Chrome 54 trở lên browser.* kể từ Chrome 148

    URL tuyệt đối mà tệp này được tải xuống, sau tất cả các lệnh chuyển hướng.

  • finalUrlRegex

    chuỗi không bắt buộc

    Chrome 54 trở lên browser.* kể từ Chrome 148

    Giới hạn kết quả ở DownloadItem có finalUrl khớp với biểu thức chính quy đã cho.

  • id

    number không bắt buộc

    id của DownloadItem cần truy vấn.

  • giới hạn

    number không bắt buộc

    Số lượng DownloadItem trùng khớp tối đa được trả về. Giá trị mặc định là 1000. Đặt thành 0 để trả về tất cả DownloadItem phù hợp. Xem search để biết cách phân trang kết quả.

  • điệu bộ

    chuỗi không bắt buộc

    Loại MIME của tệp.

  • orderBy

    string[] không bắt buộc

    Đặt các phần tử của mảng này thành thuộc tính DownloadItem để sắp xếp kết quả tìm kiếm. Ví dụ: việc đặt orderBy=['startTime'] sẽ sắp xếp DownloadItem theo thời gian bắt đầu theo thứ tự tăng dần. Để chỉ định thứ tự giảm dần, hãy thêm dấu gạch nối vào trước: "-startTime".

  • tạm dừng

    boolean không bắt buộc

    True nếu quá trình tải xuống đã ngừng đọc dữ liệu từ máy chủ lưu trữ nhưng vẫn giữ kết nối.

  • truy vấn

    string[] không bắt buộc

    Mảng cụm từ tìm kiếm này giới hạn kết quả ở DownloadItem có filename hoặc url hoặc finalUrl chứa tất cả cụm từ tìm kiếm không bắt đầu bằng dấu gạch ngang "-" và không có cụm từ tìm kiếm nào bắt đầu bằng dấu gạch ngang.

  • startTime

    chuỗi không bắt buộc

    Thời điểm bắt đầu tải xuống, theo định dạng ISO 8601.

  • startedAfter

    chuỗi không bắt buộc

    Giới hạn kết quả ở DownloadItem bắt đầu sau mili giây đã cho ở định dạng ISO 8601.

  • startedBefore

    chuỗi không bắt buộc

    Giới hạn kết quả ở DownloadItem bắt đầu trước mili giây đã cho theo định dạng ISO 8601.

  • tiểu bang

    Tiểu bang không bắt buộc

    Cho biết quá trình tải xuống đang diễn ra, bị gián đoạn hay đã hoàn tất.

  • totalBytes

    number không bắt buộc

    Số byte trong toàn bộ tệp, không tính đến việc nén tệp hoặc -1 nếu không xác định được.

  • totalBytesGreater

    number không bắt buộc

    Giới hạn kết quả ở DownloadItem có totalBytes lớn hơn số nguyên đã cho.

  • totalBytesLess

    number không bắt buộc

    Giới hạn kết quả ở DownloadItem có totalBytes nhỏ hơn số nguyên đã cho.

  • url

    chuỗi không bắt buộc

    URL tuyệt đối mà tệp tải xuống này bắt đầu, trước mọi lệnh chuyển hướng.

  • urlRegex

    chuỗi không bắt buộc

    Giới hạn kết quả ở DownloadItem có url khớp với biểu thức chính quy đã cho.

FilenameConflictAction

uniquify

Để tránh trùng lặp, filename sẽ được thay đổi để thêm một bộ đếm trước đuôi tệp.

ghi đè

Tệp hiện có sẽ bị ghi đè bằng tệp mới.

prompt

Người dùng sẽ được nhắc bằng hộp thoại bộ chọn tệp.

Enum

"uniquify"

"overwrite"

"prompt"

FilenameSuggestion

Thuộc tính

  • conflictAction

    FilenameConflictAction không bắt buộc

    Hành động cần thực hiện nếu filename đã tồn tại.

  • filename

    chuỗi

    Mục tiêu mới của DownloadItem DownloadItem.filename, dưới dạng đường dẫn tương đối đến thư mục Tải xuống mặc định của người dùng, có thể chứa các thư mục con. Đường dẫn tuyệt đối, đường dẫn trống và đường dẫn chứa tham chiếu ngược ".." sẽ bị bỏ qua. filename sẽ bị bỏ qua nếu có bất kỳ trình nghe onDeterminingFilename nào được đăng ký bởi bất kỳ tiện ích nào.

GetFileIconOptions

Thuộc tính

  • size

    number không bắt buộc

    Kích thước của biểu tượng được trả về, tính bằng pixel không phụ thuộc vào mật độ (DIP). Phải là 16 hoặc 32 (mặc định là 32). Trên màn hình có DPI cao, hình ảnh được trả về sẽ điều chỉnh theo hệ số tỷ lệ của thiết bị (ví dụ: 64x64 px cho kích thước 32 trên màn hình 2x). Các lệnh gọi từ trình chạy dịch vụ nền mặc định có tỷ lệ 1x.

HeaderNameValuePair

Thuộc tính

  • tên

    chuỗi

    Tên của tiêu đề HTTP.

  • value

    chuỗi

    Giá trị của tiêu đề HTTP.

HttpMethod

Enum

"GET"

"POST"

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

Tệp tải xuống hiện đang nhận dữ liệu từ máy chủ.

bị gián đoạn

Đã xảy ra lỗi làm mất kết nối với máy chủ lưu trữ tệp.

hoàn tất

Đã tải xuống thành công.

Enum

"in_progress"

"interrupted"

"complete"

StringDelta

Thuộc tính

  • hồ sơ thanh toán

    chuỗi không bắt buộc

  • trước

    chuỗi không bắt buộc

UiOptions

Chrome 105 trở lên browser.* kể từ Chrome 148

Thuộc tính

  • đang bật

    boolean

    Bật hoặc tắt giao diện người dùng tải xuống.

Phương thức

acceptDanger()

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

Nhắc người dùng chấp nhận một tệp tải xuống nguy hiểm. Chỉ có thể được gọi từ một ngữ cảnh hiển thị (thẻ, cửa sổ hoặc cửa sổ bật lên hành động trên trang/trình duyệt). Không tự động chấp nhận các tệp tải xuống nguy hiểm. Nếu lượt tải xuống được chấp nhận, thì sự kiện onChanged sẽ kích hoạt, nếu không thì sẽ không có gì xảy ra. Khi tất cả dữ liệu được tìm nạp vào một tệp tạm thời và tệp tải xuống không nguy hiểm hoặc mối nguy hiểm đã được chấp nhận, thì tệp tạm thời sẽ được đổi tên thành tên tệp mục tiêu, state thay đổi thành "hoàn tất" và onChanged sẽ kích hoạt.

Thông số

  • downloadId

    số

    Giá trị nhận dạng cho DownloadItem.

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

    Trả về một Lời hứa sẽ giải quyết khi hộp thoại nhắc nguy hiểm đóng lại.

cancel()

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

Huỷ tải xuống. Khi callback chạy, quá trình tải xuống sẽ bị huỷ, hoàn tất, bị gián đoạn hoặc không còn tồn tại nữa.

Thông số

  • downloadId

    số

    Mã nhận dạng của tệp tải xuống cần huỷ.

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

    Trả về một Lời hứa sẽ được thực hiện khi yêu cầu huỷ hoàn tất.

download()

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

Tải URL xuống. Nếu URL sử dụng giao thức HTTP[S], thì yêu cầu sẽ bao gồm tất cả cookie hiện được đặt cho tên máy chủ của URL đó. Nếu bạn chỉ định cả filename và saveAs, thì hộp thoại Lưu dưới dạng sẽ xuất hiện và được điền sẵn filename đã chỉ định. Nếu quá trình tải xuống bắt đầu thành công, callback sẽ được gọi bằng downloadId của DownloadItem mới. Nếu xảy ra lỗi khi bắt đầu tải xuống, thì callback sẽ được gọi bằng downloadId=undefined và runtime.lastError sẽ chứa một chuỗi mô tả. Chuỗi lỗi không được đảm bảo duy trì khả năng tương thích ngược giữa các bản phát hành. Tiện ích không được phân tích cú pháp.

Thông số

  • tùy chọn

    DownloadOptions

    Nội dung cần tải xuống và cách tải xuống.

Giá trị trả về

  • Promise<number>

    Chrome 96 trở lên browser.* kể từ Chrome 148

    Trả về một Lời hứa sẽ phân giải bằng mã nhận dạng của DownloadItem mới.

erase()

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

Xoá DownloadItem trùng khớp khỏi nhật ký mà không xoá tệp đã tải xuống. Sự kiện onErased sẽ kích hoạt cho mỗi DownloadItem khớp với query, sau đó callback sẽ được gọi.

Thông số

Giá trị trả về

  • Promise<number[]>

    Chrome 96 trở lên browser.* kể từ Chrome 148

getFileIcon()

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

Truy xuất biểu tượng cho tệp tải xuống được chỉ định. Đối với các tệp tải xuống mới, biểu tượng tệp sẽ xuất hiện sau khi tên tệp mục tiêu của tệp tải xuống được xác định (ví dụ: khi onChanged kích hoạt với thay đổi filename). Nếu bạn cố gắng truy xuất biểu tượng trước khi xác định tên tệp, thì lỗi sẽ xảy ra thông qua runtime.lastError. Hình ảnh do hàm này trả về trong khi quá trình tải xuống đang diễn ra có thể khác với hình ảnh được trả về sau khi quá trình tải xuống hoàn tất. Việc truy xuất biểu tượng được thực hiện bằng cách truy vấn hệ điều hành hoặc bộ công cụ cơ bản, tuỳ thuộc vào nền tảng. Do đó, biểu tượng được trả về sẽ phụ thuộc vào một số yếu tố, bao gồm trạng thái tải xuống, nền tảng, loại tệp đã đăng ký và giao diện hình ảnh. Nếu không xác định được biểu tượng tệp, runtime.lastError sẽ chứa thông báo lỗi.

Thông số

  • downloadId

    số

    Giá trị nhận dạng của tệp tải xuống.

  • tùy chọn

    GetFileIconOptions không bắt buộc

Giá trị trả về

  • <string | undefined> hứa hẹn

    Chrome 96 trở lên browser.* kể từ Chrome 148

    Trả về một Lời hứa sẽ phân giải bằng một URL đến hình ảnh đại diện cho tệp tải xuống.

open()

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

Mở tệp đã tải xuống ngay nếu DownloadItem hoàn tất; nếu không, trả về lỗi thông qua runtime.lastError. Phương thức này yêu cầu quyền "downloads.open" ngoài quyền "downloads". Sự kiện onChanged kích hoạt khi mục được mở lần đầu tiên. Bạn chỉ có thể gọi phương thức này để phản hồi cử chỉ của người dùng.

Thông số

  • downloadId

    số

    Giá trị nhận dạng của tệp đã tải xuống.

Giá trị trả về

  • Promise<void>

    Chrome 123 trở lên browser.* kể từ Chrome 148

pause()

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

Tạm dừng quá trình tải xuống. Nếu yêu cầu thành công, thì quá trình tải xuống sẽ ở trạng thái tạm dừng. Nếu không, runtime.lastError sẽ chứa thông báo lỗi. Yêu cầu sẽ không thành công nếu quá trình tải xuống không hoạt động.

Thông số

  • downloadId

    số

    Mã của tệp tải xuống cần tạm dừng.

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

    Trả về một Lời hứa sẽ được thực hiện khi yêu cầu tạm dừng hoàn tất.

removeFile()

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

Xoá tệp đã tải xuống nếu tệp đó tồn tại và DownloadItem đã hoàn tất; nếu không, hãy trả về lỗi thông qua runtime.lastError.

Thông số

  • downloadId

    số

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

resume()

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

Tiếp tục tải xuống đã tạm dừng. Nếu yêu cầu thành công, quá trình tải xuống sẽ diễn ra và không bị tạm dừng. Nếu không, runtime.lastError sẽ chứa thông báo lỗi. Yêu cầu sẽ không thành công nếu quá trình tải xuống không hoạt động.

Thông số

  • downloadId

    số

    Mã nhận dạng của tệp tải xuống cần tiếp tục.

Giá trị trả về

  • Promise<void>

    Chrome 96 trở lên browser.* kể từ Chrome 148

    Trả về một Lời hứa sẽ được thực hiện khi yêu cầu tiếp tục hoàn tất.

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

Tìm DownloadItem. Đặt query thành đối tượng trống để nhận tất cả DownloadItem. Để nhận một DownloadItem cụ thể, chỉ cần đặt trường id. Để phân trang qua một số lượng lớn mục, hãy đặt orderBy: ['-startTime'], đặt limit thành số mục trên mỗi trang và đặt startedAfter thành startTime của mục cuối cùng trên trang cuối cùng.

Thông số

Giá trị trả về

  • <DownloadItem[]> hứa hẹn

    Chrome 96 trở lên browser.* kể từ Chrome 148

setShelfEnabled()

Ngừng sử dụng kể từ Chrome 117
browser.downloads.setShelfEnabled(
  enabled: boolean,
): void

Thay vào đó, hãy sử dụng setUiOptions.

Bật hoặc tắt kệ màu xám ở cuối mỗi cửa sổ liên kết với hồ sơ trình duyệt hiện tại. Kệ sẽ bị tắt miễn là có ít nhất một tiện ích đã tắt kệ. Nếu bạn bật kệ trong khi có ít nhất một tiện ích khác đã tắt kệ, thì hệ thống sẽ trả về lỗi thông qua runtime.lastError. Cần có quyền "downloads.shelf" ngoài quyền "downloads".

Thông số

  • đang bật

    boolean

setUiOptions()

Chrome 105 trở lên browser.* kể từ Chrome 148 
browser.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

Thay đổi giao diện người dùng tải xuống của mọi cửa sổ liên kết với hồ sơ trình duyệt hiện tại. Miễn là có ít nhất một tiện ích đã đặt UiOptions.enabled thành false, giao diện người dùng tải xuống sẽ bị ẩn. Việc đặt UiOptions.enabled thành true trong khi ít nhất một tiện ích khác đã tắt tiện ích này sẽ trả về lỗi thông qua runtime.lastError. Cần có quyền "downloads.ui" ngoài quyền "downloads".

Thông số

  • tùy chọn

    UiOptions

    Đóng gói một thay đổi đối với giao diện người dùng tải xuống.

Giá trị trả về

  • Promise<void>

    Trả về một Lời hứa sẽ giải quyết khi quá trình cập nhật giao diện người dùng hoàn tất.

show()

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

Hiện tệp đã tải xuống trong thư mục của tệp đó trong trình quản lý tệp.

Thông số

  • downloadId

    số

    Giá trị nhận dạng của tệp đã tải xuống.

showDefaultFolder()

browser.downloads.showDefaultFolder(): void

Hiện thư mục Tệp đã tải xuống mặc định trong trình quản lý tệp.

Sự kiện

onChanged

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

Khi bất kỳ thuộc tính nào của DownloadItem (ngoại trừ bytesReceived và estimatedEndTime) thay đổi, sự kiện này sẽ kích hoạt cùng với downloadId và một đối tượng chứa các thuộc tính đã thay đổi.

Thông số

onCreated

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

Sự kiện này kích hoạt đối tượng DownloadItem khi quá trình tải xuống bắt đầu.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (downloadItem: DownloadItem) =& gt;void

onDeterminingFilename

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

Trong quá trình xác định tên tệp, các tiện ích sẽ có cơ hội ghi đè DownloadItem.filename mục tiêu. Mỗi tiện ích không được đăng ký nhiều trình nghe cho sự kiện này. Mỗi trình nghe phải gọi suggest đúng một lần, theo cách đồng bộ hoặc không đồng bộ. Nếu trình nghe gọi suggest không đồng bộ, thì trình nghe phải trả về true. Nếu trình nghe không gọi suggest đồng bộ cũng như không trả về true, thì suggest sẽ được gọi tự động. DownloadItem sẽ không hoàn tất cho đến khi tất cả trình nghe đều gọi suggest. Trình nghe có thể gọi suggest mà không cần bất kỳ đối số nào để cho phép tệp tải xuống sử dụng downloadItem.filename cho tên tệp hoặc truyền đối tượng suggestion đến suggest để ghi đè tên tệp mục tiêu. Nếu có nhiều tiện ích ghi đè tên tệp, thì tiện ích được cài đặt gần đây nhất có trình nghe truyền đối tượng suggestion đến suggest sẽ được ưu tiên. Để tránh nhầm lẫn về việc tiện ích nào sẽ thắng, người dùng không nên cài đặt các tiện ích có thể xung đột. Nếu quá trình tải xuống được bắt đầu bằng download và tên tệp mục tiêu được biết trước khi loại MIME và tên tệp dự kiến được xác định, hãy chuyển filename đến download.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (downloadItem: DownloadItem, suggest: function) =& gt;void

onErased

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

Kích hoạt bằng downloadId khi một tệp tải xuống bị xoá khỏi nhật ký.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (downloadId: number) =& gt;void

    • downloadId

      số