@firebase/messaging

المهام

وظيفة وصف
وظيفة (التطبيق، ...)
الحصول على الرسائل (التطبيق) يسترد مثيل Firebase Cloud Messaging.
وظيفة (الرسائل، ...)
حذف الرمز (المراسلة) حذف رمز التسجيل المرتبط بمثيل المراسلة هذا وإلغاء اشتراك مثيل المراسلة من اشتراك الدفع.
getToken (المراسلة، الخيارات) يشترك في مثيل المراسلة لدفع الإخطارات. إرجاع رمز تسجيل Firebase Cloud Messaging الذي يمكن استخدامه لإرسال رسائل الدفع إلى مثيل المراسلة هذا. إذا لم يتم منح إذن الإعلام بالفعل، فإن هذه الطريقة تطلب من المستخدم الحصول على إذن. يتم رفض الوعد الذي تم إرجاعه إذا لم يسمح المستخدم للتطبيق بعرض الإشعارات.
onMessage(المراسلة، nextOrObserver) عندما يتم تلقي رسالة دفع ويكون المستخدم حاليًا على صفحة لأصلك، يتم تمرير الرسالة إلى الصفحة ويتم إرسال حدث onMessage() مع حمولة رسالة الدفع.
وظيفة()
مدعوم() يتحقق من وجود جميع واجهات برمجة التطبيقات المطلوبة في المتصفح.

واجهات

واجهه المستخدم وصف
خيارات fcm خيارات الميزات التي توفرها FCM SDK للويب. راجع WebpushFcmOptions .
GetTokenOptions خيارات getToken() .
رسالةPayload حمولة الرسالة التي تحتوي على حمولة الإشعارات التي يتم تمثيلها مع NotificationPayload وحمولة البيانات التي تحتوي على عدد عشوائي من أزواج القيمة الرئيسية المرسلة من قبل المطورين من خلال Send API .
المراسلة الواجهة العامة لـ Firebase Cloud Messaging SDK.
NotificationPayload عرض تفاصيل الإخطار. يتم إرسال التفاصيل من خلال Send API .

وظيفة (التطبيق، ...)

الحصول على الرسائل (التطبيق)

يسترد مثيل Firebase Cloud Messaging.

إمضاء:

export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;

حدود

معامل يكتب وصف
برنامج FirebaseApp

عائدات:

المراسلة

مثيل Firebase Cloud Messaging المرتبط بتطبيق firebase المقدم.

وظيفة (الرسائل، ...)

حذف الرمز (المراسلة)

حذف رمز التسجيل المرتبط بمثيل المراسلة هذا وإلغاء اشتراك مثيل المراسلة من اشتراك الدفع.

إمضاء:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

حدود

معامل يكتب وصف
المراسلة المراسلة مثيل المراسلة .

عائدات:

وعد <منطقي>

يتم حل الوعد عندما يتم حذف الرمز المميز بنجاح.

getToken (المراسلة، الخيارات)

يشترك في مثيل المراسلة لدفع الإخطارات. إرجاع رمز تسجيل Firebase Cloud Messaging الذي يمكن استخدامه لإرسال رسائل الدفع إلى مثيل المراسلة هذا.

إذا لم يتم منح إذن الإعلام بالفعل، فإن هذه الطريقة تطلب من المستخدم الحصول على إذن. يتم رفض الوعد الذي تم إرجاعه إذا لم يسمح المستخدم للتطبيق بعرض الإشعارات.

إمضاء:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

حدود

معامل يكتب وصف
المراسلة المراسلة مثيل المراسلة .
خيارات GetTokenOptions يوفر مفتاحًا فابيدًا اختياريًا وتسجيلًا اختياريًا لعامل الخدمة.

عائدات:

وعد <سلسلة>

يتم حل الوعد باستخدام رمز تسجيل FCM.

onMessage(المراسلة، nextOrObserver)

عندما يتم تلقي رسالة دفع ويكون المستخدم حاليًا على صفحة لأصلك، يتم تمرير الرسالة إلى الصفحة ويتم إرسال حدث onMessage() مع حمولة رسالة الدفع.

إمضاء:

export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

حدود

معامل يكتب وصف
المراسلة المراسلة مثيل المراسلة .
nextOrObserver نيكستفن < رسالة الحمولة > | مراقب < رسالة الحمولة > يتم استدعاء هذه الوظيفة، أو كائن المراقب الذي تم تعريفه next ، عند تلقي رسالة ويقوم المستخدم حاليًا بعرض صفحتك.

عائدات:

إلغاء الاشتراك

لإيقاف الاستماع للرسائل، قم بتنفيذ هذه الوظيفة التي تم إرجاعها.

وظيفة()

مدعوم()

يتحقق من وجود جميع واجهات برمجة التطبيقات المطلوبة في المتصفح.

إمضاء:

export declare function isWindowSupported(): Promise<boolean>;

عائدات:

وعد <منطقي>

الوعد الذي يتحول إلى منطقي.