Mô tả
API chrome.extension
có các tiện ích mà bất kỳ trang tiện ích nào cũng có thể sử dụng. Tiện ích này bao gồm tính năng hỗ trợ trao đổi thông báo giữa một tiện ích và các 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 Truyền thư.
Loại
ViewType
Loại chế độ xem phần mở rộng.
Enum
"thẻ"
"bật lên"
Thuộc tính
inIncognitoContext
Đúng đối với các tập lệnh nội dung chạy trong thẻ ẩn danh và đối với các trang tiện ích chạy trong quy trình ẩn danh. Chính sách sau chỉ áp dụng cho các tiện ích có từ "phân tách" hành vi ẩn danh.
Loại
boolean
lastError
Vui lòng sử dụng runtime.lastError
.
Đặt thời gian tồn tại của lệnh gọi lại nếu API tiện ích không đồng bộ gây ra lỗi. Nếu không xảy ra lỗi nào, lỗi cuối cùng 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()
chrome.extension.getBackgroundPage()
Trả về "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ề
-
Cửa sổ | chưa xác định
getExtensionTabs()
chrome.extension.getExtensionTabs(
windowId?: number,
)
Vui lòng sử dụng extension.getViews
{type: "tab"}
.
Trả về một mảng của "window" JavaScript cho mỗi tab chạy bên trong tiện ích hiện tại. Nếu windowId
được chỉ định, chỉ trả về "window" các đối tượng của thẻ được đính kèm vào cửa sổ cụ thể.
Tham số
-
windowId
số không bắt buộc
Giá trị trả về
-
Cửa sổ[]
Mảng đối tượng cửa sổ toàn cục
getURL()
chrome.extension.getURL(
path: string,
)
Vui lòng sử dụng runtime.getURL
.
Chuyển đổi một đườ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
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()
chrome.extension.getViews(
fetchProperties?: object,
)
Trả về một mảng của "window" 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ênTìm chế độ xem theo mã thẻ. Nếu trường này bị bỏ qua, hàm 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 tải. Nếu bị bỏ qua, sẽ trả về tất cả chế độ xem (bao gồm cả thẻ và trang nền).
-
windowId
số không bắt buộc
Cửa sổ giới hạn tìm kiếm. Nếu bỏ qua, hàm sẽ trả về tất cả chế độ xem.
-
Giá trị trả về
-
Cửa sổ[]
Mảng đối tượng toàn cục
isAllowedFileSchemeAccess()
chrome.extension.isAllowedFileSchemeAccess(
callback?: function,
)
Truy xuất trạng thái quyền truy cập của tiện ích vào "file://" hệ thống. Điều này tương ứng với tuỳ chọn 'Cho phép truy cập vào URL của tệp' do người dùng kiểm soát có thể truy cập 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
Đúng nếu tiện ích đó có thể truy cập vào "file://" lược đồ, nếu không thì sai.
-
Giá trị trả về
-
Promise<boolean>
Chrome 99 trở lênLờ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()
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. Điều này tương ứng với chế độ kiểm soát của mỗi tiện ích 'Được phép ở Chế độ ẩn danh' có thể truy cập 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ó quyền truy cập vào Chế độ ẩn danh. Nếu không, hãy đặt là "false".
-
Giá trị trả về
-
Promise<boolean>
Chrome 99 trở lênLờ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()
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 trên mỗi trang của phần mở rộng.
Tham 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ị bỏ qua, mặc định sẽ là tiện ích của riêng bạn.
-
request
bất kỳ
-
số gọi lại
hàm không bắt buộc
Chrome 99 trở lênTham 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, thì 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ề
-
Cam kết<bất kỳ>
Chrome 99 trở lênLờ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,
)
Đặt giá trị cho tham số CGI ap 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ố
-
dữ liệu
string
Sự kiện
onRequest
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ừ quy trình gia hạn 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
-
sendResponse
hàm
Tham số
sendResponse
sẽ có dạng như sau:() => void
-
onRequestExternal
chrome.extension.onRequestExternal.addListener(
callback: function,
)
Vui lòng sử dụng runtime.onMessageExternal
.
Được kích hoạt khi một tiện ích khác gửi yêu cầu.
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
-
sendResponse
hàm
Tham số
sendResponse
sẽ có dạng như sau:() => void
-