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

chrome.runtime

Mô tả

Sử dụng API chrome.runtime để truy xuất worker dịch vụ, trả về thông tin chi tiết về tệp kê khai, đồng thời theo dõi và phản hồi các sự kiện trong vòng đời của tiện ích. Bạn cũng có thể sử dụng API này để chuyển đổi đường dẫn tương đối của URL thành URL đủ điều kiện.

Hầu hết các thành viên của API này không yêu cầu bất kỳ quyền nào. Bạn cần có quyền này cho connectNative(), sendNativeMessage() và onNativeConnect.

Ví dụ sau đây cho biết cách khai báo quyền "nativeMessaging" trong tệp kê khai:

manifest.json:

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

Khái niệm và cách sử dụng

API Thời gian chạy cung cấp các phương thức để hỗ trợ một số khu vực mà tiện ích của bạn có thể sử dụng:

Truyền tin: Tiện ích của bạn có thể giao tiếp với nhiều ngữ cảnh trong tiện ích và với các tiện ích khác bằng các phương thức và sự kiện sau: connect(), onConnect, onConnectExternal, sendMessage(), onMessage và onMessageExternal. Ngoài ra, tiện ích của bạn có thể truyền thông báo đến các ứng dụng gốc trên thiết bị của người dùng bằng cách sử dụng connectNative() và sendNativeMessage().

