chrome.extension

refresh date: 2026-09-25 robots: noindex

Mô tả

API chrome.extension có các tiện ích mà mọi trang tiện ích đều có thể sử dụng. API này hỗ trợ việc trao đổi thông báo giữa một tiện ích và tập lệnh nội dung của tiện ích đó hoặc giữa các tiện ích, như được mô tả chi tiết trong phần Truyền thông báo.

Loại

ViewType

Chrome 44 trở lên

Loại chế độ xem tiện ích.

Enum

"tab"

"popup"

Thuộc tính

inIncognitoContext

Đúng đối với các tập lệnh nội dung chạy bên trong thẻ ẩn danh và đối với các trang tiện ích chạy bên trong một quy trình ẩn danh. Điều kiện sau chỉ áp dụng cho các tiện ích có incognito_behavior "phân tách".

Loại

boolean

lastError

≤ MV2 Ngừng sử dụng kể từ Chrome 58

Vui lòng sử dụng runtime.lastError.

Đặt cho thời gian hoạt động của lệnh gọi lại nếu một API tiện ích không đồng bộ dẫn đến lỗi. Nếu không có lỗi nào xảy ra, lastError sẽ là undefined.

Loại

đối tượng

Thuộc tính

  • tin nhắn

    chuỗi

    Nội dung mô tả lỗi đã xảy ra.

Phương thức

getBackgroundPage()

Chỉ nền trước
chrome.extension.getBackgroundPage(): Window | undefined

Trả về đối tượng "window" JavaScript cho trang nền đang chạy bên trong tiện ích hiện tại. Trả về giá trị rỗng nếu tiện ích không có trang nền.

Giá trị trả về

  • Cửa sổ | chưa xác định

getExtensionTabs()

≤ MV2 Chỉ nền trước Không dùng nữa
chrome.extension.getExtensionTabs(
  windowId?: number,
)
: Window[]

Vui lòng sử dụng extension.getViews {type: "tab"}.

Trả về một mảng các đối tượng "cửa sổ" JavaScript cho mỗi thẻ đang chạy bên trong tiện ích hiện tại. Nếu bạn chỉ định windowId, thì hàm này chỉ trả về các đối tượng "cửa sổ" của các thẻ được đính kèm vào cửa sổ đã chỉ định.

Thông số

  • windowId

    number không bắt buộc

Giá trị trả về

  • Window[]

    Mảng đối tượng cửa sổ chung

getURL()

≤ MV2 Không dùng nữa kể từ Chrome 58
chrome.extension.getURL(
  path: string,
)
: string

Vui lòng sử dụng runtime.getURL.

Chuyển đổi đường dẫn tương đối trong thư mục cài đặt tiện ích thành URL đủ điều kiện.

Thông số

  • đường dẫn

    chuỗi

    Đường dẫn đến một tài nguyên trong một tiện ích được biểu thị tương ứng với thư mục cài đặt của tiện ích đó.

Giá trị trả về

  • chuỗi

    URL đủ điều kiện đến tài nguyên.

getViews()

Chỉ nền trước
chrome.extension.getViews(
  fetchProperties?: object,
)
: Window[]

Trả về một mảng các đối tượng "window" JavaScript cho mỗi trang đang chạy bên trong tiện ích hiện tại.

Thông số

  • fetchProperties

    object không bắt buộc

    • tabId

      number không bắt buộc

      Chrome 54 trở lên

      Tìm một khung hiển thị theo mã thẻ. Nếu bạn bỏ qua trường này, hệ thống sẽ trả về tất cả các chế độ xem.

    • loại

      ViewType không bắt buộc

      Loại chế độ xem cần lấy. Nếu bạn bỏ qua, hàm này sẽ trả về tất cả các chế độ xem (bao gồm cả trang và thẻ nền).

    • windowId

      number không bắt buộc

      Cửa sổ để giới hạn phạm vi tìm kiếm. Nếu bạn bỏ qua, hàm sẽ trả về tất cả các chế độ xem.

Giá trị trả về

  • Window[]

    Mảng đối tượng toàn cục

isAllowedFileSchemeAccess()

Promise
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)
: Promise<boolean>

Truy xuất trạng thái quyền truy cập của tiện ích vào lược đồ "file://". Chế độ này tương ứng với chế độ cài đặt "Cho phép truy cập vào URL tệp" do người dùng kiểm soát cho từng tiện ích, có thể truy cập thông qua trang chrome://extensions.

Thông số

  • callback

    hàm không bắt buộc

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      Đúng nếu tiện ích có thể truy cập vào lược đồ "file://", nếu không thì là sai.

Giá trị trả về

  • Promise<boolean>

    Chrome 99 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

isAllowedIncognitoAccess()

Promise
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)
: Promise<boolean>

Truy xuất trạng thái quyền truy cập của tiện ích vào chế độ ẩn danh. Chế độ này tương ứng với chế độ cài đặt "Được phép ở chế độ ẩn danh" do người dùng kiểm soát cho từng tiện ích, có thể truy cập thông qua trang chrome://extensions.

Thông số

  • callback

    hàm không bắt buộc

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      Đúng nếu tiện ích có quyền truy cập vào Chế độ ẩn danh, sai nếu không.

Giá trị trả về

  • Promise<boolean>

    Chrome 99 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

sendRequest()

Promise &leq; MV2 Không dùng nữa
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)
: Promise<any>

Vui lòng sử dụng runtime.sendMessage.

Gửi một yêu cầu duy nhất đến các trình nghe khác trong tiện ích. Tương tự như runtime.connect, nhưng chỉ gửi một yêu cầu duy nhất kèm theo phản hồi không bắt buộc. Sự kiện extension.onRequest được kích hoạt trong mỗi trang của tiện ích.

Thông số

  • extensionId

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

    Mã tiện ích của tiện ích mà bạn muốn kết nối. Nếu bạn bỏ qua, thì tiện ích mặc định sẽ là tiện ích của riêng bạn.

  • request

    bất kỳ

  • callback

    hàm không bắt buộc

    Chrome 99 trở lên

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

    (response: any) => void

    • phản hồi

      bất kỳ

      Đối tượng phản hồi JSON do trình xử lý yêu cầu gửi. Nếu xảy ra lỗi khi kết nối với tiện ích, thì lời hứa sẽ bị từ chối.

Giá trị trả về

  • Promise<any>

    Chrome 99 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)
: void

Đặt giá trị của tham số CGI ap được dùng trong URL cập nhật của tiện ích. Giá trị này bị bỏ qua đối với các tiện ích Chrome được lưu trữ trong Thư viện tiện ích của Chrome.

Thông số

  • khác

    chuỗi

Sự kiện

onRequest

&leq; MV2 Không dùng nữa
chrome.extension.onRequest.addListener(
  callback: function,
)

Vui lòng sử dụng runtime.onMessage.

Được kích hoạt khi một yêu cầu được gửi từ quy trình tiện ích hoặc tập lệnh nội dung.

Thông số

  • callback

    hàm

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

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • request

      bất kỳ

    • người gửi
    • sendResponse

      hàm

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

      () => void

onRequestExternal

&leq; MV2 Không dùng nữa
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Vui lòng sử dụng runtime.onMessageExternal.

Được kích hoạt khi một yêu cầu được gửi từ một tiện ích khác.

Thông số

  • callback

    hàm

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

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • request

      bất kỳ

    • người gửi
    • sendResponse

      hàm

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

      () => void