chrome.gcm

Mô tả

Sử dụng chrome.gcm để cho phép các ứng dụng và tiện ích gửi và nhận thông báo 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 khoá/giá trị trong một thông báo.

Giá trị

4096

Phương thức

register()

chrome.gcm.register(
  senderIds: string[],
): Promise<string>

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

Thông số

  • senderIds

    string[]

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

Giá trị trả về

  • Promise<string>

    Chrome 116 trở lên

    Phân giải khi quá trình đăng ký hoàn tất.

send()

chrome.gcm.send(
  message: object,
): Promise<string>

Gửi một thông báo theo nội dung của thông báo đó.

Thông số

  • tin nhắn

    đối tượng

    Thông báo cần gửi cho bên kia thông qua FCM.

    • dữ liệu

      đối tượng

      Dữ liệu thông báo cần gửi đến máy chủ. Bạn không được dùng 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 làm tiền tố khoá. 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

      chuỗi

      Mã nhận dạng của máy chủ để gửi thông báo đến do Google API Console chỉ định.

    • messageId

      chuỗi

      Mã nhận dạng của thông báo. Mã này phải là duy nhất cho từng thông báo trong phạm vi của các ứng dụng. Hãy xem tài liệu về Cloud Messaging để biết lời khuyên về cách chọn và xử lý một mã nhận dạng.

    • timeToLive

      number không bắt buộc

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

Giá trị trả về

  • Promise<string>

    Chrome 116 trở lên

    Giải quyết sau khi thư được xếp hàng thành công để gửi. Nếu xảy ra lỗi, lời hứa sẽ bị từ chối.

unregister()

chrome.gcm.unregister(): Promise<void>

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

Giá trị trả về

  • Promise<void>

    Chrome 116 trở lên

    Giải quyết sau khi quá trình huỷ đăng ký hoàn tất. Huỷ đăng ký thành công nếu lời hứa không bị từ chối.

Sự kiện

onMessage

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

Được kích hoạt khi một thông báo được nhận qua FCM.

Thông số

  • callback

    hàm

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

    (message: object) => void

    • tin nhắn

      đối tượng

      • collapseKey

        string không bắt buộc

        Khoá thu gọn của một thông báo. Hãy xem phần Thông báo không thu gọn và thông báo 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ừ

        string không bắt buộc

        Người gửi đã phát hành thông báo.

onMessagesDeleted

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

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

Thông số

  • callback

    hàm

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

    () => void

onSendError

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

Được kích hoạt khi không thể gửi thông báo đến máy chủ FCM.

Thông số

  • callback

    hàm

    Tham số callback 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

        chuỗi

        Thông báo lỗi mô tả vấn đề.

      • messageId

        string không bắt buộc

        Mã nhận dạng 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ể.