Truy cập siêu dữ liệu của tiện ích và nền tảng: Các phương thức này cho phép bạn truy xuất một số siêu dữ liệu cụ thể về tiện ích và nền tảng. Các phương thức trong danh mục này bao gồm getManifest() và getPlatformInfo().
Quản lý vòng đời và các tuỳ chọn của tiện ích: Các thuộc tính này cho phép bạn thực hiện một số thao tác siêu dữ liệu trên tiện ích và hiển thị trang tuỳ chọn. Các phương thức và sự kiện trong danh mục này bao gồm onInstalled, onStartup, openOptionsPage(), reload(), requestUpdateCheck() và setUninstallURL().
Tiện ích trợ giúp: Các phương thức này cung cấp tiện ích như chuyển đổi nội dung trình bày tài nguyên nội bộ sang các định dạng bên ngoài. Các phương thức trong danh mục này bao gồm getURL().
Tiện ích chế độ Kiosk: Các phương thức này chỉ có trên ChromeOS và chủ yếu dùng để hỗ trợ triển khai kiosk. Các phương thức trong danh mục này bao gồm restart() và restartAfterDelay()`.

Hành vi của tiện ích chưa được giải nén

Khi một tiện ích đã giải nén được tải lại, thao tác này sẽ được coi là một bản cập nhật. Điều này có nghĩa là sự kiện chrome.runtime.onInstalled sẽ kích hoạt với lý do "update". Điều này bao gồm cả thời điểm tiện ích được tải lại bằng chrome.runtime.reload().

Trường hợp sử dụng

Thêm hình ảnh vào trang web

Để truy cập vào một thành phần được lưu trữ trên một miền khác, trang web phải chỉ định URL đầy đủ của tài nguyên đó (ví dụ: <img src="https://example.com/logo.png">). Điều này cũng đúng khi đưa một thành phần mở rộng vào trang web. Hai điểm khác biệt là các thành phần của tiện ích phải được hiển thị dưới dạng tài nguyên có thể truy cập trên web và thường thì tập lệnh nội dung sẽ chịu trách nhiệm chèn các thành phần tiện ích.

Trong ví dụ này, tiện ích sẽ thêm logo.png vào trang mà tập lệnh nội dung đang được chèn vào bằng cách sử dụng runtime.getURL() để tạo một URL đủ điều kiện. Tuy nhiên, trước tiên, bạn phải khai báo thành phần này dưới dạng tài nguyên có thể truy cập trên web trong tệp kê khai.

manifest.json:

{
  ...
  "web_accessible_resources": [
    {
      "resources": [ "logo.png" ],
      "matches": [ "https://*/*" ]
    }
  ],
  ...
}

content.js:

{ // Block used to avoid setting global variables
  const img = document.createElement('img');
  img.src = chrome.runtime.getURL('logo.png');
  document.body.append(img);
}

Gửi dữ liệu từ tập lệnh nội dung đến worker dịch vụ

Thông thường, tập lệnh nội dung của một tiện ích cần có dữ liệu do một phần khác của tiện ích quản lý, chẳng hạn như worker dịch vụ. Tương tự như hai cửa sổ trình duyệt mở ra cùng một trang web, hai ngữ cảnh này không thể trực tiếp truy cập vào giá trị của nhau. Thay vào đó, tiện ích có thể sử dụng tính năng truyền thông báo để điều phối trên các ngữ cảnh khác nhau này.

Trong ví dụ này, tập lệnh nội dung cần một số dữ liệu từ worker dịch vụ của tiện ích để khởi chạy giao diện người dùng. Để lấy dữ liệu này, ứng dụng sẽ truyền thông báo get-user-data do nhà phát triển xác định đến worker dịch vụ và phản hồi bằng bản sao thông tin của người dùng.

content.js:

// 1. Send a message to the service worker requesting the user's data
chrome.runtime.sendMessage('get-user-data', (response) => {
  // 3. Got an asynchronous response with the data from the service worker
  console.log('received user data', response);
  initializeUI(response);
});

service-worker.js:

// Example of a simple user data object
const user = {
  username: 'demo-user'
};

chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
  // 2. A page requested user data, respond with a copy of `user`
  if (message === 'get-user-data') {
    sendResponse(user);
  }
});

Thu thập ý kiến phản hồi về việc gỡ cài đặt

Nhiều tiện ích sử dụng các cuộc khảo sát sau khi gỡ cài đặt để tìm hiểu cách tiện ích có thể phục vụ người dùng tốt hơn và cải thiện tỷ lệ giữ chân. Ví dụ sau đây cho thấy cách thêm chức năng này.

background.js:

chrome.runtime.onInstalled.addListener(details => {
  if (details.reason === chrome.runtime.OnInstalledReason.INSTALL) {
    chrome.runtime.setUninstallURL('https://example.com/extension-survey');
  }
});

Ví dụ

Xem Manifest V3 – Bản minh hoạ về tài nguyên có thể truy cập trên web để biết thêm ví dụ về API thời gian chạy.

Loại

ContextFilter

Chrome 114 trở lên

Một bộ lọc để so khớp với một số ngữ cảnh tiện ích nhất định. Ngữ cảnh phù hợp phải khớp với tất cả bộ lọc đã chỉ định; mọi bộ lọc không được chỉ định đều khớp với tất cả ngữ cảnh có sẵn. Do đó, bộ lọc `{}` sẽ khớp với tất cả ngữ cảnh có sẵn.

Thuộc tính

contextIds

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

ContextType[] không bắt buộc
documentIds

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

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

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

number[] không bắt buộc
ẩn danh

boolean không bắt buộc
tabIds

number[] không bắt buộc
windowIds

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

ContextType

Chrome 114 trở lên

Enum

"TAB"
Chỉ định loại ngữ cảnh là thẻ

"POPUP"
Chỉ định loại ngữ cảnh là cửa sổ bật lên của tiện ích

"BACKGROUND"
Chỉ định loại ngữ cảnh là worker dịch vụ.

"OFFSCREEN_DOCUMENT"
Chỉ định loại ngữ cảnh là tài liệu ngoài màn hình.

"SIDE_PANEL"
Chỉ định loại ngữ cảnh là bảng điều khiển bên.

"DEVELOPER_TOOLS"
Chỉ định loại ngữ cảnh là công cụ dành cho nhà phát triển.

ExtensionContext

Chrome 114 trở lên

Ngữ cảnh lưu trữ nội dung tiện ích.

Thuộc tính

contextId

chuỗi

Giá trị nhận dạng duy nhất cho ngữ cảnh này
contextType

ContextType

Loại ngữ cảnh tương ứng với thông tin này.
documentId

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

UUID cho tài liệu được liên kết với ngữ cảnh này hoặc không xác định nếu ngữ cảnh này không được lưu trữ trong tài liệu.
documentOrigin

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

Nguồn gốc của tài liệu được liên kết với ngữ cảnh này hoặc không xác định nếu ngữ cảnh không được lưu trữ trong tài liệu.
documentUrl

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

URL của tài liệu được liên kết với ngữ cảnh này hoặc không xác định nếu ngữ cảnh không được lưu trữ trong tài liệu.
frameId

số

Mã của khung cho ngữ cảnh này hoặc -1 nếu ngữ cảnh này không được lưu trữ trong khung.
ẩn danh

boolean

Liệu ngữ cảnh có liên kết với hồ sơ ẩn danh hay không.
tabId

số

Mã của thẻ cho ngữ cảnh này hoặc -1 nếu ngữ cảnh này không được lưu trữ trong thẻ.
windowId

số

Mã của cửa sổ cho ngữ cảnh này hoặc -1 nếu ngữ cảnh này không được lưu trữ trong cửa sổ.

MessageSender

Một đối tượng chứa thông tin về ngữ cảnh tập lệnh đã gửi một thông báo hoặc yêu cầu.

Thuộc tính

documentId

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

Chrome 106 trở lên

UUID của tài liệu đã mở kết nối.
documentLifecycle

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

Chrome 106 trở lên

Vòng đời của tài liệu đã mở kết nối tại thời điểm tạo cổng. Xin lưu ý rằng trạng thái vòng đời của tài liệu có thể đã thay đổi kể từ khi tạo cổng.
frameId

số không bắt buộc

Khung đã mở kết nối. 0 đối với khung cấp cao nhất, dương đối với khung con. Giá trị này sẽ chỉ được đặt khi bạn đặt tab.
id

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

Mã của phần mở rộng đã mở kết nối, nếu có.
nativeApplication

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

Chrome 74 trở lên

Tên của ứng dụng gốc đã mở kết nối, nếu có.
nguồn gốc

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

Chrome 80 trở lên

Nguồn gốc của trang hoặc khung đã mở kết nối. URL này có thể khác với thuộc tính url (ví dụ: about:blank) hoặc có thể không rõ ràng (ví dụ: iframe trong hộp cát). Điều này hữu ích để xác định xem có thể tin tưởng nguồn gốc hay không nếu chúng ta không thể xác định ngay từ URL.
phím tab

Tab không bắt buộc

tabs.Tab đã mở kết nối, nếu có. Thuộc tính này chỉ xuất hiện khi kết nối được mở từ một thẻ (bao gồm cả tập lệnh nội dung) và chỉ nếu trình nhận là một tiện ích chứ không phải ứng dụng.
tlsChannelId

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

Mã nhận dạng kênh TLS của trang hoặc khung đã mở kết nối, nếu tiện ích yêu cầu và nếu có.
url

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

URL của trang hoặc khung đã mở kết nối. Nếu người gửi nằm trong một iframe, thì đó sẽ là URL của iframe chứ không phải URL của trang lưu trữ iframe đó.

OnInstalledReason

Chrome 44 trở lên

Lý do sự kiện này được gửi.

Enum

"install"
Chỉ định lý do sự kiện là một lượt cài đặt.

"update"
Chỉ định lý do sự kiện là bản cập nhật tiện ích.

"chrome_update"
Chỉ định lý do của sự kiện là bản cập nhật Chrome.

"shared_module_update"
Chỉ định lý do của sự kiện là nội dung cập nhật cho một mô-đun dùng chung.

OnRestartRequiredReason

Chrome 44 trở lên

Lý do sự kiện đang được gửi. "app_update" được dùng khi cần khởi động lại vì ứng dụng được cập nhật lên phiên bản mới hơn. "os_update" được dùng khi cần khởi động lại vì trình duyệt/hệ điều hành được cập nhật lên phiên bản mới hơn. "thường xuyên" được dùng khi hệ thống chạy trong thời gian dài hơn thời gian hoạt động được phép đặt trong chính sách doanh nghiệp.

Enum

"app_update"
Chỉ định lý do của sự kiện là bản cập nhật cho ứng dụng.

"os_update"
Chỉ định lý do của sự kiện là bản cập nhật cho hệ điều hành.

"periodic" (chu kỳ)
Chỉ định lý do sự kiện là khởi động lại ứng dụng theo chu kỳ.

PlatformArch

Chrome 44 trở lên

Kiến trúc bộ xử lý của máy.

Enum

"arm"
Chỉ định cấu trúc bộ xử lý là arm.

"arm64"
Chỉ định kiến trúc bộ xử lý là arm64.

"x86-32"
Chỉ định cấu trúc bộ xử lý là x86-32.

"x86-64"
Chỉ định cấu trúc bộ xử lý là x86-64.

"mips"
Chỉ định cấu trúc bộ xử lý là mips.

"mips64"
Chỉ định kiến trúc bộ xử lý là mips64.

PlatformInfo

Một đối tượng chứa thông tin về nền tảng hiện tại.

Thuộc tính

vòm

PlatformArch

Kiến trúc bộ xử lý của máy.
nacl_arch

PlatformNaclArch

Cấu trúc ứng dụng gốc. Điều này có thể khác với arch trên một số nền tảng.
hệ điều hành

PlatformOs

Hệ điều hành mà Chrome đang chạy.

PlatformNaclArch

Chrome 44 trở lên

Cấu trúc ứng dụng gốc. Điều này có thể khác với arch trên một số nền tảng.

Enum

"arm"
Chỉ định cấu trúc ứng dụng gốc là arm.

"x86-32"
Chỉ định cấu trúc ứng dụng gốc là x86-32.

"x86-64"
Chỉ định cấu trúc ứng dụng gốc là x86-64.

"mips"
Chỉ định cấu trúc ứng dụng gốc là mips.

"mips64"
Chỉ định kiến trúc ứng dụng gốc là mips64.

PlatformOs

Chrome 44 trở lên

Hệ điều hành mà Chrome đang chạy.

Enum

"mac"
Chỉ định hệ điều hành MacOS.

"win"
Chỉ định hệ điều hành Windows.

"android"
Chỉ định hệ điều hành Android.

"cros"
Chỉ định hệ điều hành Chrome.

"linux"
Chỉ định hệ điều hành Linux.

"openbsd"
Chỉ định hệ điều hành OpenBSD.

"fuchsia"
Chỉ định hệ điều hành Fuchsia.

Port

Một đối tượng cho phép giao tiếp hai chiều với các trang khác. Hãy xem phần Kết nối dài hạn để biết thêm thông tin.

Thuộc tính

tên

chuỗi

Tên của cổng, như được chỉ định trong lệnh gọi đến runtime.connect.
onDisconnect

Event<functionvoidvoid>

Được kích hoạt khi cổng bị ngắt kết nối với(các) đầu kia. Bạn có thể đặt runtime.lastError nếu cổng bị ngắt kết nối do lỗi. Nếu cổng bị đóng bằng cách ngắt kết nối, thì sự kiện này chỉ được kích hoạt ở đầu kia. Sự kiện này được kích hoạt nhiều nhất một lần (xem thêm Vòng đời của cổng).

Hàm onDisconnect.addListener có dạng như sau:
```
(callback: function) => {...}
```
- lệnh gọi lại
  
  hàm
  
  Tham số callback có dạng như sau:
```
(port: Port) => void
```
  - cổng
    
    Cổng
onMessage

Event<functionvoidvoid>

Sự kiện này được kích hoạt khi postMessage được gọi bởi đầu kia của cổng.

Hàm onMessage.addListener có dạng như sau:
```
(callback: function) => {...}
```
- lệnh gọi lại
  
  hàm
  
  Tham số callback có dạng như sau:
```
(message: any, port: Port) => void
```
  - tin nhắn
    
    bất kỳ
  - cổng
    
    Cổng
người gửi

MessageSender không bắt buộc

Thuộc tính này chỉ xuất hiện trên các cổng được truyền đến trình nghe onConnect / onConnectExternal / onConnectNative.
ngắt kết nối

void

Ngắt kết nối cổng ngay lập tức. Việc gọi disconnect() trên một cổng đã ngắt kết nối sẽ không có hiệu lực. Khi một cổng bị ngắt kết nối, sẽ không có sự kiện mới nào được gửi đến cổng này.

Hàm disconnect có dạng như sau:
```
() => {...}
```
postMessage

void

Gửi thông báo đến đầu kia của cổng. Nếu cổng bị ngắt kết nối, hệ thống sẽ gửi một lỗi.

Hàm postMessage có dạng như sau:
```
(message: any) => {...}
```
- tin nhắn
  
  bất kỳ
  
  Chrome 52 trở lên
  
  Tin nhắn cần gửi. Đối tượng này phải có thể chuyển đổi sang JSON.

RequestUpdateCheckStatus

Chrome 44 trở lên

Kết quả kiểm tra bản cập nhật.

Enum

"throttled"
Chỉ định rằng quá trình kiểm tra trạng thái đã bị điều tiết. Điều này có thể xảy ra sau khi bạn kiểm tra nhiều lần trong một khoảng thời gian ngắn.

"no_update"
Chỉ định rằng không có bản cập nhật nào để cài đặt.

"update_available"
Chỉ định rằng có bản cập nhật để cài đặt.

Thuộc tính

id

Mã của phần mở rộng/ứng dụng.

Loại

chuỗi

lastError

Được điền sẵn thông báo lỗi nếu lệnh gọi hàm API không thành công; nếu không thì không xác định. Giá trị này chỉ được xác định trong phạm vi lệnh gọi lại của hàm đó. Nếu xảy ra lỗi nhưng runtime.lastError không được truy cập trong lệnh gọi lại, thì một thông báo sẽ được ghi vào bảng điều khiển liệt kê hàm API đã tạo ra lỗi. Các hàm API trả về lời hứa không đặt thuộc tính này.

Loại

đối tượng

Thuộc tính

tin nhắn

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

Thông tin chi tiết về lỗi đã xảy ra.

Phương thức

connect()

chrome.runtime.connect(
  extensionId?: string,
  connectInfo?: object,
)

Cố gắng kết nối trình nghe trong một tiện ích (chẳng hạn như trang nền) hoặc các tiện ích/ứng dụng khác. Điều này rất hữu ích cho các tập lệnh nội dung kết nối với các quy trình tiện ích, giao tiếp giữa các ứng dụng/tiện ích và tính năng nhắn tin trên web. Xin lưu ý rằng phương thức này không kết nối với bất kỳ trình nghe nào trong tập lệnh nội dung. Các tiện ích có thể kết nối với tập lệnh nội dung được nhúng trong các thẻ thông qua tabs.connect.

Tham số

extensionId

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

Mã của phần mở rộng cần kết nối. Nếu bạn bỏ qua, hệ thống sẽ cố gắng kết nối bằng tiện ích của riêng bạn. Bắt buộc nếu gửi tin nhắn từ một trang web để nhắn tin trên web.
connectInfo

đối tượng không bắt buộc
- includeTlsChannelId
  
  boolean không bắt buộc
  
  Liệu mã nhận dạng kênh TLS có được truyền vào onConnectExternal cho các quy trình đang nghe sự kiện kết nối hay không.
- tên
  
  chuỗi không bắt buộc
  
  Sẽ được truyền vào onConnect cho các quy trình đang nghe sự kiện kết nối.

Giá trị trả về

Cổng

Cổng mà qua đó có thể gửi và nhận tin nhắn. Sự kiện onDisconnect của cổng sẽ được kích hoạt nếu tiện ích không tồn tại.

connectNative()

chrome.runtime.connectNative(
  application: string,
)

Kết nối với một ứng dụng gốc trong máy chủ lưu trữ. Phương thức này yêu cầu quyền "nativeMessaging". Hãy xem phần Nhắn tin gốc để biết thêm thông tin.

Tham số

ứng dụng

chuỗi

Tên của ứng dụng đã đăng ký để kết nối.

Giá trị trả về

Cổng

Cổng mà qua đó có thể gửi và nhận tin nhắn bằng ứng dụng

getBackgroundPage()

Lời hứa Chỉ ở chế độ nền trước

chrome.runtime.getBackgroundPage(
  callback?: function,
)

Truy xuất đối tượng "cửa sổ" JavaScript cho trang nền chạy bên trong tiện ích/ứng dụng hiện tại. Nếu trang nền là trang sự kiện, hệ thống sẽ đảm bảo trang đó được tải trước khi gọi lệnh gọi lại. Nếu không có trang nền, hệ thống sẽ đặt lỗi.

Tham số

lệnh gọi lại

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

Tham số callback có dạng như sau:
```
(backgroundPage?: Window) => void
```
- backgroundPage
  
  Cửa sổ không bắt buộc
  
  Đối tượng "cửa sổ" JavaScript cho trang nền.

Giá trị trả về

Promise<Window | undefined>

Chrome 99 trở lên

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

getContexts()

Lời hứa Chrome 116 trở lên MV3 trở lên

chrome.runtime.getContexts(
  filter: ContextFilter,
  callback?: function,
)

Tìm nạp thông tin về các ngữ cảnh đang hoạt động liên kết với tiện ích này

Tham số

filter

ContextFilter

Bộ lọc để tìm ngữ cảnh phù hợp. Một ngữ cảnh khớp nếu khớp với tất cả các trường được chỉ định trong bộ lọc. Mọi trường không được chỉ định trong bộ lọc đều khớp với tất cả ngữ cảnh.
lệnh gọi lại

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

Tham số callback có dạng như sau:
```
(contexts: ExtensionContext[]) => void
```
- ngữ cảnh
  
  ExtensionContext[]
  
  Ngữ cảnh trùng khớp, nếu có.

Giá trị trả về

Promise<ExtensionContext[]>

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

getManifest()

chrome.runtime.getManifest()

Trả về thông tin chi tiết về ứng dụng hoặc tiện ích trong tệp kê khai. Đối tượng được trả về là một quá trình chuyển đổi tuần tự của tệp kê khai đầy đủ.

Giá trị trả về

đối tượng

Thông tin chi tiết về tệp kê khai.

getPackageDirectoryEntry()

Lời hứa Chỉ ở chế độ nền trước

chrome.runtime.getPackageDirectoryEntry(
  callback?: function,
)

Trả về một DirectoryEntry cho thư mục gói.

Tham số

lệnh gọi lại

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

Tham số callback có dạng như sau:
```
(directoryEntry: DirectoryEntry) => void
```
- directoryEntry
  
  DirectoryEntry

Giá trị trả về

Promise<DirectoryEntry>

Chrome 122 trở lên

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

getPlatformInfo()

Promise

chrome.runtime.getPlatformInfo(
  callback?: function,
)

Trả về thông tin về nền tảng hiện tại.

Tham số

lệnh gọi lại

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

Tham số callback có dạng như sau:
```
(platformInfo: PlatformInfo) => void
```
- platformInfo
  
  PlatformInfo

Giá trị trả về

Promise<PlatformInfo>

Chrome 99 trở lên

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

getURL()

chrome.runtime.getURL(
  path: string,
)

Chuyển đổi đường dẫn tương đối trong thư mục cài đặt ứng dụng/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 ứng dụng/tiện ích được thể hiện tương ứng với thư mục cài đặt của tài nguyên đó.

Giá trị trả về

chuỗi

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

openOptionsPage()

Promise

chrome.runtime.openOptionsPage(
  callback?: function,
)

Mở trang tuỳ chọn của Tiện ích (nếu có thể).

Hành vi chính xác có thể phụ thuộc vào khoá options_ui hoặc options_page của tệp kê khai hoặc những gì Chrome hỗ trợ tại thời điểm đó. Ví dụ: trang có thể được mở trong một thẻ mới, trong chrome://extensions, trong một Ứng dụng hoặc chỉ có thể lấy tiêu điểm là một trang tuỳ chọn đang mở. Lệnh này sẽ không bao giờ khiến trang phương thức gọi phải tải lại.

Nếu Tiện ích của bạn không khai báo trang tuỳ chọn hoặc Chrome không tạo được trang tuỳ chọn vì lý do nào đó, thì lệnh gọi lại sẽ đặt lastError.

Tham số

lệnh gọi lại

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

Tham số callback có dạng như sau:
```
() => void
```

Giá trị trả về

Promise<void>

Chrome 99 trở lên

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

reload()

chrome.runtime.reload()

Tải lại ứng dụng hoặc tiện ích. Phương thức này không được hỗ trợ ở chế độ kiosk. Đối với chế độ kiosk, hãy sử dụng phương thức chrome.runtime.restart().

requestUpdateCheck()

Promise

chrome.runtime.requestUpdateCheck(
  callback?: function,
)

Yêu cầu kiểm tra bản cập nhật ngay lập tức cho ứng dụng/tiện ích này.

Lưu ý quan trọng: Hầu hết các tiện ích/ứng dụng không nên sử dụng phương thức này vì Chrome đã tự động kiểm tra vài giờ một lần và bạn có thể nghe sự kiện runtime.onUpdateAvailable mà không cần gọi requestUpdateCheck.

Phương thức này chỉ thích hợp để gọi trong một số ít trường hợp, chẳng hạn như nếu tiện ích của bạn giao tiếp với một dịch vụ phụ trợ và dịch vụ phụ trợ đã xác định rằng phiên bản tiện ích ứng dụng đã lỗi thời và bạn muốn nhắc người dùng cập nhật. Hầu hết các trường hợp sử dụng khác của requestUpdateCheck, chẳng hạn như gọi hàm này một cách vô điều kiện dựa trên bộ hẹn giờ lặp lại, có thể chỉ làm lãng phí tài nguyên máy khách, mạng và máy chủ.

Lưu ý: Khi được gọi bằng lệnh gọi lại, thay vì trả về một đối tượng, hàm này sẽ trả về hai thuộc tính dưới dạng các đối số riêng biệt được truyền đến lệnh gọi lại.

Tham số

lệnh gọi lại

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

Tham số callback có dạng như sau:
```
(result: object) => void
```
- kết quả
  
  đối tượng
  
  Chrome 109 trở lên
  
  Đối tượng RequestUpdateCheckResult chứa trạng thái của quá trình kiểm tra bản cập nhật và mọi thông tin chi tiết về kết quả nếu có bản cập nhật
  - trạng thái
    
    RequestUpdateCheckStatus
    
    Kết quả kiểm tra bản cập nhật.
  - version
    
    chuỗi không bắt buộc
    
    Nếu có bản cập nhật, thuộc tính này sẽ chứa phiên bản của bản cập nhật hiện có.

Giá trị trả về

Promise<object>

Chrome 109 trở lên

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

restart()

chrome.runtime.restart()

Khởi động lại thiết bị ChromeOS khi ứng dụng chạy ở chế độ kiosk. Nếu không, thao tác này sẽ không có tác dụng.

restartAfterDelay()

Lời hứa Chrome 53 trở lên

chrome.runtime.restartAfterDelay(
  seconds: number,
  callback?: function,
)

Khởi động lại thiết bị ChromeOS khi ứng dụng chạy ở chế độ kiosk sau số giây đã cho. Nếu được gọi lại trước khi hết thời gian, quá trình khởi động lại sẽ bị trì hoãn. Nếu được gọi với giá trị -1, quá trình khởi động lại sẽ bị huỷ. Đây là một thao tác không có tác dụng trong chế độ không phải kiosk. Tiện ích đầu tiên chỉ được phép gọi lặp lại để gọi API này.

Tham số

giây

số

Thời gian chờ tính bằng giây trước khi khởi động lại thiết bị hoặc -1 để huỷ khởi động lại theo lịch.
lệnh gọi lại

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

Tham số callback có dạng như sau:
```
() => void
```

Giá trị trả về

Promise<void>

Chrome 99 trở lên

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

sendMessage()

Promise

chrome.runtime.sendMessage(
  extensionId?: string,
  message: any,
  options?: object,
  callback?: function,
)

Gửi một thông báo đến trình nghe sự kiện trong tiện ích của bạn hoặc một tiện ích/ứng dụng khác. Tương tự như runtime.connect nhưng chỉ gửi một thông báo duy nhất, với phản hồi không bắt buộc. Nếu gửi đến tiện ích của bạn, sự kiện runtime.onMessage sẽ được kích hoạt trong mọi khung của tiện ích (ngoại trừ khung của trình gửi) hoặc runtime.onMessageExternal nếu là một tiện ích khác. Xin lưu ý rằng tiện ích không thể gửi thông báo đến tập lệnh nội dung bằng phương thức này. Để gửi thông báo đến tập lệnh nội dung, hãy sử dụng tabs.sendMessage.

Tham số

extensionId

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

Mã của tiện ích để gửi thông báo. Nếu bạn bỏ qua, thông báo sẽ được gửi đến tiện ích/ứng dụng của riêng bạn. Bạn phải cung cấp thông tin này nếu gửi thông báo từ một trang web để nhắn tin trên web.
tin nhắn

bất kỳ

Tin nhắn cần gửi. Thông báo này phải là một đối tượng có thể chuyển đổi sang JSON.
tùy chọn

đối tượng không bắt buộc
- includeTlsChannelId
  
  boolean không bắt buộc
  
  Liệu mã nhận dạng kênh TLS có được truyền vào onMessageExternal cho các quy trình đang nghe sự kiện kết nối hay không.
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ý của thông báo 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 được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

sendNativeMessage()

Promise

chrome.runtime.sendNativeMessage(
  application: string,
  message: object,
  callback?: function,
)

Gửi một tin nhắn đến một ứng dụng gốc. Phương thức này yêu cầu quyền "nativeMessaging".

Tham số

ứng dụng

chuỗi

Tên của máy chủ nhắn tin gốc.
tin nhắn

đối tượng

Thông báo sẽ được chuyển đến máy chủ nhắn tin gốc.
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̀
  
  Thông báo phản hồi do máy chủ nhắn tin gốc gửi. Nếu xảy ra lỗi trong khi kết nối với máy chủ nhắn tin gốc, lệnh gọi lại sẽ được gọi mà không có đối số nào 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 được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

setUninstallURL()

Promise

chrome.runtime.setUninstallURL(
  url: string,
  callback?: function,
)

Thiết lập URL cần truy cập khi gỡ cài đặt. Bạn có thể dùng tính năng này để dọn dẹp dữ liệu phía máy chủ, phân tích và triển khai bản khảo sát. Tối đa 1023 ký tự.

Tham số

url

chuỗi

URL sẽ được mở sau khi gỡ cài đặt tiện ích. URL này phải có giao thức http: hoặc https:. Đặt một chuỗi trống để không mở thẻ mới khi gỡ cài đặt.
lệnh gọi lại

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

Chrome 45 trở lên

Tham số callback có dạng như sau:
```
() => void
```

Giá trị trả về

Promise<void>

Chrome 99 trở lên

Lời hứa được hỗ trợ trong Tệp kê khai V3 trở lên, nhưng lệnh gọi lại được cung cấp để đảm bảo 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ẽ phân giải bằng cùng một loại được truyền đến lệnh gọi lại.

Sự kiện

onBrowserUpdateAvailable

Không dùng nữa

chrome.runtime.onBrowserUpdateAvailable.addListener(
  callback: function,
)

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

Được kích hoạt khi có bản cập nhật Chrome nhưng không được cài đặt ngay vì cần khởi động lại trình duyệt.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
() => void
```

