อินเทอร์เฟซที่แสดงตัวเลือกที่มีให้เมื่อส่งข้อความผ่าน API เดิมของ FCM
ดูสร้างคำขอส่งสำหรับตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด
ลายเซ็น:
export interface MessagingOptions
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
| ยุบคีย์ | สตริง | สตริงที่ระบุกลุ่มข้อความ (เช่น "มีอัปเดต") ที่ยุบได้ เพื่อให้ระบบส่งเฉพาะข้อความสุดท้ายเมื่อการนำส่งต่อได้ ซึ่งใช้เพื่อหลีกเลี่ยงการส่งข้อความเดิมซ้ำๆ มากเกินไปเมื่ออุปกรณ์กลับมาออนไลน์หรือเปิดใช้งานอีกครั้งไม่มีการรับประกันลำดับการส่งข้อความอนุญาตให้ใช้คีย์ยุบที่แตกต่างกันได้สูงสุด 4 คีย์ในช่วงเวลาที่กำหนด ซึ่งหมายความว่าเซิร์ฟเวอร์ FCM สามารถจัดเก็บข้อความที่ส่งเพื่อซิงค์ที่แตกต่างกัน 4 ข้อความต่อแอปไคลเอ็นต์ได้ในเวลาเดียวกัน หากมีคีย์เกินจำนวนนี้ เราไม่รับประกันว่าคีย์ยุบ 4 รายการที่เซิร์ฟเวอร์ FCM จะเก็บไว้**ค่าเริ่มต้น** ไม่มี |
| contentavailable | boolean | ใน iOS ให้ใช้ช่องนี้เพื่อแสดง content-available ในเพย์โหลด APNs เมื่อมีการส่งการแจ้งเตือนหรือข้อความข้อมูลและการตั้งค่านี้เป็น true แอปไคลเอ็นต์ที่ไม่มีการใช้งานจะดังขึ้น ใน Android ข้อความข้อมูลจะปลุกระบบแอปโดยค่าเริ่มต้น ขณะนี้ยังไม่รองรับธงนี้ใน Chrome**ค่าเริ่มต้น** false |
| DryRun | boolean | ระบุว่าควรส่งข้อความจริงหรือไม่ เมื่อตั้งค่าเป็น true อนุญาตให้นักพัฒนาแอปทดสอบคำขอโดยไม่ต้องส่งข้อความจริง เมื่อตั้งค่าเป็น false ระบบจะส่งข้อความ**ค่าเริ่มต้น** false |
| เนื้อหาที่เปลี่ยนแปลงได้ | boolean | ใน iOS ให้ใช้ช่องนี้เพื่อแสดง mutable-content ในเพย์โหลด APNs เมื่อส่งการแจ้งเตือนและตั้งค่าเป็น true คุณจะแก้ไขเนื้อหาของการแจ้งเตือนก่อนที่จะแสดงได้โดยใช้ส่วนขยายแอปบริการการแจ้งเตือนใน Android และเว็บ ระบบจะไม่สนใจพารามิเตอร์นี้**ค่าเริ่มต้น** false |
| ลำดับความสำคัญ | สตริง | ลำดับความสำคัญของข้อความ ค่าที่ใช้ได้คือ "normal" และ "high". ใน iOS ค่าเหล่านี้จะตรงกับลำดับความสำคัญของ APN 5 และ 10โดยค่าเริ่มต้น ระบบจะส่งข้อความแจ้งเตือนโดยมีลำดับความสำคัญสูง และระบบจะส่งข้อความข้อมูลโดยมีลำดับความสำคัญปกติ ลำดับความสำคัญปกติจะเพิ่มประสิทธิภาพการใช้แบตเตอรี่ของแอปไคลเอ็นต์และควรใช้ เว้นแต่จำเป็นต้องนำส่งทันที สำหรับข้อความที่มีลำดับความสำคัญปกติ แอปอาจได้รับข้อความที่เกิดความล่าช้าที่ไม่ระบุเมื่อมีการส่งข้อความที่มีลำดับความสำคัญสูง ระบบจะส่งข้อความทันที และแอปสามารถปลุกระบบอุปกรณ์ที่ทำงานและเปิดการเชื่อมต่อเครือข่ายกับเซิร์ฟเวอร์ของคุณดูข้อมูลเพิ่มเติมได้ที่การตั้งค่าลำดับความสำคัญของข้อความ**ค่าเริ่มต้น** "high" สำหรับข้อความแจ้งเตือน "normal" สำหรับข้อความข้อมูล |
| restrictedPackageName | สตริง | ชื่อแพ็กเกจของแอปพลิเคชันที่โทเค็นการลงทะเบียนต้องตรงกันจึงจะได้รับข้อความ**ค่าเริ่มต้น** ไม่มี |
| TimeToLive | ตัวเลข | ระยะเวลา (เป็นวินาที) ที่ระบบจะเก็บข้อความไว้ในพื้นที่เก็บข้อมูล FCM หากอุปกรณ์ออฟไลน์ Time to Live สูงสุดที่รองรับคือ 4 สัปดาห์ และค่าเริ่มต้นคือ 4 สัปดาห์ ดูข้อมูลเพิ่มเติมได้ที่การตั้งค่าอายุการใช้งานของข้อความ**ค่าเริ่มต้น** 2419200 (แสดง 4 สัปดาห์ในหน่วยวินาที) |
MessagingOptions.collapseKey
สตริงที่ระบุกลุ่มข้อความ (เช่น "มีอัปเดต") ที่ยุบได้ เพื่อให้ระบบส่งเฉพาะข้อความสุดท้ายเมื่อการนำส่งต่อได้ โดยระบบจะใช้เพื่อหลีกเลี่ยงการส่งข้อความเดียวกันมากเกินไปเมื่ออุปกรณ์กลับมาออนไลน์หรือเปิดใช้งาน
และไม่รับประกันลำดับของการส่งข้อความ
อนุญาตให้มีคีย์ยุบที่แตกต่างกันได้สูงสุด 4 คีย์ในช่วงเวลาหนึ่ง ซึ่งหมายความว่าเซิร์ฟเวอร์ FCM สามารถจัดเก็บข้อความที่ส่งเพื่อซิงค์ที่แตกต่างกัน 4 ข้อความต่อแอปไคลเอ็นต์ได้ในเวลาเดียวกัน หากเกินจำนวนนี้ เราไม่รับประกันว่าคีย์ยุบ 4 รายการที่เซิร์ฟเวอร์ FCM จะเก็บไว้
**ค่าเริ่มต้น** ไม่มี
ลายเซ็น:
collapseKey?: string;
MessagingOptions.contentavailable
ใน iOS ให้ใช้ช่องนี้เพื่อแสดง content-available ในเพย์โหลด APNs เมื่อมีการส่งการแจ้งเตือนหรือข้อความข้อมูลและการตั้งค่านี้เป็น true แอปไคลเอ็นต์ที่ไม่มีการใช้งานจะตื่น ใน Android ข้อความข้อมูลจะปลุกระบบแอปโดยค่าเริ่มต้น ขณะนี้ยังไม่รองรับธงนี้ใน Chrome
**ค่าเริ่มต้น** false
ลายเซ็น:
contentAvailable?: boolean;
MessagingOptions.dryRun
ระบุว่าควรส่งข้อความจริงหรือไม่ เมื่อตั้งค่าเป็น true จะเป็นการอนุญาตให้นักพัฒนาซอฟต์แวร์ทดสอบคำขอโดยไม่ต้องส่งข้อความจริง เมื่อตั้งค่าเป็น false ระบบจะส่งข้อความ
**ค่าเริ่มต้น** false
ลายเซ็น:
dryRun?: boolean;
MessagingOptions.mutableContent
ใน iOS ให้ใช้ช่องนี้เพื่อแสดง mutable-content ในเพย์โหลด APNs เมื่อส่งการแจ้งเตือนและตั้งค่าเป็น true คุณจะแก้ไขเนื้อหาของการแจ้งเตือนก่อนที่จะแสดงได้โดยใช้ส่วนขยายแอปของบริการการแจ้งเตือน
ใน Android และเว็บ ระบบจะไม่สนใจพารามิเตอร์นี้
**ค่าเริ่มต้น** false
ลายเซ็น:
mutableContent?: boolean;
MessagingOptions.Priority
ลำดับความสำคัญของข้อความ ค่าที่ถูกต้องคือ "normal" และ "high". ใน iOS ค่าเหล่านี้สอดคล้องกับลำดับความสำคัญของ APN 5 และ 10
โดยค่าเริ่มต้น ระบบจะส่งข้อความแจ้งเตือนโดยมีลำดับความสำคัญสูง และจะส่งข้อความข้อมูลโดยมีลำดับความสำคัญปกติ ลำดับความสำคัญปกติจะเพิ่มประสิทธิภาพการใช้แบตเตอรี่ของแอปไคลเอ็นต์และควรใช้ เว้นแต่จำเป็นต้องนำส่งทันที สำหรับข้อความที่มีลำดับความสำคัญปกติ แอปอาจได้รับข้อความที่ล่าช้าที่ไม่ระบุ
เมื่อคุณส่งข้อความที่มีลำดับความสำคัญสูง ระบบจะส่งข้อความนั้นทันที และแอปสามารถปลุกระบบอุปกรณ์ที่ทำงาน ตลอดจนเปิดการเชื่อมต่อเครือข่ายกับเซิร์ฟเวอร์ของคุณได้
โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการตั้งค่าลำดับความสำคัญของข้อความ
**ค่าเริ่มต้น** "high" สำหรับข้อความแจ้งเตือน "normal" สำหรับข้อความข้อมูล
ลายเซ็น:
priority?: string;
MessagingOptions.restrictedPackageName
ชื่อแพ็กเกจของแอปพลิเคชันซึ่งโทเค็นการลงทะเบียนต้องตรงกับจึงจะได้รับข้อความ
**ค่าเริ่มต้น** ไม่มี
ลายเซ็น:
restrictedPackageName?: string;
MessagingOptions.timeToLive
ระยะเวลา (เป็นวินาที) ที่ระบบจะเก็บข้อความไว้ในพื้นที่เก็บข้อมูล FCM หากอุปกรณ์ออฟไลน์ Time to Live สูงสุดที่รองรับคือ 4 สัปดาห์ และค่าเริ่มต้นคือ 4 สัปดาห์ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการตั้งค่าอายุการใช้งานของข้อความ
**ค่าเริ่มต้น** 2419200 (แสดงถึง 4 สัปดาห์ในหน่วยวินาที)
ลายเซ็น:
timeToLive?: number;