Firebase Cloud Messaging (FCM)
ฟังก์ชัน
| ฟังก์ชัน | คำอธิบาย |
|---|---|
| getMessaging(แอป) | รับบริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.messaging() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Messaging ของแอปเริ่มต้น หรือโดยใช้ admin.messaging(app) เพื่อเข้าถึงบริการของ Messaging ที่เชื่อมโยงกับแอปนั้นๆ |
คลาส
| ชั้น | คำอธิบาย |
|---|---|
| การรับส่งข้อความ | บริการรับส่งข้อความที่เชื่อมโยงกับแอปที่ระบุ |
อินเทอร์เฟซ
| อินเทอร์เฟซ | คำอธิบาย |
|---|---|
| AndroidConfig | แสดงตัวเลือกเฉพาะของ Android ที่สามารถรวมอยู่ในข้อความ |
| AndroidFcmOptions | แสดงตัวเลือกสำหรับฟีเจอร์ที่มีโดย FCM SDK สำหรับ Android |
| การแจ้งเตือน Android | แสดงตัวเลือกการแจ้งเตือนเฉพาะของ Android ที่รวมอยู่ใน AndroidConfig |
| ApnsConfig | แสดงตัวเลือกเฉพาะของ APN ที่รวมอยู่ในข้อความ โปรดดูเอกสารประกอบของ Apple สำหรับส่วนหัวและช่องเพย์โหลดต่างๆ ที่ APN รองรับ |
| ApnsFcmOptions | แสดงตัวเลือกสำหรับฟีเจอร์จาก FCM SDK สำหรับ iOS |
| ApnsPayload | แสดงเพย์โหลดของข้อความ APN ส่วนใหญ่ประกอบด้วยพจนานุกรม aps แต่อาจมีคีย์อื่นๆ ที่กำหนดเองก็ได้ |
| แอป | แสดงพจนานุกรม Aps ที่เป็นส่วนหนึ่งของข้อความ APN |
| ApsAlert | |
| ข้อความฐาน | |
| การตอบกลับเป็นกลุ่ม | อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendAll() และ Messaging.sendMulticast() |
| ข้อความสภาพสินค้า | |
| เสียงวิกฤต | แสดงการกำหนดค่าเสียงที่สำคัญซึ่งสามารถรวมอยู่ในพจนานุกรม aps ของเพย์โหลด APN |
| เพย์โหลด DataMessage | อินเทอร์เฟซที่แสดงเพย์โหลดข้อความ API เดิมของ FCM ข้อความข้อมูลช่วยให้นักพัฒนาซอฟต์แวร์ส่งคู่คีย์-ค่าที่กำหนดเองได้สูงสุด 4KB ทั้งคีย์และค่าต้องเป็นสตริง คีย์อาจเป็นสตริงที่กำหนดเองแบบใดก็ได้ ยกเว้นสตริงที่สงวนไว้ต่อไปนี้
|
| FcmOptions | แสดงตัวเลือกที่ไม่ขึ้นอยู่กับแพลตฟอร์มสำหรับฟีเจอร์ที่ให้บริการโดย FCM SDK |
| การตั้งค่าแสง | แสดงการตั้งค่าเพื่อควบคุมไฟ LED การแจ้งเตือนที่รวมอยู่ใน AndroidNotification |
| MessagingConditionResponse | อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendToCondition() แบบเดิมดูตัวอย่างโค้ดและเอกสารโดยละเอียดได้ที่ส่งไปยังเงื่อนไข |
| MessagingDeviceGroupResponse | อินเทอร์เฟซที่แสดงถึงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendToDeviceGroup()โปรดดูส่งข้อความถึงกลุ่มอุปกรณ์เพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด |
| MessagingDevice Results | เพย์โหลดการตอบกลับสถานะแต่ละรายการจากอุปกรณ์เดียว |
| MessagingDeviceResponse | อินเทอร์เฟซที่แสดงสถานะของข้อความที่ส่งไปยังอุปกรณ์แต่ละเครื่องผ่าน API เดิมของ FCMดูตัวอย่างโค้ดและเอกสารโดยละเอียดได้ที่ส่งไปยังอุปกรณ์แต่ละเครื่อง |
| ตัวเลือกการรับส่งข้อความ | อินเทอร์เฟซแสดงตัวเลือกที่มีให้เมื่อส่งข้อความผ่าน API เดิมของ FCMดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่สร้างคำขอ |
| การรับส่งข้อความเพย์โหลด | อินเทอร์เฟซที่แสดงเพย์โหลดข้อความของ Firebase Cloud Messaging ต้องใช้คีย์ data และ notification อย่างน้อย 1 รายการดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่สร้างคำขอ |
| การรับส่งข้อความหัวข้อการจัดการ | อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.subscribeToTopic() และ Messaging.unsubscribeFromTopic()โปรดดูจัดการหัวข้อจากเซิร์ฟเวอร์เพื่อดูตัวอย่างโค้ดและเอกสารโดยละเอียด |
| MessagingTopicResponse | อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendToTopic() เดิมดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดที่ส่งไปยังหัวข้อ |
| ข้อความมัลติแคสต์ | เพย์โหลดสำหรับเมธอด Messaging.sendMulticast() เพย์โหลดประกอบด้วยช่องทั้งหมดในประเภท BaseMessage และรายการโทเค็น |
| การแจ้งเตือน | การแจ้งเตือนที่สามารถรวมอยู่ในข้อความ |
| NotificationMessagePayload | อินเทอร์เฟซที่แสดงเพย์โหลดข้อความ API เดิมของ FCM ข้อความแจ้งเตือนช่วยให้นักพัฒนาซอฟต์แวร์ส่งคู่คีย์-ค่าที่กำหนดไว้ล่วงหน้าได้สูงสุด 4KB ดูคีย์ที่ยอมรับตามที่ระบุไว้ด้านล่างดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดได้ที่สร้างคำขอส่งคำขอ |
| SendResponse | อินเทอร์เฟซแสดงสถานะของข้อความแต่ละรายการที่ส่งเป็นส่วนหนึ่งของคำขอแบบกลุ่ม |
| TokenMessage | |
| ข้อความหัวข้อ | |
| WebpushConfig | แสดงตัวเลือกโปรโตคอล WebPush ที่สามารถรวมอยู่ในข้อความ |
| WebpushFcmOptions | แสดงตัวเลือกสำหรับฟีเจอร์ที่มีโดย FCM SDK สำหรับเว็บ (ซึ่งไม่ได้เป็นส่วนหนึ่งของมาตรฐาน Webpush) |
| WebpushNotification | แสดงตัวเลือกการแจ้งเตือนเฉพาะ WebPush ที่รวมอยู่ใน WebpushConfig ได้ ตัวเลือกนี้รองรับตัวเลือกมาตรฐานส่วนใหญ่ตามที่ระบุไว้ในข้อกำหนดของการแจ้งเตือนบนเว็บ |
ประเภทชื่อแทน
| ประเภทชื่อแทน | คำอธิบาย |
|---|---|
| ข้อความ | เพย์โหลดสำหรับการดำเนินการ Messaging.send() เพย์โหลดมีช่องทั้งหมดในประเภท BaseMessage และมีโทเค็น หัวข้อ หรือเงื่อนไขอย่างละ 1 รายการ |
getMessaging(แอป)
ใช้บริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่กำหนด
สามารถเรียกใช้ admin.messaging() โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Messaging ของแอปเริ่มต้น หรือโดยใช้ admin.messaging(app) เพื่อเข้าถึงบริการของ Messaging ที่เชื่อมโยงกับแอปที่ระบุ
ลายเซ็น:
export declare function getMessaging(app?: App): Messaging;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| แอป | แอป | แอปเสริมที่มีบริการ Messaging ที่จะส่งคืน หากไม่ระบุ ระบบจะส่งคืนบริการ Messaging เริ่มต้น |
การคืนสินค้า:
บริการ Messaging เริ่มต้นหากไม่มีการให้แอป หรือบริการ Messaging ที่เชื่อมโยงกับแอปที่ระบุ
ตัวอย่าง 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
ตัวอย่าง 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
ส่งข้อความ
เพย์โหลดสำหรับการดำเนินการ Messaging.send() เพย์โหลดมีช่องทั้งหมดในประเภท BaseMessage และมีโทเค็น หัวข้อ หรือเงื่อนไขอย่างละ 1 รายการ
ลายเซ็น:
export type Message = TokenMessage | TopicMessage | ConditionMessage;