NotificationMessagePayload interface

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

ดูสร้างคำขอส่งสำหรับตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด

ลายเซ็น:

export interface NotificationMessagePayload 

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

NotificationsMessagePayload.badge

ค่าของป้ายในไอคอนแอปหน้าจอหลัก

หากไม่ระบุ ป้ายดังกล่าวจะไม่เปลี่ยนแปลง

หากตั้งค่าเป็น 0 ระบบจะนำป้ายออก

**แพลตฟอร์ม** iOS

ลายเซ็น:

badge?: string;

NotificationsMessagePayload.body

ข้อความเนื้อหาของการแจ้งเตือน

**แพลตฟอร์ม** iOS, Android, เว็บ

ลายเซ็น:

body?: string;

NotificationMessagePayload.bodyLocArgs

ค่าสตริงตัวแปรที่จะใช้แทนตัวระบุรูปแบบใน body_loc_key เพื่อใช้ในการแปลเนื้อหาให้เป็นการแปลปัจจุบันของผู้ใช้

ค่าควรเป็นอาร์เรย์ JSON ซึ่งมีรูปแบบเป็นสตริง

**iOS** สอดคล้องกับ loc-args ในเพย์โหลด APNs ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงคีย์เพย์โหลดและการแปลเนื้อหาของการแจ้งเตือนระยะไกล

**Android** ดูข้อมูลเพิ่มเติมได้ที่การจัดรูปแบบและการจัดรูปแบบ

**แพลตฟอร์ม** iOS, Android

ลายเซ็น:

bodyLocArgs?: string;

NotificationsMessagePayload.bodyLocKey

คีย์ของสตริงเนื้อหาในทรัพยากรสตริงของแอปที่จะใช้ในการแปลเนื้อหาให้เป็นการแปลเป็นภาษาปัจจุบันของผู้ใช้

**iOS** สอดคล้องกับ loc-key ในเพย์โหลด APNs ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงคีย์เพย์โหลดและการแปลเนื้อหาของการแจ้งเตือนระยะไกล

**Android** ดูแหล่งข้อมูลสตริงสำหรับข้อมูลเพิ่มเติม

**แพลตฟอร์ม** iOS, Android

ลายเซ็น:

bodyLocKey?: string;

NotificationsMessagePayload.clickAction

การดำเนินการที่เชื่อมโยงกับผู้ใช้คลิกการแจ้งเตือน หากระบุไว้ กิจกรรมที่มีตัวกรอง Intent ตรงกันจะเปิดขึ้นเมื่อผู้ใช้คลิกการแจ้งเตือน

* **แพลตฟอร์ม** Android

ลายเซ็น:

clickAction?: string;

NotificationMessagePayload.color

สีของไอคอนการแจ้งเตือน ซึ่งแสดงในรูปแบบ #rrggbb

**แพลตฟอร์ม** Android

ลายเซ็น:

color?: string;

NotificationMessagePayload.icon

ไอคอนการแจ้งเตือน

**Android:** ตั้งไอคอนการแจ้งเตือนเป็น myicon สำหรับแหล่งข้อมูลที่ถอนออกได้ myicon หากคุณไม่ส่งคีย์นี้ในคำขอ FCM จะแสดงไอคอน Launcher ที่ระบุไว้ในไฟล์ Manifest ของแอป

**เว็บ** URL ที่ใช้สำหรับไอคอนของการแจ้งเตือน

**แพลตฟอร์ม** Android, เว็บ

ลายเซ็น:

icon?: string;

NotificationMessagePayload.sound

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

**แพลตฟอร์ม** Android

ลายเซ็น:

sound?: string;

NotificationsMessagePayload.tag

ตัวระบุที่ใช้แทนที่การแจ้งเตือนที่มีอยู่ในลิ้นชักการแจ้งเตือน

หากไม่ระบุ คำขอแต่ละรายการจะสร้างการแจ้งเตือนใหม่

หากมีการระบุและการแจ้งเตือนที่มีแท็กเดียวกันอยู่แล้ว การแจ้งเตือนใหม่จะแทนที่การแจ้งเตือนที่มีอยู่ในลิ้นชักการแจ้งเตือน

**แพลตฟอร์ม** Android

ลายเซ็น:

tag?: string;

NotificationsMessagePayload.title

ชื่อการแจ้งเตือน

**แพลตฟอร์ม** iOS, Android, เว็บ

ลายเซ็น:

title?: string;

NotificationsMessagePayload.titleLocArgs

ค่าสตริงตัวแปรที่จะใช้แทนตัวระบุรูปแบบใน title_loc_key เพื่อใช้ในการแปลข้อความชื่อตามการแปลเป็นภาษาปัจจุบันของผู้ใช้

ค่าควรเป็นอาร์เรย์ JSON ซึ่งมีรูปแบบเป็นสตริง

**iOS** สอดคล้องกับ title-loc-args ในเพย์โหลด APNs ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงคีย์เพย์โหลดและการแปลเนื้อหาของการแจ้งเตือนระยะไกล

**Android** ดูข้อมูลเพิ่มเติมได้ที่การจัดรูปแบบและการจัดรูปแบบ

**แพลตฟอร์ม** iOS, Android

ลายเซ็น:

titleLocArgs?: string;

NotificationsMessagePayload.titleLocKey

คีย์ของสตริงชื่อในทรัพยากรสตริงของแอปเพื่อใช้ในการแปลข้อความชื่อตามการแปลเป็นภาษาปัจจุบันของผู้ใช้

**iOS** สอดคล้องกับ title-loc-key ในเพย์โหลด APNs ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงคีย์เพย์โหลดและการแปลเนื้อหาของการแจ้งเตือนระยะไกล

**Android** ดูแหล่งข้อมูลสตริงสำหรับข้อมูลเพิ่มเติม

**แพลตฟอร์ม** iOS, Android

ลายเซ็น:

titleLocKey?: string;