onConnect

chrome.runtime.onConnect.addListener(
  callback: function,
)

Được kích hoạt khi có kết nối từ một quy trình tiện ích hoặc tập lệnh nội dung (bởi runtime.connect).

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(port: Port) => void
```
- cổng
  
  Cổng

onConnectExternal

chrome.runtime.onConnectExternal.addListener(
  callback: function,
)

Được kích hoạt khi có kết nối từ một tiện ích khác (bởi runtime.connect) hoặc từ một trang web có thể kết nối bên ngoài.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(port: Port) => void
```
- cổng
  
  Cổng

onConnectNative

Chrome 76 trở lên

chrome.runtime.onConnectNative.addListener(
  callback: function,
)

Được kích hoạt khi có kết nối từ một ứng dụng gốc. Sự kiện này yêu cầu quyền "nativeMessaging". Tính năng này chỉ được hỗ trợ trên Chrome OS.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(port: Port) => void
```
- cổng
  
  Cổng

onInstalled

chrome.runtime.onInstalled.addListener(
  callback: function,
)

Được kích hoạt khi cài đặt tiện ích lần đầu, khi tiện ích được cập nhật lên phiên bản mới và khi Chrome được cập nhật lên phiên bản mới.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(details: object) => void
```
- chi tiết
  
  đối tượng
  - id
    
    chuỗi không bắt buộc
    
    Cho biết mã nhận dạng của phần mở rộng mô-đun dùng chung đã cập nhật. Thuộc tính này chỉ xuất hiện nếu "reason" là "shared_module_update".
  - previousVersion
    
    chuỗi không bắt buộc
    
    Cho biết phiên bản trước của tiện ích (vừa được cập nhật). Thuộc tính này chỉ xuất hiện nếu "reason" là "update".
  - lý do
    
    OnInstalledReason
    
    Lý do sự kiện này được gửi.

