chrome.extension

Nội dung mô tả

API chrome.extension có các tiện ích mà mọi trang tiện ích đều có thể dùng. Phiên bản này hỗ trợ trao đổi thư 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ư mô tả chi tiết trong phần Chuyển thư.

Loại

ViewType

Chrome 44 trở lên

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

Liệt kê

"tab"

Thuộc tính

inIncognitoContext

True cho tập lệnh nội dung chạy trong các thẻ ẩn danh và cho các trang tiện ích chạy trong một quy trình ẩn danh. Chính sách thứ hai chỉ áp dụng cho các tiện ích có hành vi "phân chia" (anonymous_behavior).

Loại

boolean

lastError

≤ MV2 Không dùng nữa kể từ Chrome 58

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

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

Loại

đối tượng

Thuộc tính

  • tin nhắn

    string

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

Phương thức

getBackgroundPage()

Chỉ nền trước 
chrome.extension.getBackgroundPage()

Trả về đối tượng 'window' JavaScript cho trang nền 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ổ|không xác định

getExtensionTabs()

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

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 từng thẻ chạy bên trong tiện ích hiện tại. Nếu windowId được chỉ định, 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ổ được chỉ định.

Tham số

  • windowId

    số không bắt buộc

Giá trị trả về

  • Cửa sổ[]

    Mảng các đối tượng cửa sổ toàn cục

getURL()

≤ MV2 Không dùng nữa kể từ Chrome 58
chrome.extension.getURL(
  path: 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.

Tham số

  • path

    string

    Đường dẫn đến tài nguyên trong 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ề

  • string

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

getViews()

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

Trả về một mảng các đối tượng "cửa sổ" JavaScript cho từng trang chạy bên trong tiện ích hiện tại.

Tham số

  • fetchProperties

    đối tượng không bắt buộc

    • tabId

      số không bắt buộc

      Chrome 54 trở lên

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

    • loại

      ViewType không bắt buộc

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

    • windowId

      số không bắt buộc

      Cửa sổ để hạn chế tìm kiếm. Nếu bỏ qua, trả về tất cả chế độ xem.

Giá trị trả về

  • Cửa sổ[]

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

isAllowedFileSchemeAccess()

Cam kết 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

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

Tham số

  • số gọi lại

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

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

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      "True" nếu tiện ích có thể truy cập giao thức "file://", "false" nếu không tiện ích có thể truy cập.

Giá trị trả về

  • Promise<boolean>

    Chrome 99 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

isAllowedIncognitoAccess()

Cam kết 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

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

Tham số

  • số gọi lại

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

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

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      "True" nếu tiện ích có quyền truy cập vào Chế độ ẩn danh, nếu không tiện ích có quyền truy cập vào Chế độ ẩn danh, thì giá trị sẽ là false.

Giá trị trả về

  • Promise<boolean>

    Chrome 99 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến 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,
)

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.

Tham số

  • extensionId

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

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

  • request

    Bất kỳ

  • số gọi lại

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

    Chrome 99 trở lên

    Tham số callback sẽ 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 trong khi kết nối với tiện ích, lệnh gọi lại sẽ được gọi mà không có đối số và runtime.lastError sẽ được đặt thành thông báo lỗi.

Giá trị trả về

  • Hứa hẹn<any>

    Chrome 99 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp để có khả năng tương thích ngược. Bạn không thể sử dụng cả hai trong cùng một lệnh gọi hàm. Lời hứa sẽ được phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Đặ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 sẽ bị bỏ qua đối với các tiện ích được lưu trữ trong Thư viện tiện ích của Chrome.

Tham số

  • data

    string

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 yêu cầu được gửi từ quá trình tiện ích hoặc tập lệnh nội dung.

Tham số

  • số gọi lại

    hàm

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

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

    • request

      Bất kỳ

    • người gửi

      runtime.MessageSender

    • sendResponse

      hàm

      Tham số sendResponse sẽ 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 yêu cầu được gửi từ một tiện ích khác.

Tham số

  • số gọi lại

    hàm

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

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

    • request

      Bất kỳ

    • người gửi

      runtime.MessageSender

    • sendResponse

      hàm

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

      ()=>void