firebase-admin.messaging package

Firebase Cloud Messaging (FCM)

ฟังก์ชัน

ฟังก์ชัน	คำอธิบาย
getMessaging(แอป)	รับบริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.messaging() อาจเรียกใช้ได้โดยไม่ต้องมีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Messaging ของแอปเริ่มต้น หรือใช้ admin.messaging(app) เพื่อเข้าถึงบริการ Messaging ที่เชื่อมโยงกับแอปใดแอปหนึ่ง

ชั้นเรียน

ชั้น	คำอธิบาย
FirebaseMessagingError	โครงสร้างรหัสข้อผิดพลาดการรับส่งข้อความของ Firebase ซึ่งขยาย PrefixedFirebaseError
การรับส่งข้อความ	บริการรับส่งข้อความที่เชื่อมโยงกับแอปที่ให้ไว้
MessagingClientErrorCode	รหัสข้อผิดพลาดของโปรแกรมรับส่งข้อความและข้อความเริ่มต้น

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
AndroidConfig	แสดงตัวเลือกเฉพาะของ Android ที่รวมอยู่ใน Message ได้
ตัวเลือก AndroidFcm	แสดงตัวเลือกสำหรับฟีเจอร์ต่างๆ ที่ FCM SDK สำหรับ Android มีให้
AndroidNotification	แสดงตัวเลือกการแจ้งเตือนเฉพาะของ Android ที่รวมอยู่ใน AndroidConfig
ApnsConfig	แสดงตัวเลือกเฉพาะ APN ที่สามารถรวมไว้ในข้อความ โปรดดูเอกสารประกอบของ Apple สำหรับส่วนหัวและช่องเพย์โหลดต่างๆ ที่ APN รองรับ
ตัวเลือก ApnsFcm	แสดงตัวเลือกสำหรับฟีเจอร์ที่มีให้โดย FCM SDK สำหรับ iOS
ApnsPayload	แสดงเพย์โหลดของข้อความ APN โดยส่วนใหญ่ประกอบด้วยพจนานุกรม aps แต่ยังอาจมีคีย์ที่กำหนดเองอื่นๆ ด้วย
APS	แสดงพจนานุกรม aps ที่เป็นส่วนหนึ่งของข้อความ APN
ApsAlert
BaseMessage
การตอบสนองแบบกลุ่ม	อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendAll() และ Messaging.sendMulticast()
ConditionMessage
เสียงที่สำคัญ	แสดงการกำหนดค่าเสียงที่สำคัญซึ่งอาจรวมอยู่ในพจนานุกรม aps ของเพย์โหลด APN ได้
DataMessagePayload	อินเทอร์เฟซแสดงเพย์โหลดข้อความข้อมูล API แบบเดิมของ FCM ข้อความข้อมูลช่วยให้นักพัฒนาซอฟต์แวร์ส่งคู่คีย์-ค่าที่กำหนดเองได้สูงสุด 4 KB คีย์และค่าต้องเป็นสตริงทั้งคู่ คีย์อาจเป็นสตริงที่กำหนดเองใดก็ได้ ยกเว้นสตริงที่สงวนไว้ต่อไปนี้ from อะไรก็ได้ที่ขึ้นต้นด้วย google. ดูสร้างคำขอส่งคำขอสำหรับตัวอย่างโค้ดและเอกสารประกอบโดยละเอียด
ตัวเลือก Fcm	แสดงตัวเลือกที่ไม่ขึ้นอยู่กับแพลตฟอร์มสำหรับฟีเจอร์ที่ FCM SDK มีให้
การตั้งค่าแสง	แสดงการตั้งค่าเพื่อควบคุม LED การแจ้งเตือนที่รวมไว้ใน AndroidNotification ได้
MessagingConditionResponse	อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendToCondition() แบบเดิมดูตัวอย่างโค้ดและเอกสารโดยละเอียดที่หัวข้อส่งไปยังเงื่อนไข
MessagingDeviceGroupResponse	อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendToDeviceGroup()โปรดดูตัวอย่างโค้ดและเอกสารประกอบโดยละเอียดที่หัวข้อส่งข้อความไปยังกลุ่มอุปกรณ์
การส่งข้อความDeviceผลลัพธ์	เพย์โหลดการตอบกลับสถานะแต่ละรายการจากอุปกรณ์เดียว
MessagingDeviceResponse	อินเทอร์เฟซที่แสดงสถานะของข้อความที่ส่งไปยังอุปกรณ์แต่ละเครื่องผ่าน API เดิมของ FCMโปรดดูตัวอย่างโค้ดและเอกสารโดยละเอียดที่ส่งไปยังอุปกรณ์แต่ละเครื่อง
ตัวเลือกการรับส่งข้อความ	อินเทอร์เฟซซึ่งแสดงตัวเลือกที่มีให้เมื่อส่งข้อความผ่าน API เดิมของ FCMดูสร้างคำขอส่งคำขอสำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด
เพย์โหลดการรับส่งข้อความ	อินเทอร์เฟซแสดงเพย์โหลดข้อความ Firebase Cloud Messaging ต้องมีคีย์ data และ notification อย่างน้อย 1 รายการดูคำขอส่งคำขอสำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด
MessagingTopicManagementResponse	อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.SubscriptionToTopic() และ Messaging.unsubscribeFromTopic()โปรดดูตัวอย่างโค้ดและเอกสารโดยละเอียดที่จัดการหัวข้อจากเซิร์ฟเวอร์
MessagingTopicResponse	อินเทอร์เฟซที่แสดงการตอบสนองของเซิร์ฟเวอร์จากเมธอด Messaging.sendToTopic() แบบเดิมโปรดดูตัวอย่างโค้ดและเอกสารโดยละเอียดที่หัวข้อส่งไปยังหัวข้อ
MulticastMessage	เพย์โหลดสำหรับเมธอด Messaging.sendMulticast() เพย์โหลดจะมีช่องทั้งหมดสำหรับประเภท BaseMessage และรายการโทเค็น
การแจ้งเตือน	การแจ้งเตือนที่รวมอยู่ในข้อความได้
NotificationMessagePayload	อินเทอร์เฟซแสดงเพย์โหลดข้อความแจ้งเตือน API แบบเดิมของ FCM ข้อความแจ้งเตือนช่วยให้นักพัฒนาแอปส่งคู่คีย์-ค่าที่กำหนดไว้ล่วงหน้าได้สูงสุด 4KB คีย์ที่ยอมรับจะแสดงอยู่ด้านล่างดูสร้างคำขอส่งคำขอสำหรับตัวอย่างโค้ดและเอกสารโดยละเอียด
SendResponse	อินเทอร์เฟซที่แสดงสถานะของข้อความแต่ละรายการที่ส่งเป็นส่วนหนึ่งของคำขอแบบกลุ่ม
TokenMessage
หัวข้อข้อความ
WebpushConfig	แสดงตัวเลือกโปรโตคอล WebPush ที่รวมอยู่ใน Message ได้
WebpushFcmOptions	แสดงตัวเลือกสำหรับฟีเจอร์ที่ให้บริการโดย FCM SDK สำหรับเว็บ (ที่ไม่ได้เป็นส่วนหนึ่งของมาตรฐาน Webpush)
WebpushNotification	แสดงตัวเลือกการแจ้งเตือนสำหรับ WebPush โดยเฉพาะ ที่รวมอยู่ใน WebpushConfig ได้ ซึ่งรองรับตัวเลือกมาตรฐานส่วนใหญ่ตามที่ระบุไว้ในข้อกำหนดของการแจ้งเตือนบนเว็บ

พิมพ์ชื่อแทน

พิมพ์ชื่อแทน	คำอธิบาย
ข้อความ	เพย์โหลดสำหรับการดำเนินการ Messaging.send() เพย์โหลดจะมีช่องทั้งหมดที่อยู่ในประเภท BaseMessage และหนึ่งในโทเค็น หัวข้อ หรือเงื่อนไข

รับการรับส่งข้อความ(แอป)

ใช้บริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่กำหนด

สามารถเรียก 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 และหนึ่งในโทเค็น หัวข้อ หรือเงื่อนไข

ลายเซ็น:

export type Message = TokenMessage | TopicMessage | ConditionMessage;