onMessage

chrome.runtime.onMessage.addListener(
  callback: function,
)

Được kích hoạt khi một thông báo được gửi từ một quy trình mở rộng (bằng runtime.sendMessage) hoặc một tập lệnh nội dung (bằng tabs.sendMessage).

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(message: any, sender: MessageSender, sendResponse: function) => boolean | undefined
```
- tin nhắn
  
  bất kỳ
- người gửi
  
  MessageSender
- sendResponse
  
  hàm
  
  Tham số sendResponse có dạng như sau:
```
() => void
```
- returns
  boolean | undefined

onMessageExternal

chrome.runtime.onMessageExternal.addListener(
  callback: function,
)

Được kích hoạt khi một thông báo được gửi từ một tiện ích khác (bởi runtime.sendMessage). Không thể sử dụng trong 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:
```
(message: any, sender: MessageSender, sendResponse: function) => boolean | undefined
```
- tin nhắn
  
  bất kỳ
- người gửi
  
  MessageSender
- sendResponse
  
  hàm
  
  Tham số sendResponse có dạng như sau:
```
() => void
```
- returns
  boolean | undefined

onRestartRequired

chrome.runtime.onRestartRequired.addListener(
  callback: function,
)

Được kích hoạt khi cần khởi động lại một ứng dụng hoặc thiết bị mà ứng dụng đó chạy trên đó. Ứng dụng phải đóng tất cả cửa sổ vào thời điểm thuận tiện sớm nhất để quá trình khởi động lại diễn ra. Nếu ứng dụng không làm gì cả, thì hệ thống sẽ buộc khởi động lại sau thời gian gia hạn 24 giờ. Hiện tại, sự kiện này chỉ được kích hoạt cho các ứng dụng Kiosk trên ChromeOS.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(reason: OnRestartRequiredReason) => void
```
- lý do
  
  OnRestartRequiredReason

