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

chrome.runtime

Mô tả

Sử dụng API chrome.runtime để truy xuất trình chạy 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ể dùng API này để chuyển đổi đường dẫn tương đối của URL thành URL đủ điều kiện.

Tổng quan

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

Truyền thông báo: Tiện ích của bạn có thể giao tiếp với các bối cảnh khác nhau trong tiện ích của bạn và cả với các tiện ích khác bằng cách sử dụ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 vào 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ố phần 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 lựa 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 meta 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ợ lý: Các phương thức này cung cấp tiện ích, chẳng hạn như việc chuyển đổi các biểu thị tài nguyên nội bộ sang đị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ợ việc triển khai chế độ kiosk. Các phương thức trong danh mục này bao gồm restart và restartAfterDelay.

Quyền

Hầu hết các phương thức trên Runtime API đều không yêu cầu bất kỳ quyền nào, ngoại trừ sendNativeMessage và connectNative. Các phương thức này yêu cầu quyền nativeMessaging.

Tệp kê khai

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

manifest.json:

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

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

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

Để truy cập vào một tài sả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 bạn muốn thêm một tài sản tiện ích vào trang web. Hai điểm khác biệt là tài sả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ường, tập lệnh nội dung chịu trách nhiệm chèn tài sản của 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. Nhưng trước tiên, tài sản phải được khai báo là một 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ừ worker dịch vụ đến một tập lệnh nội dung

Thông thường, tập lệnh nội dung của tiện ích cần 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ụ. Giống như hai cửa sổ trình duyệt được mở cho cùng một trang web, hai ngữ cảnh này không thể truy cập trực tiếp vào các giá trị của nhau. Thay vào đó, tiện ích có thể sử dụng truyền thông điệp để phối hợp giữa các bối 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ừ trình chạy dịch vụ của tiện ích để khởi động 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 đến service worker và service worker sẽ phản hồi bằng một 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);
});

background.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 khả năng 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ụ về tiện ích

Hãy xem Manifest V3 – Bản minh hoạ Tài nguyên có thể truy cập trên web để biết thêm ví dụ về Runtime API.

Loại

ContextFilter

Chrome 114 trở lên

Một bộ lọc để so khớp với một số bối cảnh tiện ích nhất định. Các bối cảnh khớp phải khớp với tất cả bộ lọc được chỉ định; mọi bộ lọc không được chỉ định sẽ khớp với tất cả bối cảnh có sẵn. Do đó, bộ lọc `{}` sẽ khớp với tất cả các bối 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 bối cảnh là thẻ

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

"BACKGROUND"
Chỉ định loại bối cảnh là một worker dịch vụ.

"OFFSCREEN_DOCUMENT"
Chỉ định loại bối cảnh là tài liệu hiển thị bên ngoài màn hình.

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

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

ExtensionContext

Chrome 114 trở lên

Một ngữ cảnh lưu trữ nội dung của tiện ích.

Thuộc tính

contextId

chuỗi

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

ContextType

Loại bối cảnh tương ứng.
documentId

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

Một 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ã nhận dạng 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ó được liên kết với một hồ sơ ẩn danh hay không.
tabId

số

Mã nhận dạng 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ã nhận dạng 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 một 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 bạn tạo cổng.
frameId

number không bắt buộc

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

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

Mã nhận dạng của tiện ích đã 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. Giá trị này có thể khác với thuộc tính url (ví dụ: about:blank) hoặc có thể là giá trị mờ (ví dụ: iframe được cách ly). Điều này hữu ích trong việc xác định xem nguồn có đáng tin cậy hay không nếu chúng ta không thể xác định ngay từ URL.
phím tab

Thẻ 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ỉ khi receiver 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 đi.

Enum

"install"
Chỉ định lý do của sự kiện là cài đặt.

"update"
Chỉ định lý do của 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 được gửi đ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. "periodic" được dùng khi hệ thống chạy lâu hơn thời gian hoạt động được phép mà bạn đặ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à cập nhật hệ điều hành.

"periodic"
Chỉ định lý do xảy ra sự kiện là do ứng dụng khởi động lại định kỳ.

PlatformArch

Chrome 44 trở lên

Cấu 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 kiến 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 kiến trúc bộ xử lý là mips.

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

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

PlatformInfo

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

Thuộc tính

cung

PlatformArch

Cấu trúc bộ xử lý của máy.
nacl_arch

PlatformNaclArch không bắt buộc

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 kiến trúc ứng dụng gốc là arm.

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

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

