chrome.gcm

คำอธิบาย

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

สิทธิ์

gcm

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

MAX_MESSAGE_SIZE

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

ค่า

4096

เมธอด

register()

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

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

พารามิเตอร์

  • senderIds

    string[]

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

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

  • Promise<string>

    Chrome 116 ขึ้นไป

send()

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

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

พารามิเตอร์

  • ข้อความ

    ออบเจ็กต์

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

    • เพิ่มเติม

      ออบเจ็กต์

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

    • destinationId

      สตริง

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

    • messageId

      สตริง

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

    • timeToLive

      หมายเลข ไม่บังคับ

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

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

  • Promise<string>

    Chrome 116 ขึ้นไป

unregister()

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

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

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

  • Promise<void>

    Chrome 116 ขึ้นไป

กิจกรรม

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

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

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