Nội dung mô tả
Sử dụng API chrome.notifications
để tạo thông báo chi tiết bằng mẫu và hiển thị những thông báo này cho người dùng trong khay hệ thống.
Quyền
notifications
Loại
NotificationBitmap
NotificationButton
Thuộc tính
-
iconUrl
chuỗi không bắt buộc
Không dùng nữa kể từ Chrome 59Biểu tượng nút không hiển thị đối với người dùng Mac OS X.
-
title
string
NotificationItem
Thuộc tính
-
tin nhắn
string
Thông tin bổ sung về mặt hàng này.
-
title
string
Tiêu đề của một mục trong thông báo danh sách.
NotificationOptions
Thuộc tính
-
appIconMaskUrl
chuỗi không bắt buộc
Không dùng nữa kể từ Chrome 59Mặt nạ biểu tượng ứng dụng không hiển thị đối với người dùng Mac OS X.
URL đến mặt nạ biểu tượng ứng dụng. Các URL có cùng hạn chế với iconUrl.
Mặt nạ biểu tượng ứng dụng phải ở kênh alpha, vì chỉ kênh alpha của hình ảnh mới được xem xét.
-
nút
NotificationButton[] không bắt buộc
Văn bản và biểu tượng cho tối đa 2 nút hành động thông báo.
-
contextMessage
chuỗi không bắt buộc
Nội dung thông báo thay thế có phông chữ có trọng số thấp hơn.
-
eventTime
số không bắt buộc
Dấu thời gian liên kết với thông báo, tính bằng mili giây sau thời gian bắt đầu của hệ thống (ví dụ:
Date.now() + n
). -
iconUrl
chuỗi không bắt buộc
URL dẫn đến hình đại diện, biểu tượng ứng dụng hoặc hình thu nhỏ của người gửi để thông báo về hình ảnh.
URL có thể là URL dữ liệu, URL blob hoặc URL liên quan đến tài nguyên trong tệp .crx của tiện ích này
**Lưu ý:**Giá trị này là bắt buộc đối với phương thức
notifications.create
()
. -
imageUrl
chuỗi không bắt buộc
Không dùng nữa kể từ Chrome 59Hình ảnh không hiển thị đối với người dùng Mac OS X.
URL dẫn đến hình thu nhỏ của hình ảnh cho thông báo về loại hình ảnh. Các URL có cùng hạn chế với iconUrl.
-
isClickable
boolean không bắt buộc
Không dùng nữa kể từ Chrome 67Gợi ý về giao diện người dùng này sẽ bị bỏ qua kể từ Chrome 67
-
items
NotificationItem[] không bắt buộc
Các mục cho thông báo nhiều mặt hàng. Người dùng trên Mac OS X chỉ thấy mục đầu tiên.
-
tin nhắn
chuỗi không bắt buộc
Nội dung thông báo chính.
**Lưu ý:**Giá trị này là bắt buộc đối với phương thức
notifications.create
()
. -
của chiến dịch
số không bắt buộc
Mức độ ưu tiên nằm trong khoảng từ -2 đến 2. -2 là mức độ ưu tiên thấp nhất. 2 là cao nhất. 0 là mặc định. Trên các nền tảng không hỗ trợ trung tâm thông báo (Windows, Linux và Mac), -2 và -1 dẫn đến lỗi vì các thông báo có các mức độ ưu tiên đó sẽ không xuất hiện.
-
tiến trình
số không bắt buộc
Tiến trình hiện tại nằm trong khoảng từ 0 đến 100.
-
requireInteraction
boolean không bắt buộc
Chrome 50 trở lênCho biết rằng thông báo sẽ vẫn hiển thị trên màn hình cho đến khi người dùng kích hoạt hoặc đóng thông báo. Giá trị mặc định này là false.
-
im lặng
boolean không bắt buộc
Chrome 70 trở lênCho biết hệ thống sẽ không phát âm thanh hoặc rung khi thông báo hiển thị. Giá trị mặc định này là false.
-
title
chuỗi không bắt buộc
Tiêu đề của thông báo (ví dụ: tên người gửi email).
**Lưu ý:**Giá trị này là bắt buộc đối với phương thức
notifications.create
()
. -
loại
TemplateType không bắt buộc
Loại thông báo cần hiển thị. Bắt buộc đối với phương thức
notifications.create
.
PermissionLevel
Liệt kê
"granted"
Chỉ định rằng người dùng đã chọn hiển thị thông báo của ứng dụng hoặc tiện ích. Đây là tuỳ chọn mặc định tại thời điểm cài đặt.
"denied"
Chỉ định rằng người dùng đã chọn không hiện thông báo của ứng dụng hoặc tiện ích.
TemplateType
Liệt kê
"basic"
Chứa một biểu tượng, tiêu đề, thông báo, ExpandMessage và tối đa hai nút.
"image"
Chứa một biểu tượng, tiêu đề, tin nhắn, ExpandMessage, hình ảnh và tối đa hai nút.
"list"
Chứa một biểu tượng, tiêu đề, thông báo, mục và tối đa hai nút. Người dùng trên Mac OS X chỉ thấy mục đầu tiên.
"progress"
Chứa một biểu tượng, tiêu đề, thông báo, tiến trình và tối đa hai nút.
Phương thức
clear()
chrome.notifications.clear(
notificationId: string,
callback?: function,
)
Xoá thông báo đã chỉ định.
Tham số
-
notificationId
string
Mã của thông báo cần xoá. Dữ liệu này được trả về bằng phương thức
notifications.create
. -
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(wasCleared: boolean) => void
-
wasCleared
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 116 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.
create()
chrome.notifications.create(
notificationId?: string,
options: NotificationOptions,
callback?: function,
)
Tạo và hiển thị một thông báo.
Tham số
-
notificationId
chuỗi không bắt buộc
Mã nhận dạng của thông báo. Nếu bạn không đặt chính sách này hoặc để trống, hệ thống sẽ tự động tạo một mã nhận dạng. Nếu thông báo khớp với một thông báo hiện có, trước tiên, phương thức này sẽ xoá thông báo đó trước khi tiếp tục thao tác tạo. Mã nhận dạng này không được dài quá 500 ký tự.
Bạn cần có tham số
notificationId
trước Chrome 42. -
tùy chọn
Nội dung thông báo.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(notificationId: string) => void
-
notificationId
string
-
Giá trị trả về
-
Hứa hẹn<string>
Chrome 116 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.
getAll()
chrome.notifications.getAll(
callback?: function,
)
Truy xuất tất cả thông báo của ứng dụng hoặc tiện ích này.
Tham số
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(notifications: object) => void
-
thông báo
đối tượng
-
Giá trị trả về
-
Promise<object>
Chrome 116 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.
getPermissionLevel()
chrome.notifications.getPermissionLevel(
callback?: function,
)
Truy xuất xem người dùng đã bật thông báo từ ứng dụng hoặc tiện ích này hay chưa.
Tham số
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(level: PermissionLevel) => void
-
cấp lần truy cập,
-
Giá trị trả về
-
Promise<PermissionLevel>
Chrome 116 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.
update()
chrome.notifications.update(
notificationId: string,
options: NotificationOptions,
callback?: function,
)
Cập nhật một thông báo hiện có.
Tham số
-
notificationId
string
Mã của thông báo sẽ được cập nhật. Dữ liệu này được trả về bằng phương thức
notifications.create
. -
tùy chọn
Nội dung của thông báo cần cập nhật.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(wasUpdated: boolean) => void
-
wasUpdated
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 116 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.
Sự kiện
onButtonClicked
chrome.notifications.onButtonClicked.addListener(
callback: function,
)
Người dùng nhấn một nút trong thông báo.
Tham số
-
số gọi lại
hàm
Tham số
callback
sẽ có dạng như sau:(notificationId: string, buttonIndex: number) => void
-
notificationId
string
-
buttonIndex
number
-
onClicked
chrome.notifications.onClicked.addListener(
callback: function,
)
Người dùng nhấp vào một khu vực không phải nút của thông báo.
Tham số
-
số gọi lại
hàm
Tham số
callback
sẽ có dạng như sau:(notificationId: string) => void
-
notificationId
string
-
onClosed
chrome.notifications.onClosed.addListener(
callback: function,
)
Thông báo đã đóng, do hệ thống hoặc hành động của người dùng.
Tham số
-
số gọi lại
hàm
Tham số
callback
sẽ có dạng như sau:(notificationId: string, byUser: boolean) => void
-
notificationId
string
-
byUser
boolean
-
onPermissionLevelChanged
chrome.notifications.onPermissionLevelChanged.addListener(
callback: function,
)
Người dùng thay đổi cấp của quyền. Kể từ Chrome 47, chỉ ChromeOS mới có giao diện người dùng gửi sự kiện này.
Tham số
-
số gọi lại
hàm
Tham số
callback
sẽ có dạng như sau:(level: PermissionLevel) => void
-
cấp lần truy cập,
-
onShowSettings
chrome.notifications.onShowSettings.addListener(
callback: function,
)
Nút cài đặt thông báo tuỳ chỉnh không còn được hỗ trợ.
Người dùng nhấp vào đường liên kết để xem chế độ cài đặt thông báo của ứng dụng. Kể từ Chrome 47, chỉ ChromeOS mới có giao diện người dùng gửi sự kiện này. Kể từ Chrome 65, giao diện người dùng đó cũng đã bị loại bỏ khỏi ChromeOS.
Tham số
-
số gọi lại
hàm
Tham số
callback
sẽ có dạng như sau:() => void