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