chrome.gcm

refresh date: 2026-09-25 robots: noindex

คำอธิบาย

ใช้ chrome.gcm เพื่อเปิดใช้แอปและส่วนขยายเพื่อส่งและรับข้อความผ่าน Firebase Cloud Messaging (FCM)

สิทธิ์

gcm

พร็อพเพอร์ตี้

MAX_MESSAGE_SIZE

ขนาดสูงสุด (เป็นไบต์) ของคู่คีย์/ค่าทั้งหมดในข้อความ

ค่า

4096

เมธอด

register()

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

ลงทะเบียนแอปพลิเคชันกับ FCM callback จะแสดงรหัสการลงทะเบียน หากมีการเรียกใช้ register อีกครั้งด้วยรายการ senderIds เดียวกัน ระบบจะแสดงรหัสการลงทะเบียนเดิม

พารามิเตอร์

  • senderIds

    string[]

    รายการรหัสเซิร์ฟเวอร์ที่ได้รับอนุญาตให้ส่งข้อความไปยังแอปพลิเคชัน โดยควรมีรหัสผู้ส่งอย่างน้อย 1 รายการและไม่เกิน 100 รายการ

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (registrationId: string) => void

    • registrationId

      สตริง

      รหัสการลงทะเบียนที่ FCM กำหนดให้กับแอปพลิเคชัน

การคืนสินค้า

  • Promise<string>

    Chrome 116 ขึ้นไป

    แก้ไขเมื่อการลงทะเบียนเสร็จสมบูรณ์

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

send()

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

ส่งข้อความตามเนื้อหา

พารามิเตอร์

  • ข้อความ

    ออบเจ็กต์

    ข้อความที่จะส่งไปยังอีกฝ่ายผ่าน FCM

    • เพิ่มเติม

      ออบเจ็กต์

      ข้อมูลข้อความที่จะส่งไปยังเซิร์ฟเวอร์ ไม่อนุญาตให้ใช้ goog. และ google ที่ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ รวมถึง collapse_key ที่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่เป็นคำนำหน้าคีย์ ผลรวมของคู่คีย์/ค่าทั้งหมดไม่ควรเกิน gcm.MAX_MESSAGE_SIZE

    • destinationId

      สตริง

      รหัสของเซิร์ฟเวอร์ที่จะส่งข้อความไปให้ตามที่คอนโซล Google API กำหนดไว้

    • messageId

      สตริง

      รหัสของข้อความ โดยต้องไม่ซ้ำกันสำหรับแต่ละข้อความในขอบเขตของแอปพลิเคชัน ดูคำแนะนำในการเลือกและจัดการรหัสได้ที่เอกสารประกอบของ Cloud Messaging

    • timeToLive

      number ไม่บังคับ

      ระยะเวลาที่ข้อความมีผลเป็นวินาที หากส่งข้อความภายในเวลาดังกล่าวไม่ได้ ระบบจะแสดงเหตุการณ์ onSendError ระยะเวลาที่ใช้ได้ 0 บ่งชี้ว่าควรส่งข้อความทันทีหรือดำเนินการไม่สำเร็จหากเป็นไปไม่ได้ ค่าเริ่มต้นของระยะเวลาที่ใช้ได้คือ 86,400 วินาที (1 วัน) และค่าสูงสุดคือ 2,419,200 วินาที (28 วัน)

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (messageId: string) => void

    • messageId

      สตริง

      รหัสของข้อความที่มีการเรียกกลับ

การคืนสินค้า

  • Promise<string>

    Chrome 116 ขึ้นไป

    แก้ไขหลังจากจัดคิวข้อความเพื่อส่งเรียบร้อยแล้ว หากเกิดข้อผิดพลาด ระบบจะปฏิเสธ Promise

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

unregister()

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

ยกเลิกการลงทะเบียนแอปพลิเคชันจาก FCM

พารามิเตอร์

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 116 ขึ้นไป

    แก้ไขหลังจากยกเลิกการลงทะเบียนเสร็จสมบูรณ์ การยกเลิกการลงทะเบียนจะสำเร็จหาก Promise ไม่ปฏิเสธ

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onMessage

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

เริ่มทำงานเมื่อได้รับข้อความผ่าน FCM

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (message: object) => void

    • ข้อความ

      ออบเจ็กต์

      • collapseKey

        สตริง ไม่บังคับ

        คีย์การยุบของข้อความ ดูรายละเอียดได้ที่ข้อความที่ยุบได้และยุบไม่ได้

      • เพิ่มเติม

        ออบเจ็กต์

        ข้อมูลข้อความ

      • จาก

        สตริง ไม่บังคับ

        ผู้ส่งที่ออกข้อความ

onMessagesDeleted

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

เริ่มทำงานเมื่อเซิร์ฟเวอร์ FCM ต้องลบข้อความที่เซิร์ฟเวอร์แอปส่งไปยังแอปพลิเคชัน ดูรายละเอียดเกี่ยวกับการจัดการเหตุการณ์นี้ได้ที่อายุการใช้งานของข้อความ

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

onSendError

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

เริ่มทำงานเมื่อไม่สามารถส่งข้อความไปยังเซิร์ฟเวอร์ FCM ได้

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (error: object) => void

    • ข้อผิดพลาด

      ออบเจ็กต์

      • รายละเอียด

        ออบเจ็กต์

        รายละเอียดเพิ่มเติมที่เกี่ยวข้องกับข้อผิดพลาด (หากมี)

      • errorMessage

        สตริง

        ข้อความแสดงข้อผิดพลาดที่อธิบายปัญหา

      • messageId

        สตริง ไม่บังคับ

        รหัสของข้อความที่มีข้อผิดพลาดนี้ หากข้อผิดพลาดเกี่ยวข้องกับข้อความที่เฉพาะเจาะจง