@firebase/messaging

İşlevler

İşlev	Açıklama
fonksiyon(uygulama, ...)
getMessaging(uygulama)	Bir Firebase Cloud Messaging örneği alır.
fonksiyon(mesajlaşma, ...)
deleteToken(mesajlaşma)	Bu Messaging örneğiyle ilişkili kayıt jetonunu siler ve Messaging örneğinin push aboneliğinden çıkarılmasını sağlar.
getToken(mesajlaşma, seçenekler)	Messaging örneğini push bildirimlerine abone yapar. İlgili Messaging örneğine push mesajları göndermek için kullanılabilecek bir Firebase Cloud Messaging kayıt jetonu döndürür.Bildirim izni henüz verilmediyse bu yöntem kullanıcıdan izin ister. Kullanıcı, uygulamanın bildirim göstermesine izin vermezse döndürülen söz reddedilir.
onMessage(mesajlaşma, nextOrObserver)	Bir push mesajı alındığında ve kullanıcı o anda kaynağınızın bulunduğu bir sayfadayken mesaj sayfaya iletilir ve push mesajının yükünü içeren bir onMessage() etkinliği gönderilir.
fonksiyon()
isSupported()	Tarayıcıda gerekli tüm API'lerin olup olmadığını kontrol eder.

Arayüzler

Arayüz	Açıklama
FcmOptions	Web için FCM SDK'sı tarafından sağlanan özelliklerle ilgili seçenekler. WebpushFcmOptions'a bakın.
GetTokenOptions	getToken() için seçenekler.
Mesaj Yükü	NotificationPayload ile temsil edilen bildirim yükünü ve geliştiricilerin Send API üzerinden rastgele sayıda anahtar/değer çiftini içeren veri yükünü içeren mesaj yükü.
Mesajlaşma	Firebase Cloud Messaging SDK'nın herkese açık arayüzü.
Bildirim Yükü	Bildirim ayrıntılarını göster. Ayrıntılar, Send API üzerinden gönderilir.

function(uygulama; ...)

getMessaging(uygulama)

Bir Firebase Cloud Messaging örneği alır.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	FirebaseUygulaması

Şunu döndürür:

Mesajlaşma

Sağlanan Firebase uygulamasıyla ilişkili Firebase Cloud Messaging örneği.

Functions(mesajlaşma, ...)

deleteToken(mesajlaşma)

Bu Messaging örneğiyle ilişkili kayıt jetonunu siler ve Messaging örneğinin push aboneliğinden çıkarılmasını sağlar.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesajlaşma	Mesajlaşma	Messaging örneği.

Şunu döndürür:

Promise<boolean>

Jeton başarıyla silindiğinde taahhüt sona erer.

getToken(mesajlaşma, seçenekler)

Messaging örneğini push bildirimlerine abone yapar. Söz konusu Messaging örneğine push mesajları göndermek için kullanılabilecek bir Firebase Cloud Messaging kayıt jetonu döndürür.

Bildirim izni verilmemişse bu yöntem, kullanıcıdan izin ister. Kullanıcı, uygulamanın bildirim göstermesine izin vermezse döndürülen söz reddedilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesajlaşma	Mesajlaşma	Messaging örneği.
seçenekler	GetTokenOptions	İsteğe bağlı vapid anahtarı ve isteğe bağlı hizmet çalışanı kaydı sağlar.

Şunu döndürür:

Promise<dize>

Söz konusu görev, FCM kayıt jetonuyla çözüme ulaştırılır.

onMessage(mesajlaşma, sonrakiOrObserver)

Bir push mesajı alındığında ve kullanıcı o anda kaynağınızın bulunduğu sayfadayken mesaj sayfaya iletilir ve push mesajının yükünü içeren bir onMessage() etkinliği gönderilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
mesajlaşma	Mesajlaşma	Messaging örneği.
sonrakiOrGözlemci	NextFn<MessagePayload> | Gözlemci<MessagePayload>	Bu işlev veya next tanımlı gözlemci nesnesi, bir mesaj alındığında ve kullanıcı o sırada sayfanızı görüntülerken çağrılır.

Şunu döndürür:

E-posta listesinden çık

Mesajları dinlemeyi durdurmak için bu döndürülen işlevi yürütün.

fonksiyon()

isDesteklenen()

Tarayıcıda gerekli tüm API'lerin olup olmadığını kontrol eder.

İmza:

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

Şunu döndürür:

Promise&lt;boolean&gt;

boole'ye dönüşen bir Promise'tir.