Trang này được dịch bởi Cloud Translation API.

chrome.extension

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ư mô tả chi tiết trong phần Chuyển thông báo.

Loại

ViewType

Chrome 44 trở lên

Loại thành phần hiển thị phần mở rộng.

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. Trường hợp sau chỉ áp dụng cho các tiện ích có incognito_behavior "phân tách".

Loại

boolean

lastError

&leq; MV2 Ngừng sử dụng kể từ Chrome 58

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

Đặt cho toàn bộ thời gian 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ỉ ở chế độ nền trước

chrome.extension.getBackgroundPage()

Trả về đối tượng "cửa sổ" 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ề

Window | undefined

getExtensionTabs()

&leq; 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ẻ đang 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ổ đã chỉ định.

Tham số

windowId

số không bắt buộc

Giá trị trả về

Window[]

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

getURL()

&leq; MV2 Ngừng sử dụng 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ố

đường dẫn

chuỗi

Đường dẫn đến một tài nguyên trong một tiện ích được thể hiện 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ỉ ở 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 mỗi 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 một thành phần 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ả thành phần hiển thị.
- loại
  
  ViewType không bắt buộc
  
  Loại chế độ xem cần lấy. Nếu bị bỏ qua, sẽ trả về tất cả thành phần hiển thị (bao gồm cả các trang và thẻ ở chế độ nền).
- windowId
  
  số không bắt buộc
  
  Cửa sổ để giới hạn phạm vi tìm kiếm. Nếu bị bỏ qua, sẽ trả về tất cả thành phần hiển thị.

Giá trị trả về

Window[]

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

isAllowedFileSchemeAccess()

Promise

chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

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

Tham số

lệnh gọi lại

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 giao thứ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 Tệp kê khai 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,
)

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

Tham số

lệnh gọi lại

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, nếu không thì sai.

Giá trị trả về

Promise<boolean>

Chrome 99 trở lên

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

sendRequest()

Lời hứa &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 có 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ã phần mở rộng của phần mở rộng mà bạn muốn kết nối. Nếu bạn bỏ qua thuộc tính này, giá trị mặc định sẽ là tiện ích của riêng bạn.
request

bất kỳ
lệnh gọi lại

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 kỳ
  
  Đố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ề

Promise<any>

Chrome 99 trở lên

Lời hứa chỉ được hỗ trợ cho Tệp kê khai 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,
)

Đặt giá trị của tham số CGI ap 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 được lưu trữ trong Thư viện tiện ích Chrome.

Tham số

dữ liệu

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ừ một quy trình mở rộng hoặc tập lệnh nội dung.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(request: any, sender: runtime.MessageSender, sendResponse: function) => void
```
- request
  
  bất kỳ
- người gửi
  
  runtime.MessageSender
- 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.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(request: any, sender: runtime.MessageSender, sendResponse: function) => void
```
- request
  
  bất kỳ
- người gửi
  
  runtime.MessageSender
- sendResponse
  
  hàm
  
  Tham số sendResponse có dạng như sau:
```
() => void
```