onStartup

chrome.runtime.onStartup.addListener(
  callback: function,
)

Được kích hoạt khi một hồ sơ đã cài đặt tiện ích này khởi động lần đầu tiên. Sự kiện này không được kích hoạt khi một hồ sơ ẩn danh được khởi động, ngay cả khi tiện ích này đang hoạt động ở chế độ ẩn danh "phân tách".

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
() => void
```

onSuspend

chrome.runtime.onSuspend.addListener(
  callback: function,
)

Được gửi đến trang sự kiện ngay trước khi trang sự kiện đó được huỷ tải. Điều này giúp tiện ích có cơ hội dọn dẹp một số nội dung. Xin lưu ý rằng vì trang đang tải xuống, nên mọi thao tác không đồng bộ bắt đầu trong khi xử lý sự kiện này đều không được đảm bảo sẽ hoàn tất. Nếu có thêm hoạt động cho trang sự kiện xảy ra trước khi trang đó được huỷ tải, thì sự kiện onSuspendCanceled sẽ được gửi và trang sẽ không được huỷ tải.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
() => void
```

onSuspendCanceled

chrome.runtime.onSuspendCanceled.addListener(
  callback: function,
)

Được gửi sau onSuspend để cho biết rằng ứng dụng sẽ không bị tải xuống.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
() => void
```

onUpdateAvailable

chrome.runtime.onUpdateAvailable.addListener(
  callback: function,
)

Được kích hoạt khi có bản cập nhật nhưng không được cài đặt ngay lập tức vì ứng dụng đang chạy. Nếu bạn không làm gì cả, bản cập nhật sẽ được cài đặt vào lần tiếp theo trang nền được tải xuống. Nếu muốn cài đặt sớm hơn, bạn có thể gọi chrome.runtime.reload() một cách rõ ràng để phản hồi sự kiện này. Nếu tiện ích của bạn đang sử dụng trang nền ổn định, thì trang nền tất nhiên sẽ không bao giờ được tải xuống. Vì vậy, trừ phi bạn gọi chrome.runtime.reload() theo cách thủ công để phản hồi sự kiện này, bản cập nhật sẽ không được cài đặt cho đến lần tiếp theo Chrome tự khởi động lại. Nếu không có trình xử lý nào đang theo dõi sự kiện này và tiện ích của bạn có một trang nền ổn định, thì tiện ích đó sẽ hoạt động như thể chrome.runtime.reload() được gọi để phản hồi sự kiện này.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(details: object) => void
```
- chi tiết
  
  đối tượng
  - version
    
    chuỗi
    
    Số phiên bản của bản cập nhật hiện có.

onUserScriptConnect

Chrome 115 trở lên MV3 trở lên

chrome.runtime.onUserScriptConnect.addListener(
  callback: function,
)

Được kích hoạt khi một kết nối được thực hiện từ tập lệnh người dùng của tiện ích này.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(port: Port) => void
```
- cổng
  
  Cổng

onUserScriptMessage

Chrome 115 trở lên MV3 trở lên

chrome.runtime.onUserScriptMessage.addListener(
  callback: function,
)

Được kích hoạt khi một thông báo được gửi từ tập lệnh người dùng liên kết với cùng một tiện ích.

Tham số

lệnh gọi lại

hàm

Tham số callback có dạng như sau:
```
(message: any, sender: MessageSender, sendResponse: function) => boolean | undefined
```
- tin nhắn
  
  bất kỳ
- người gửi
  
  MessageSender
- sendResponse
  
  hàm
  
  Tham số sendResponse có dạng như sau:
```
() => void
```
- returns
  boolean | undefined