chrome.notifications

Mô tả

Dùng API chrome.notifications để tạo thông báo đa dạng thức bằng các mẫu và hiện 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

    Biểu tượng nút không hiển thị đối với người dùng Mac OS X.

  • tiêu đề

    string

NotificationItem

Thuộc tính

  • tin nhắn

    string

    Thông tin bổ sung về mặt hàng này.

  • tiêu đề

    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 59

    Mặ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 tới mặt nạ biểu tượng ứng dụng. Các URL có cùng quy định hạn chế với iconUrl.

    Mặt nạ biểu tượng ứng dụng phải ở kênh alpha, vì chỉ có kênh alpha của hình ảnh mới được xem xét.

  • các 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ế bằng phông chữ có độ đậm thấp hơn.

  • eventTime

    số không bắt buộc

    Dấu thời gian được 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 đế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 về hình ảnh.

    Các URL có thể là URL dữ liệu, URL của blob hoặc URL liên quan đến một 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 59

    Hình ảnh không hiển thị cho người dùng Mac OS X.

    URL tới hình thu nhỏ của hình ảnh cho thông báo thuộc loại hình ảnh. Các URL có cùng quy định hạn chế với iconUrl.

  • isClickable

    boolean không bắt buộc

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

    Gợi ý 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 về 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 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. Số không là giá trị 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 sẽ dẫn đến lỗi vì các thông báo có những mức độ ưu tiên đó sẽ hoàn toàn không hiển thị.

  • 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ên

    Cho biết 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 có âm thanh hoặc rung sẽ được phát ra 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 cho 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 sẽ hiển thị. Bắt buộc đối với phương thức notifications.create.

PermissionLevel

Enum

"đã cấp"
Chỉ định rằng người dùng đã chọn hiện thông báo từ ứng dụng hoặc tiện ích. Đây là tuỳ chọn mặc định khi cài đặt.

"đã từ chối"
Chỉ định rằng người dùng đã chọn không hiện thông báo từ ứng dụng hoặc tiện ích.

TemplateType

Enum

"basic"
Chứa biểu tượng, tiêu đề, thông báo, ExpandMessage và tối đa 2 nút.

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

"list"
Chứa biểu tượng, tiêu đề, thông báo, mục và tối đa 2 nút. Người dùng trên Mac OS X chỉ nhìn thấy mục đầu tiên.

"progress"
Chứa 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()

Lời hứa 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

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

Tham số

  • notificationId

    string

    Mã thông báo cần xoá. Giá trị này được phương thức notifications.create trả về.

  • 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ên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp cho 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. Chiến lược phát hành đĩa đơn Promise phân giải cùng loại được truyền đến lệnh gọi lại.

create()

Lời hứa 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

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

Tham 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 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 khớp với thông báo hiện có, thì phương thức này sẽ xoá thông báo đó trước khi tiếp tục thao tác tạo. Giá trị nhận dạng không được dài quá 500 ký tự.

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

  • tùy chọn

    NotificationOptions

    Nội dung của 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ề

  • Cam kết<string>

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp cho 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. Chiến lược phát hành đĩa đơn Promise phân giải cùng loại được truyền đến lệnh gọi lại.

getAll()

Lời hứa 
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&lt;object&gt;

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp cho 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. Chiến lược phát hành đĩa đơn Promise phân giải cùng loại được truyền đến lệnh gọi lại.

getPermissionLevel()

Lời hứa 
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

Giá trị trả về

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp cho 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. Chiến lược phát hành đĩa đơn Promise phân giải cùng loại được truyền đến lệnh gọi lại.

update()

Lời hứa 
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 cần cập nhật. Giá trị này được phương thức notifications.create trả về.

  • tùy chọn

    NotificationOptions

    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&lt;boolean&gt;

    Chrome 116 trở lên

    Lời hứa được hỗ trợ trong Manifest V3 trở lên nhưng lệnh gọi lại được cung cấp cho 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. Chiến lược phát hành đĩa đơn Promise phân giải cùng loại được truyền đến 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

      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 trên 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,
)

Hệ thống hoặc hành động của người dùng đã đóng thông báo.

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 độ quyền. Kể từ Chrome 47, chỉ ChromeOS có giao diện người dùng gửi sự kiện này.

Tham số

onShowSettings

Không dùng nữa kể từ Chrome 65
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 một đường liên kết cho chế độ 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.

Tham số

  • số gọi lại

    hàm

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

    () => void