"mips"
Chỉ định kiến 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 duy trì lâu dài để 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. runtime.lastError có thể được đặt nếu cổng bị ngắt kết nối do lỗi. Nếu cổng bị đóng qua disconnect, thì sự kiện này chỉ được kích hoạt ở đầu kia. Sự kiện này được kích hoạt tối đa một lần (xem thêm Thời gian tồn tại của cổng).

Hàm onDisconnect.addListener có dạng như sau:
```
(callback: function) => {...}
```
- callback
  
  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) => {...}
```
- callback
  
  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ó tác dụng. 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, một lỗi sẽ xảy ra.

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 thành JSON.

RequestUpdateCheckStatus

Chrome 44 trở lên

Kết quả của quá trình 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"
Cho biết rằng không có bản cập nhật nào có thể cài đặt.

"update_available"
Cho biết có một bản cập nhật có thể cài đặt.

Thuộc tính

id

Mã nhận dạng của tiện ích/ứ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 một hàm API không thành công; nếu không, giá trị sẽ là undefined. Điều này chỉ được xác định trong phạm vi của lệnh gọi lại 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 đã gây ra lỗi. Các hàm API trả về promise 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 các 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 hữu ích cho các tập lệnh nội dung kết nối với các quy trình của tiện ích, giao tiếp giữa các ứng dụng/tiện ích và 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. 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.

Thông số

extensionId

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

Mã nhận dạng của tiện ích cần kết nối. Nếu bỏ qua, một kết nối sẽ được thực hiện với 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 cho dịch vụ 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 sẽ được truyền vào onConnectExternal cho các quy trình đang theo dõi 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 theo dõi sự kiện kết nối.

Giá trị trả về

Cổng

Cổng mà qua đó có thể gửi và nhận thư. 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 có quyền "nativeMessaging". Hãy xem phần Nhắn tin gốc để biết thêm thông tin.

Thông 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 đó ứng dụng có thể gửi và nhận tin nhắn

getBackgroundPage()

Promise Chỉ ở nền trước Không dùng nữa kể từ Chrome 133

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

Các trang nền không tồn tại trong tiện ích MV3.

Truy xuất đối tượng "window" JavaScript cho trang nền đang chạy trong tiện ích/ứng dụng hiện tại. Nếu trang nền là một 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, lỗi sẽ được đặt.

Thông số

callback

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 "window" của JavaScript cho trang nền.

Giá trị trả về

Promise<Window | undefined>

Chrome 99 trở lên

Các promise 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.

getManifest()

chrome.runtime.getManifest()

Trả về thông tin chi tiết về ứng dụng hoặc tiện ích từ tệp kê khai. Đối tượng được trả về là một chuỗi hoá 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()

Promise Chỉ ở nền trước

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

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

Thông số

callback

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

Các promise 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.

getPlatformInfo()

Promise

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

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

Thông số

callback

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

Các promise 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.

getURL()

chrome.runtime.getURL(
  path: string,
)

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

Thông số

đường dẫn

chuỗi

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

Giá trị trả về

chuỗi

URL đủ điều kiện của 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 này có thể mở trong một thẻ mới, trong chrome://extensions, trong một ứng dụng hoặc chỉ cần tập trung vào một trang tuỳ chọn đang mở. Thao tác này sẽ không bao giờ khiến trang gọ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ì một số lý do khác, lệnh gọi lại sẽ đặt lastError.

Thông số

callback

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

Các promise 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.

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.

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 sau mỗi vài giờ và bạn có thể theo dõi sự kiện runtime.onUpdateAvailable mà không cần gọi requestUpdateCheck.

Phương thức này chỉ phù hợp để gọi trong những trường hợp rất hạn chế, 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 của ứng dụng đã quá cũ 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 requestUpdateCheck khác, chẳng hạn như gọi phương thức này 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 của máy khách, mạng và máy chủ.

Lưu ý: Khi được gọi bằng một 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.

Thông số

callback

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 lưu giữ 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ả của quá trình 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, thì thông tin 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

Các promise 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.

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ó hiệu lực.

restartAfterDelay()

Promise 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 bằng giá trị -1, quá trình khởi động lại sẽ bị huỷ. Đây là một thao tác không có hiệu lực ở chế độ không phải kiosk. Chỉ tiện ích đầu tiên gọi API này mới được phép gọi API này nhiều lần.

Thông 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ỷ lệnh khởi động lại theo lịch.
callback

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

Các promise 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.

sendMessage()

Promise

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

Gửi một thông báo duy nhất đến trình nghe sự kiện trong tiện ích 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, có 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 hình của tiện ích (ngoại trừ khung hình của người 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 dùng tabs.sendMessage.

Thông số

extensionId

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

Mã nhận dạng của tiện ích mà bạn muốn gửi thông báo đến. Nếu bị bỏ qua, thông báo sẽ được gửi đến tiện ích/ứng dụng của riêng bạn. Bắt buộc nếu gửi thông báo từ một trang web cho 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 thành 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 sẽ được truyền vào onMessageExternal cho các quy trình đang theo dõi sự kiện kết nối hay không.
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 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

Các promise 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.

sendNativeMessage()

Promise

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

Gửi một thông báo duy nhất đến một ứng dụng gốc. Phương thức này yêu cầu có quyền "nativeMessaging".

Thông 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 truyền đến máy chủ nhắn tin gốc.
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 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ố 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

Các promise 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.

setUninstallURL()

Promise

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

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

Thông số

url

chuỗi

URL sẽ được mở sau khi tiện ích bị gỡ cài đặt. 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.
callback

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

Các promise 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.

Sự kiện

onBrowserUpdateAvailable

Không dùng nữa

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

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

Sự kiện này xảy ra khi có bản cập nhật Chrome nhưng không được cài đặt ngay vì cần phải khởi động lại trình duyệt.

Thông số

callback

hàm

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

onConnect

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

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

Thông số

callback

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 một kết nối được thực hiện từ một tiện ích khác (bằng runtime.connect) hoặc từ một trang web có thể kết nối bên ngoài.

Thông số

callback

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ó một kết nối từ ứng dụng gốc. Sự kiện này yêu cầu có quyền "nativeMessaging". Tính năng này chỉ được hỗ trợ trên ChromeOS.

Thông số

callback

hàm

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

onInstalled

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

Kích hoạt khi tiện ích được cài đặt 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.

Thông số

callback

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 tiện ích mô-đun dùng chung đã nhập được cập nhật. Tham số 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. Tham số 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 đi.

onMessage

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

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

Thông số

callback

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,
)

Kích hoạt khi một thông báo được gửi từ một tiện ích khác (bằng runtime.sendMessage). Không thể dùng trong tập lệnh nội dung.

Thông số

callback

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 một ứng dụng hoặc thiết bị mà ứng dụng đó chạy cần được khởi động lại. Ứng dụng nên đóng tất cả các cửa sổ vào thời điểm thuận tiện sớm nhất để cho phép quá trình khởi động lại diễn ra. Nếu ứng dụng không làm gì, thì hệ thống sẽ buộc khởi động lại sau khi hết 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.

Thông số

callback

hàm

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

onStartup

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

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 "chia tách".

Thông số

callback

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 này bị 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 huỷ tải, 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 hoàn tất. Nếu có nhiều hoạt động hơn cho trang sự kiện 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.

Thông số

callback

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ị huỷ tải sau tất cả.

Thông số

callback

hàm

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

onUpdateAvailable

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

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 hiện đ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 gỡ tải. 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. Nếu tiện ích của bạn đang sử dụng trang nền liên tục, thì trang nền sẽ không bao giờ được gỡ tải. Do đó, trừ phi bạn gọi chrome.runtime.reload() theo cách thủ công để phản hồi sự kiện này, nếu không 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 liên tục, 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.

Thông số

callback

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ó.

chrome.runtime Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Mô tả

Tổng quan

Quyền

Tệp kê khai

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

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

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

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

Ví dụ về tiện ích

Loại

ContextFilter

Thuộc tính

ContextType

Enum

ExtensionContext

Thuộc tính

MessageSender

Thuộc tính

OnInstalledReason

Enum

OnRestartRequiredReason

Enum

PlatformArch

Enum

PlatformInfo

Thuộc tính

PlatformNaclArch

Enum

PlatformOs

Enum

Port

Thuộc tính

RequestUpdateCheckStatus

Enum

Thuộc tính

id

Loại

lastError

Loại

Thuộc tính

Phương thức

connect()

Thông số

Giá trị trả về

connectNative()

Thông số

Giá trị trả về

getBackgroundPage()

Thông số

Giá trị trả về

getManifest()

Giá trị trả về

getPackageDirectoryEntry()

Thông số

Giá trị trả về

getPlatformInfo()

Thông số

Giá trị trả về

getURL()

Thông số

Giá trị trả về

openOptionsPage()

Thông số

Giá trị trả về

reload()

requestUpdateCheck()

Thông số

Giá trị trả về

restart()

restartAfterDelay()

Thông số

Giá trị trả về

sendMessage()

Thông số

Giá trị trả về

sendNativeMessage()

Thông số

Giá trị trả về

setUninstallURL()

chrome.runtime