NotificationMessagePayload interface

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

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

ลายเซ็น:

export interface NotificationMessagePayload 

คุณสมบัติ

ข้อความแจ้งเตือนPayload.badge

ค่าของตราบนไอคอนแอปบนหน้าจอหลัก

ถ้าไม่ระบุ ตราจะไม่เปลี่ยน

หากตั้งค่าเป็น 0 ป้ายจะถูกลบออก

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

ลายเซ็น:

badge?: string;

ข้อความแจ้งเตือนPayload.body

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

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

ลายเซ็น:

body?: string;

ข้อความแจ้งเตือนPayload.bodyLocArgs

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

ค่าควรเป็นอาร์เรย์ JSON ที่เป็นสตริง

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

**Android:** ดู การจัดรูปแบบและการจัดรูปแบบ สำหรับข้อมูลเพิ่มเติม

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

ลายเซ็น:

bodyLocArgs?: string;

ข้อความแจ้งเตือนPayload.bodyLocKey

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

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

**Android:** ดู ทรัพยากรสตริง สำหรับข้อมูลเพิ่มเติม

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

ลายเซ็น:

bodyLocKey?: string;

ข้อความแจ้งเตือนPayload.clickAction

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

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

ลายเซ็น:

clickAction?: string;

ข้อความแจ้งเตือนPayload.color

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

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

ลายเซ็น:

color?: string;

ข้อความแจ้งเตือนPayload.icon

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

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

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

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

ลายเซ็น:

icon?: string;

ข้อความแจ้งเตือนPayload.sound

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

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

ลายเซ็น:

sound?: string;

ข้อความแจ้งเตือนPayload.tag

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

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

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

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

ลายเซ็น:

tag?: string;

ข้อความแจ้งเตือนPayload.title

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

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

ลายเซ็น:

title?: string;

ข้อความแจ้งเตือนPayload.titleLocArgs

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

ค่าควรเป็นอาร์เรย์ JSON ที่เป็นสตริง

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

**Android:** ดู การจัดรูปแบบและการจัดรูปแบบ สำหรับข้อมูลเพิ่มเติม

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

ลายเซ็น:

titleLocArgs?: string;

ข้อความแจ้งเตือนPayload.titleLocKey

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

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

**Android:** ดู ทรัพยากรสตริง สำหรับข้อมูลเพิ่มเติม

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

ลายเซ็น:

titleLocKey?: string;