chrome.gcm

Mô tả

Sử dụng chrome.gcm để cho phép ứng dụng và tiện ích gửi và nhận tin nhắn thông qua Giải pháp gửi thông báo qua đám mây của Firebase (FCM).

Quyền

gcm

Thuộc tính

MAX_MESSAGE_SIZE

Kích thước tối đa (tính bằng byte) của tất cả các cặp giá trị/khoá trong một thông báo.

Giá trị

4096

Phương thức

register()

Lời hứa 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

Đăng ký ứng dụng với FCM. callback sẽ trả về mã đăng ký. Nếu register được gọi lại với cùng danh sách senderIds, thì mã đăng ký đó sẽ được trả về.

Tham số

  • senderIds

    chuỗi[]

    Danh sách mã máy chủ được phép gửi thông báo đến ứng dụng. Tài khoản này phải chứa ít nhất 1 và không quá 100 mã nhận dạng người gửi.

  • số gọi lại

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

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

    (registrationId: string) => void

    • registrationId

      string

      Mã nhận dạng đăng ký do FCM gán cho ứng dụng.

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.

send()

Lời hứa 
chrome.gcm.send(
  message: object,
  callback?: function,
)

Gửi tin nhắn theo nội dung.

Tham số

  • tin nhắn

    đối tượng

    Tin nhắn để gửi cho bên kia qua FCM.

    • dữ liệu

      đối tượng

      Dữ liệu tin nhắn cần gửi đến máy chủ. goog. và google không phân biệt chữ hoa chữ thường, cũng như collapse_key phân biệt chữ hoa chữ thường đều không được phép dùng làm tiền tố chính. Tổng của tất cả các cặp khoá/giá trị không được vượt quá gcm.MAX_MESSAGE_SIZE.

    • destinationId

      string

      Mã của máy chủ cần gửi thông báo đến theo chỉ định của Google API Console.

    • messageId

      string

      Mã nhận dạng của thư. Thông báo phải là duy nhất cho mỗi thông báo trong phạm vi ứng dụng. Xem tài liệu về Giải pháp gửi thông báo qua đám mây để biết lời khuyên về cách chọn và xử lý mã nhận dạng.

    • timeToLive

      số không bắt buộc

      Thời gian tồn tại của tin nhắn tính bằng giây. Nếu không thể gửi thư trong thời gian đó, sự kiện onSendError sẽ xuất hiện. Thời gian tồn tại bằng 0 cho biết tin nhắn phải được gửi ngay lập tức hoặc không thành công nếu không thể. Giá trị mặc định của thời gian sống là 86.400 giây (1 ngày) và giá trị tối đa là 2.419.200 giây (28 ngày).

  • số gọi lại

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

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

    (messageId: string) => void

    • messageId

      string

      Mã nhận dạng của thông báo nhận lệnh gọi lại.

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.

unregister()

Lời hứa 
chrome.gcm.unregister(
  callback?: function,
)

Huỷ đăng ký ứng dụng khỏi FCM.

Tham số

  • số gọi lại

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

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

    () => void

Giá trị trả về

  • Lời hứa<vô hiệu>

    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

onMessage

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

Được kích hoạt khi tin nhắn được nhận qua FCM.

Tham số

  • số gọi lại

    hàm

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

    (message: object) => void

    • tin nhắn

      đối tượng

      • collapseKey

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

        Phím thu gọn của một thư. Hãy xem bài viết Tin nhắn không thể thu gọn và có thể thu gọn để biết thông tin chi tiết.

      • dữ liệu

        đối tượng

        Dữ liệu tin nhắn.

      • từ

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

        Người gửi thư.

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

Được kích hoạt khi máy chủ FCM phải xoá thông báo do máy chủ ứng dụng gửi tới ứng dụng. Xem Thời gian tồn tại của thông báo để biết chi tiết về cách xử lý sự kiện này.

Tham số

  • số gọi lại

    hàm

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

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

Được kích hoạt khi không thể gửi tin nhắn tới máy chủ FCM.

Tham số

  • số gọi lại

    hàm

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

    (error: object) => void

    • error

      đối tượng

      • chi tiết

        đối tượng

        Thông tin chi tiết bổ sung liên quan đến lỗi (nếu có).

      • errorMessage

        string

        Thông báo lỗi mô tả sự cố.

      • messageId

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

        Mã của thông báo có lỗi này, nếu lỗi liên quan đến một thông báo cụ thể.