@firebase/messaging

Fonksiyonlar

İşlev Tanım
işlev(uygulama, ...)
getMessaging(uygulama) Firebase Cloud Messaging örneğini alır.
fonksiyon(mesajlaşma, ...)
deleteToken(mesajlaşma) Bu Messaging örneğiyle ilişkili kayıt belirtecini siler ve Messaging örneğinin push aboneliğinden aboneliğini kaldırır.
getToken(mesajlaşma, seçenekler) Mesajlaşma örneğine anlık bildirimlere abone olur. Söz konusu Messaging örneğine push mesajları göndermek için kullanılabilecek bir Firebase Cloud Messaging kayıt jetonunu döndürür. Bildirim izni henüz verilmemişse bu yöntem kullanıcıdan izin ister. Kullanıcı uygulamanın bildirim göstermesine izin vermezse iade edilen söz reddedilir.
onMessage(mesajlaşma, nextOrObserver) Bir push mesajı alındığında ve kullanıcı şu anda kaynağınız için bir sayfada olduğunda, mesaj sayfaya iletilir ve push mesajının yüküyle birlikte bir onMessage() olayı gönderilir.
işlev()
desteklenir() Gerekli tüm API'lerin tarayıcıda mevcut olup olmadığını kontrol eder.

Arayüzler

Arayüz Tanım
FcmSeçenekleri Web için FCM SDK tarafından sağlanan özelliklere ilişkin seçenekler. WebpushFcmOptions'a bakın .
GetTokenOptions getToken() seçenekleri .
MesajYükü NotificationPayload ile temsil edilen bildirim yükünü ve geliştiriciler tarafından Send API aracılığıyla gönderilen rastgele sayıda anahtar/değer çifti içeren veri yükünü içeren mesaj yükü .
Mesajlaşma Firebase Cloud Messaging SDK'nın genel arayüzü.
BildirimYükü Bildirim ayrıntılarını görüntüleyin. Ayrıntılar Send API'si aracılığıyla gönderilir .

işlev(uygulama, ...)

getMessaging(uygulama)

Firebase Cloud Messaging örneğini alır.

İmza:

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

Parametreler

Parametre Tip Tanım
uygulama Firebase Uygulaması

İadeler:

Mesajlaşma

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

fonksiyon(mesajlaşma, ...)

deleteToken(mesajlaşma)

Bu Messaging örneğiyle ilişkili kayıt belirtecini siler ve Messaging örneğinin push aboneliğinden aboneliğini kaldırır.

İmza:

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

Parametreler

Parametre Tip Tanım
mesajlaşma Mesajlaşma Mesajlaşma örneği.

İadeler:

Söz<boolean>

Söz, belirteç başarıyla silindiğinde çözülür.

getToken(mesajlaşma, seçenekler)

Mesajlaşma örneğine anlık bildirimlere abone olur. Söz konusu Messaging örneğine push mesajları göndermek için kullanılabilecek bir Firebase Cloud Messaging kayıt jetonunu döndürür.

Bildirim izni henüz verilmemişse bu yöntem kullanıcıdan izin ister. Kullanıcı uygulamanın bildirim göstermesine izin vermezse iade edilen söz reddedilir.

İmza:

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

Parametreler

Parametre Tip Tanım
mesajlaşma Mesajlaşma Mesajlaşma örneği.
seçenekler GetTokenOptions İsteğe bağlı bir geçersiz anahtar ve isteğe bağlı bir hizmet çalışanı kaydı sağlar.

İadeler:

Söz<string>

Söz, bir FCM kayıt jetonuyla çözümlenir.

onMessage(mesajlaşma, nextOrObserver)

Bir push mesajı alındığında ve kullanıcı şu anda kaynağınız için bir sayfada olduğunda, mesaj sayfaya iletilir ve push mesajının yüküyle birlikte bir onMessage() olayı gönderilir.

İmza:

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

Parametreler

Parametre Tip Tanım
mesajlaşma Mesajlaşma Mesajlaşma örneği.
nextOrObserver SonrakiFn < MesajYükü > | Gözlemci < MesajYükü > Bu işlev veya next tanımlı gözlemci nesnesi, bir mesaj alındığında ve kullanıcı o anda sayfanızı görüntülüyorken çağrılır.

İadeler:

Abonelikten çık

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

işlev()

desteklenir()

Gerekli tüm API'lerin tarayıcıda mevcut olup olmadığını kontrol eder.

İmza:

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

İadeler:

Söz<boolean>

bir boole değerine çözümlenen bir Promise.