บริการส่งข้อความเชื่อมโยงกับแอพที่ให้มา
ลายเซ็น:
export declare class Messaging
คุณสมบัติ
| คุณสมบัติ | ตัวดัดแปลง | พิมพ์ | คำอธิบาย |
|---|---|---|---|
| แอป | แอป | แอป ที่เชื่อมโยงกับอินสแตนซ์บริการ Messaging ปัจจุบัน |
วิธีการ
| วิธี | ตัวดัดแปลง | คำอธิบาย |
|---|---|---|
| ส่ง (ข้อความ, dryRun) | ส่งข้อความที่กำหนดผ่าน FCM | |
| sendAll (ข้อความ, dryRun) | ส่งข้อความทั้งหมดในอาร์เรย์ที่กำหนดผ่าน Firebase Cloud Messaging ใช้การแบทช์เพื่อส่งรายการทั้งหมดเป็นการเรียก RPC ครั้งเดียว เมื่อเปรียบเทียบกับวิธีการ send() วิธีการนี้เป็นวิธีที่มีประสิทธิภาพมากกว่าในการส่งข้อความหลายข้อความ รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนสอดคล้องกับลำดับของโทเค็นใน MulticastMessage ข้อผิดพลาดจากวิธีนี้บ่งชี้ว่ามีความล้มเหลวทั้งหมด ซึ่งหมายความว่าไม่สามารถส่งข้อความใดในรายการได้ ความล้มเหลวบางส่วนระบุด้วยค่าส่งคืน BatchResponse | |
| sendEach (ข้อความ, dryRun) | ส่งข้อความแต่ละข้อความในอาร์เรย์ที่กำหนดผ่าน Firebase Cloud Messaging ไม่เหมือน Messaging.sendAll() เมธอดนี้ทำการเรียก RPC เดี่ยวสำหรับแต่ละข้อความในอาร์เรย์ที่กำหนด รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนจะสอดคล้องกับลำดับของ messages ข้อผิดพลาดจากวิธีนี้หรือ BatchResponse ที่มีความล้มเหลวทั้งหมดบ่งชี้ถึงความล้มเหลวทั้งหมด ซึ่งหมายความว่าไม่สามารถส่งข้อความใดในรายการได้ ความล้มเหลวบางส่วนหรือไม่ล้มเหลวจะถูกระบุโดยค่าส่งคืน BatchResponse เท่านั้น | |
| sendEachForMulticast (ข้อความ, dryRun) | ส่งข้อความมัลติคาสต์ที่กำหนดไปยังโทเค็นการลงทะเบียน FCM ทั้งหมดที่ระบุไว้ วิธีการนี้ใช้ Messaging.sendEach() API ภายใต้ประทุนเพื่อส่งข้อความที่กำหนดไปยังผู้รับเป้าหมายทั้งหมด รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนสอดคล้องกับลำดับของโทเค็นใน MulticastMessage ข้อผิดพลาดจากวิธีนี้หรือ BatchResponse ที่มีความล้มเหลวทั้งหมดบ่งชี้ถึงความล้มเหลวทั้งหมด ซึ่งหมายความว่าสามารถส่งข้อความในรายการได้ ความล้มเหลวบางส่วนหรือความล้มเหลวจะถูกระบุโดยค่าส่งคืน BatchResponse เท่านั้น | |
| sendMulticast (ข้อความ, dryRun) | ส่งข้อความมัลติคาสต์ที่กำหนดไปยังโทเค็นการลงทะเบียน FCM ทั้งหมดที่ระบุไว้ วิธีการนี้ใช้ sendAll() API ภายใต้ประทุนเพื่อส่งข้อความที่กำหนดไปยังผู้รับเป้าหมายทั้งหมด รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนสอดคล้องกับลำดับของโทเค็นใน MulticastMessage ข้อผิดพลาดจากวิธีนี้บ่งชี้ว่ามีความล้มเหลวทั้งหมด ซึ่งหมายความว่าข้อความไม่ได้ถูกส่งไปยังโทเค็นใดๆ ในรายการ ความล้มเหลวบางส่วนระบุด้วยค่าส่งคืน BatchResponse | |
| sendToCondition (เงื่อนไข, เพย์โหลด, ตัวเลือก) | ส่งข้อความ FCM ไปยังเงื่อนไข ดู ส่งไปยังเงื่อนไข สำหรับตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด | |
| sendToDevice (การลงทะเบียนTokenOrTokens, เพย์โหลด, ตัวเลือก) | ส่งข้อความ FCM ไปยังอุปกรณ์เครื่องเดียวที่สอดคล้องกับโทเค็นการลงทะเบียนที่ให้มา ดู ส่งไปยังอุปกรณ์แต่ละเครื่อง เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด รับ registrationToken เพื่อส่งไปยังอุปกรณ์เครื่องเดียวหรือพารามิเตอร์ registrationTokens ที่มีอาร์เรย์ของโทเค็นเพื่อส่งไปยังอุปกรณ์หลายเครื่อง | |
| sendToDeviceGroup (คีย์การแจ้งเตือน, เพย์โหลด, ตัวเลือก) | ส่งข้อความ FCM ไปยังกลุ่มอุปกรณ์ที่สอดคล้องกับคีย์การแจ้งเตือนที่ให้ไว้ ดู ส่งไปยังกลุ่มอุปกรณ์ เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด | |
| sendToTopic(หัวข้อ, เพย์โหลด, ตัวเลือก) | ส่งข้อความ FCM ไปยังหัวข้อ ดู ส่งไปยังหัวข้อ สำหรับตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด | |
| สมัครสมาชิกToTopic (การลงทะเบียนTokenOrTokens หัวข้อ) | สมัครสมาชิกอุปกรณ์ตามหัวข้อ FCM ดู สมัครสมาชิกหัวข้อ เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด หรือคุณสามารถจัดเตรียมอาร์เรย์ของโทเค็นเพื่อสมัครใช้งานอุปกรณ์หลายเครื่องได้ | |
| ยกเลิกการสมัครจากหัวข้อ(การลงทะเบียนTokenOrTokens หัวข้อ) | ยกเลิกการสมัครอุปกรณ์จากหัวข้อ FCM ดู ยกเลิกการสมัครจากหัวข้อ เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด หรือคุณสามารถจัดเตรียมอาร์เรย์ของโทเค็นเพื่อยกเลิกการสมัครใช้งานอุปกรณ์หลายเครื่องได้ |
Messaging.app
แอป ที่เชื่อมโยงกับอินสแตนซ์บริการ Messaging ปัจจุบัน
ลายเซ็น:
get app(): App;
ตัวอย่าง
var app = messaging.app;
การส่งข้อความส่ง()
ส่งข้อความที่กำหนดผ่าน FCM
ลายเซ็น:
send(message: Message, dryRun?: boolean): Promise<string>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ข้อความ | ข้อความ | เพย์โหลดข้อความ |
| ดรายรัน | บูลีน | ว่าจะส่งข้อความในโหมดทดลองรัน (การตรวจสอบความถูกต้องเท่านั้น) หรือไม่ |
ผลตอบแทน:
สัญญา<สตริง>
คำสัญญาที่ปฏิบัติตามด้วยสตริงรหัสข้อความที่ไม่ซ้ำกันหลังจากส่งข้อความไปยังบริการ FCM เพื่อจัดส่งเรียบร้อยแล้ว
Messaging.sendAll()
ใช้ Messaging.sendEach() แทน
ส่งข้อความทั้งหมดในอาร์เรย์ที่กำหนดผ่าน Firebase Cloud Messaging ใช้การแบทช์เพื่อส่งรายการทั้งหมดเป็นการเรียก RPC ครั้งเดียว เมื่อเปรียบเทียบกับวิธีการ send() วิธีการนี้เป็นวิธีที่มีประสิทธิภาพมากกว่าในการส่งข้อความหลายข้อความ
รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนสอดคล้องกับลำดับของโทเค็นใน MulticastMessage . ข้อผิดพลาดจากวิธีนี้บ่งชี้ว่ามีความล้มเหลวทั้งหมด ซึ่งหมายความว่าไม่สามารถส่งข้อความใดในรายการได้ ความล้มเหลวบางส่วนระบุด้วยค่าส่งคืน BatchResponse
ลายเซ็น:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ข้อความ | ข้อความ [] | อาร์เรย์ที่ไม่ว่างประกอบด้วยข้อความสูงสุด 500 ข้อความ |
| ดรายรัน | บูลีน | ว่าจะส่งข้อความในโหมดทดลองรัน (การตรวจสอบความถูกต้องเท่านั้น) หรือไม่ |
ผลตอบแทน:
สัญญา < BatchResponse >
สัญญาที่ปฏิบัติตามวัตถุที่แสดงถึงผลลัพธ์ของการดำเนินการส่ง
Messaging.sendEach()
ส่งข้อความแต่ละข้อความในอาร์เรย์ที่กำหนดผ่าน Firebase Cloud Messaging
ไม่เหมือน Messaging.sendAll() เมธอดนี้ทำการเรียก RPC เดี่ยวสำหรับแต่ละข้อความในอาร์เรย์ที่กำหนด
รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนสอดคล้องกับลำดับของ messages . ข้อผิดพลาดจากวิธีนี้หรือ BatchResponse ที่มีความล้มเหลวทั้งหมดบ่งชี้ถึงความล้มเหลวทั้งหมด ซึ่งหมายความว่าไม่สามารถส่งข้อความใดในรายการได้ ความล้มเหลวบางส่วนหรือไม่ล้มเหลวจะถูกระบุโดยค่าส่งคืน BatchResponse เท่านั้น
ลายเซ็น:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ข้อความ | ข้อความ [] | อาร์เรย์ที่ไม่ว่างประกอบด้วยข้อความสูงสุด 500 ข้อความ |
| ดรายรัน | บูลีน | ว่าจะส่งข้อความในโหมดทดลองรัน (การตรวจสอบความถูกต้องเท่านั้น) หรือไม่ |
ผลตอบแทน:
สัญญา < BatchResponse >
สัญญาที่ปฏิบัติตามวัตถุที่แสดงถึงผลลัพธ์ของการดำเนินการส่ง
Messaging.sendEachForMulticast()
ส่งข้อความมัลติคาสต์ที่กำหนดไปยังโทเค็นการลงทะเบียน FCM ทั้งหมดที่ระบุไว้
วิธีการนี้ใช้ Messaging.sendEach() API ภายใต้ประทุนเพื่อส่งข้อความที่กำหนดไปยังผู้รับเป้าหมายทั้งหมด รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนสอดคล้องกับลำดับของโทเค็นใน MulticastMessage . ข้อผิดพลาดจากวิธีนี้หรือ BatchResponse ที่มีความล้มเหลวทั้งหมดบ่งชี้ถึงความล้มเหลวทั้งหมด ซึ่งหมายความว่าสามารถส่งข้อความในรายการได้ ความล้มเหลวบางส่วนหรือความล้มเหลวจะถูกระบุโดยค่าส่งคืน BatchResponse เท่านั้น
ลายเซ็น:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ข้อความ | MulticastMessage | ข้อความมัลติคาสต์ที่มีโทเค็นมากถึง 500 รายการ |
| ดรายรัน | บูลีน | ว่าจะส่งข้อความในโหมดทดลองรัน (การตรวจสอบความถูกต้องเท่านั้น) หรือไม่ |
ผลตอบแทน:
สัญญา < BatchResponse >
สัญญาที่ปฏิบัติตามวัตถุที่แสดงถึงผลลัพธ์ของการดำเนินการส่ง
Messaging.sendMulticast()
ใช้ Messaging.sendEachForMulticast() แทน
ส่งข้อความมัลติคาสต์ที่กำหนดไปยังโทเค็นการลงทะเบียน FCM ทั้งหมดที่ระบุไว้
วิธีการนี้ใช้ sendAll() API ภายใต้ประทุนเพื่อส่งข้อความที่กำหนดไปยังผู้รับเป้าหมายทั้งหมด รายการตอบกลับที่ได้รับจากค่าที่ส่งคืนสอดคล้องกับลำดับของโทเค็นใน MulticastMessage . ข้อผิดพลาดจากวิธีนี้บ่งชี้ว่ามีความล้มเหลวทั้งหมด ซึ่งหมายความว่าข้อความไม่ได้ถูกส่งไปยังโทเค็นใดๆ ในรายการ ความล้มเหลวบางส่วนระบุด้วยค่าส่งคืน BatchResponse
ลายเซ็น:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ข้อความ | MulticastMessage | ข้อความมัลติคาสต์ที่มีโทเค็นมากถึง 500 รายการ |
| ดรายรัน | บูลีน | ว่าจะส่งข้อความในโหมดทดลองรัน (การตรวจสอบความถูกต้องเท่านั้น) หรือไม่ |
ผลตอบแทน:
สัญญา < BatchResponse >
สัญญาที่ปฏิบัติตามวัตถุที่แสดงถึงผลลัพธ์ของการดำเนินการส่ง
การส่งข้อความ sendToCondition()
ส่งข้อความ FCM ไปยังเงื่อนไข
ดู ส่งไปยังเงื่อนไข สำหรับตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด
ลายเซ็น:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| เงื่อนไข | เชือก | เงื่อนไขที่กำหนดหัวข้อที่จะส่งข้อความ |
| น้ำหนักบรรทุก | การส่งข้อความเพย์โหลด | เพย์โหลดข้อความ |
| ตัวเลือก | ตัวเลือกการส่งข้อความ | ตัวเลือกเพิ่มเติมในการแก้ไขข้อความ |
ผลตอบแทน:
สัญญา < MessagingConditionResponse >
คำสัญญาที่ตอบสนองโดยเซิร์ฟเวอร์หลังจากส่งข้อความไปแล้ว
การส่งข้อความ sendToDevice()
ใช้ Messaging.send() แทน
ส่งข้อความ FCM ไปยังอุปกรณ์เครื่องเดียวที่สอดคล้องกับโทเค็นการลงทะเบียนที่ให้มา
ดู ส่งไปยังอุปกรณ์แต่ละเครื่อง เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด รับ registrationToken เพื่อส่งไปยังอุปกรณ์เครื่องเดียวหรือพารามิเตอร์ registrationTokens ที่มีอาร์เรย์ของโทเค็นเพื่อส่งไปยังอุปกรณ์หลายเครื่อง
ลายเซ็น:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การลงทะเบียนTokenOrTokens | สตริง | สตริง[] | |
| น้ำหนักบรรทุก | การส่งข้อความเพย์โหลด | เพย์โหลดข้อความ |
| ตัวเลือก | ตัวเลือกการส่งข้อความ | ตัวเลือกเพิ่มเติมในการแก้ไขข้อความ |
ผลตอบแทน:
สัญญา < MessagingDevicesResponse >
คำสัญญาที่ตอบสนองโดยเซิร์ฟเวอร์หลังจากส่งข้อความไปแล้ว
Messaging.sendToDeviceGroup()
ใช้ Messaging.send() แทน
ส่งข้อความ FCM ไปยังกลุ่มอุปกรณ์ที่สอดคล้องกับคีย์การแจ้งเตือนที่ให้ไว้
ดู ส่งไปยังกลุ่มอุปกรณ์ เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด
ลายเซ็น:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| คีย์การแจ้งเตือน | เชือก | คีย์การแจ้งเตือนสำหรับกลุ่มอุปกรณ์ที่จะส่งข้อความไป |
| น้ำหนักบรรทุก | การส่งข้อความเพย์โหลด | เพย์โหลดข้อความ |
| ตัวเลือก | ตัวเลือกการส่งข้อความ | ตัวเลือกเพิ่มเติมในการแก้ไขข้อความ |
ผลตอบแทน:
สัญญา < MessagingDeviceGroupResponse >
คำสัญญาที่ตอบสนองโดยเซิร์ฟเวอร์หลังจากส่งข้อความไปแล้ว
Messaging.sendToTopic()
ส่งข้อความ FCM ไปยังหัวข้อ
ดู ส่งไปยังหัวข้อ สำหรับตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด
ลายเซ็น:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| หัวข้อ | เชือก | หัวข้อที่จะส่งข้อความ |
| น้ำหนักบรรทุก | การส่งข้อความเพย์โหลด | เพย์โหลดข้อความ |
| ตัวเลือก | ตัวเลือกการส่งข้อความ | ตัวเลือกเพิ่มเติมในการแก้ไขข้อความ |
ผลตอบแทน:
สัญญา < การตอบกลับหัวข้อการส่งข้อความ >
คำสัญญาที่ตอบสนองโดยเซิร์ฟเวอร์หลังจากส่งข้อความไปแล้ว
Messaging.subscribeToTopic()
สมัครสมาชิกอุปกรณ์ตามหัวข้อ FCM
ดู สมัครสมาชิกหัวข้อ เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด หรือคุณสามารถจัดเตรียมอาร์เรย์ของโทเค็นเพื่อสมัครใช้งานอุปกรณ์หลายเครื่องได้
ลายเซ็น:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การลงทะเบียนTokenOrTokens | สตริง | สตริง[] | |
| หัวข้อ | เชือก | หัวข้อที่จะสมัครสมาชิก |
ผลตอบแทน:
สัญญา < การส่งข้อความหัวข้อการจัดการการตอบสนอง >
คำสัญญาที่ปฏิบัติตามการตอบสนองของเซิร์ฟเวอร์หลังจากที่อุปกรณ์ได้สมัครรับหัวข้อแล้ว
Messaging.unsubscribeFromTopic()
ยกเลิกการสมัครอุปกรณ์จากหัวข้อ FCM
ดู ยกเลิกการสมัครจากหัวข้อ เพื่อดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด หรือคุณสามารถจัดเตรียมอาร์เรย์ของโทเค็นเพื่อยกเลิกการสมัครใช้งานอุปกรณ์หลายเครื่องได้
ลายเซ็น:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การลงทะเบียนTokenOrTokens | สตริง | สตริง[] | |
| หัวข้อ | เชือก | หัวข้อที่จะยกเลิกการสมัคร |
ผลตอบแทน:
สัญญา < การส่งข้อความหัวข้อการจัดการการตอบสนอง >
คำสัญญาที่ปฏิบัติตามการตอบสนองของเซิร์ฟเวอร์หลังจากที่อุปกรณ์ถูกยกเลิกการสมัครจากหัวข้อนี้