chrome.notifications

Mô tả

Sử dụng API chrome.notifications để tạo thông báo đa dạng bằng cách sử dụng các 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 59

    Người dùng Mac OS X sẽ không nhìn thấy biểu tượng nút.

  • tiêu đề

    chuỗi

NotificationItem

Thuộc tính

  • tin nhắn

    chuỗi

    Thông tin chi tiết khác về mặt hàng này.

  • tiêu đề

    chuỗi

    Tiêu đề của một mục trong thông báo dạng 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 59

    Người dùng Mac OS X sẽ không nhìn thấy mặt nạ biểu tượng ứng dụng.

    URL dẫn đến mặt nạ biểu tượng ứng dụng. URL có các quy tắc hạn chế giống như iconUrl.

    Mặt nạ biểu tượng ứng dụng phải ở kênh alpha, vì hệ thống sẽ chỉ xem xét kênh alpha của hình ảnh.

  • 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 của thông báo.

  • contextMessage

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

    Nội dung thông báo thay thế bằng phông chữ có trọng số thấp hơn.

  • eventTime

    number 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 kể từ 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 cho thông báo bằng hình ảnh.

    URL có thể là URL dữ liệu, URL blob hoặc URL tương ứng với một tài nguyên trong tệp .crx của tiện ích này

    **Lưu ý:**Bạn phải cung cấp giá trị này cho phương thức notifications.create().

  • imageUrl

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

    Không dùng nữa kể từ Chrome 59

    Người dùng Mac OS X không nhìn thấy hình ảnh này.

    URL đến hình thu nhỏ của hình ảnh cho thông báo thuộc loại hình ảnh. URL có các quy tắc hạn chế giống như iconUrl.

  • isClickable

    boolean không bắt buộc

    Không dùng nữa kể từ Chrome 67

    Gợi ý về giao diện người dùng này sẽ bị bỏ qua kể từ Chrome 67

  • mục

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

    Các mục cho thông báo có nhiều mục. 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 chính của thông báo.

    **Lưu ý:**Bạn phải cung cấp giá trị này cho phương thức notifications.create().

  • của chiến dịch

    number 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. Giá trị mặc định là 0. 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 sẽ dẫn đến lỗi vì thông báo có các mức độ ưu tiên đó sẽ không xuất hiện.

  • tiến trình

    number không bắt buộc

    Tiến trình hiện tại có phạm vi từ 0 đến 100.

  • requireInteraction

    boolean không bắt buộc

    Chrome 50 trở lên

    Cho 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 là false.

  • im lặng

    boolean không bắt buộc

    Chrome 70 trở lên

    Cho biết rằng không nên phát ra âm thanh hoặc rung khi thông báo đang hiển thị. Giá trị mặc định là false.

  • tiêu đề

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

    Tiêu đề của thông báo (ví dụ: tên người gửi đối với email).

    **Lưu ý:**Bạn phải cung cấp giá trị này cho phương thức notifications.create().

  • loại

    TemplateType không bắt buộc

    Loại thông báo sẽ hiển thị. Bắt buộc đối với phương thức notifications.create.

PermissionLevel

Enum

"granted"
Cho biết người dùng đã chọn hiển thị thông báo từ ứng dụng hoặc tiện ích. Đây là chế độ mặc định tại thời điểm cài đặt.

"denied"
Cho biết rằng người dùng đã chọn không hiển thị thông báo từ ứng dụng hoặc tiện ích.

TemplateType

Enum

"cơ bản"
Chứa một biểu tượng, tiêu đề, thông báo, expandedMessage và tối đa 2 nút.

"image"
Chứa một biểu tượng, tiêu đề, thông báo, expandedMessage, hình ảnh và tối đa 2 nút.

"list"
Chứa một biểu tượng, tiêu đề, thông báo, các mục và tối đa 2 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 2 nút.

Phương thức

clear()

chrome.notifications.clear(
  notificationId: string,
): Promise<boolean>

Xoá thông báo đã chỉ định.

Thông số

  • notificationId

    chuỗi

    Mã của thông báo cần xoá. Phương thức notifications.create sẽ trả về giá trị này.

Giá trị trả về

  • Promise<boolean>

    Chrome 116 trở lên

create()

chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
): Promise<string>

Tạo và hiển thị một thông báo.

Thông số

  • notificationId

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

    Giá trị nhận dạng của thông báo. Nếu bạn không đặt hoặc để trống, hệ thống sẽ tự động tạo một mã nhận dạng. Nếu mã này khớp với một thông báo hiện có, phương thức này sẽ xoá thông báo đó trước khi tiếp tục với thao tác tạo. Giá trị nhận dạng không được dài hơn 500 ký tự.

    Bạn cần có tham số notificationId trước Chrome 42.

  • tùy chọn

    NotificationOptions

    Nội dung của thông báo.

Giá trị trả về

  • Promise<string>

    Chrome 116 trở lên

getAll()

chrome.notifications.getAll(): Promise<object>

Truy xuất tất cả thông báo của ứng dụng hoặc tiện ích này.

Giá trị trả về

  • Promise<object>

    Chrome 116 trở lên

getPermissionLevel()

chrome.notifications.getPermissionLevel(): Promise<PermissionLevel>

Truy xuất thông tin về việc người dùng đã bật thông báo từ ứng dụng hoặc tiện ích này hay chưa.

Giá trị trả về

update()

chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

Cập nhật một thông báo hiện có.

Thông số

  • notificationId

    chuỗi

    Mã nhận dạng của thông báo cần cập nhật. Phương thức notifications.create sẽ trả về giá trị này.

  • tùy chọn

    NotificationOptions

    Nội dung của thông báo cần cập nhật.

Giá trị trả về

  • Promise<boolean>

    Chrome 116 trở lên

Sự kiện

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

Người dùng nhấn vào một nút trong thông báo.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      chuỗi

    • buttonIndex

      số

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

Người dùng nhấp vào một vùng không phải nút của thông báo.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (notificationId: string) => void

    • notificationId

      chuỗi

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

Thông báo đã đóng, do hệ thống hoặc do người dùng thực hiện thao tác.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    (notificationId: string, byUser: boolean) => void

    • notificationId

      chuỗi

    • byUser

      boolean

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

Người dùng thay đổi cấp độ quyền. Kể từ Chrome 47, chỉ ChromeOS có giao diện người dùng gửi sự kiện này.

Thông số

onShowSettings

Không dùng nữa kể từ Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

Nút chế độ 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 một đường liên kết đến phần cài đặt thông báo của ứng dụng. Kể từ Chrome 47, chỉ ChromeOS 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ị xoá khỏi ChromeOS.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau: 

    () => void