chrome.gcm

คำอธิบาย

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

สิทธิ์

gcm

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

MAX_MESSAGE_SIZE

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

ค่า

4096

เมธอด

register()

สัญญา 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

พารามิเตอร์

  • senderIds

    สตริง[]

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

  • Callback

    ไม่บังคับ

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

    (registrationId: string) => void

    • registrationId

      สตริง

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

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

  • คำมั่นสัญญา<สตริง>

    Chrome 116 ขึ้นไป

    รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

send()

สัญญา 
chrome.gcm.send(
  message: object,
  callback?: function,
)

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

พารามิเตอร์

  • ข้อความ

    ออบเจ็กต์

    ข้อความสำหรับส่งถึงอีกฝ่ายผ่าน FCM

    • ข้อมูล

      ออบเจ็กต์

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

    • destinationId

      สตริง

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

    • messageId

      สตริง

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

    • timeToLive

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

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

  • Callback

    ไม่บังคับ

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

    (messageId: string) => void

    • messageId

      สตริง

      รหัสของข้อความที่มีการให้ติดต่อกลับ

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

  • คำมั่นสัญญา<สตริง>

    Chrome 116 ขึ้นไป

    รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

unregister()

สัญญา 
chrome.gcm.unregister(
  callback?: function,
)

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

พารามิเตอร์

  • Callback

    ไม่บังคับ

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

    () => void

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

  • คำสัญญา<โมฆะ>

    Chrome 116 ขึ้นไป

    รองรับคำสัญญาในไฟล์ Manifest V3 ขึ้นไป แต่จะมี Callback สำหรับ ความเข้ากันได้แบบย้อนหลัง คุณไม่สามารถใช้ทั้ง 2 อย่างในการเรียกใช้ฟังก์ชันเดียวกันได้ จะมีการแก้ไขด้วยประเภทเดียวกันที่ส่งไปยัง Callback

กิจกรรม

onMessage

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

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (message: object) => void

    • ข้อความ

      ออบเจ็กต์

      • collapseKey

        string ไม่บังคับ

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

      • ข้อมูล

        ออบเจ็กต์

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

      • จาก

        string ไม่บังคับ

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

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

        string ไม่บังคับ

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