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

      string

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

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

  • คำสัญญา<string>

    Chrome 116 ขึ้นไป

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

send()

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

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

พารามิเตอร์

  • ข้อความ

    ออบเจ็กต์

    ข้อความที่จะส่งให้แก่อีกฝ่ายหนึ่งผ่าน FCM

    • ข้อมูล

      ออบเจ็กต์

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

    • destinationId

      string

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

    • messageId

      string

      รหัสของข้อความ โดยข้อความแต่ละรายการต้องไม่ซ้ำกันในขอบเขตของแอปพลิเคชัน โปรดดูคำแนะนำในการเลือกและจัดการรหัสในเอกสารประกอบของ 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

      string

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

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

  • คำสัญญา<string>

    Chrome 116 ขึ้นไป

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

unregister()

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

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน ไม่บังคับ

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

    ()=>void

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

  • Promise<void>

    Chrome 116 ขึ้นไป

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

กิจกรรม

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

    • error

      ออบเจ็กต์

      • รายละเอียด

        ออบเจ็กต์

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

      • errorMessage

        string

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

      • messageId

        string ไม่บังคับ

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