chrome.gcm

refresh date: 2026-09-25 robots: noindex

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 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 khoá/giá trị trong một thông báo.

Giá trị

4096

Phương thức

register()

Promise 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): 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ì mã đăng ký tương tự 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 1 và không quá 100 mã nhận dạng người gửi.

  • callback

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

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

    (registrationId: string) => void

    • registrationId

      chuỗi

      Mã đăng ký do FCM chỉ định cho ứng dụng.

Giá trị trả về

  • <string> hứa hẹn

    Chrome 116 trở lên

    Giải quyết khi quá trình đăng ký hoàn tất.

    Lờ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.

send()

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

Gửi tin nhắn theo nội dung của tin nhắn.

Thông số

  • tin nhắn

    đối tượng

    Một thông báo để gửi đến bên kia thông qua FCM.

    • khác

      đối tượng

      Dữ liệu thông báo cần gửi đến máy chủ. 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 theo chỉ định của Google API Console.

    • messageId

      chuỗi

      Mã nhận dạng của tin nhắn. Mã này phải là duy nhất cho mỗi thông báo trong phạm vi của ứng dụng. Hãy 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

      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 tin nhắn trong thời gian đó, thì sự kiện onSendError sẽ được kích hoạt. Thời gian tồn tại bằng 0 cho biết rằng thông báo phải được gửi ngay lập tức hoặc không thành công nếu không thể gửi. 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).

  • callback

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

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

    (messageId: string) => void

    • messageId

      chuỗi

      Mã nhận dạng của tin nhắn mà lệnh gọi lại được đưa ra.

Giá trị trả về

  • <string> hứa hẹn

    Chrome 116 trở lên

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

    Lờ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.

unregister()

Promise 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

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

Thông số

  • callback

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

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

    () => void

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. Quá trình huỷ đăng ký thành công nếu lời hứa không bị từ chối.

    Lờ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

onMessage

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

Được kích hoạt khi nhận được thông báo 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

        chuỗi 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 có thể thu gọn và không thể thu gọn để biết thông tin chi tiết.

      • khác

        đối tượng

        Dữ liệu thông báo.

      • từ

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

        Người gửi đã đưa ra 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. Xem phần Vòng đờ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 khác liên quan đến lỗi (nếu có).

      • errorMessage

        chuỗi

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

      • messageId

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

        Mã nhận dạng của thư có lỗi này, nếu lỗi liên quan đến một thư cụ thể.