@firebase/messaging/sw

İşlevler

İşlev	Açıklama
fonksiyon(uygulama, ...)
getMessaging(uygulama)	Bir Firebase Cloud Messaging örneği alır.
fonksiyon(mesajlaşma, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(mesajlaşma, etkinleştirme)	Firebase Cloud Messaging mesaj teslimi metriklerinin BigQuery'ye aktarılmasını etkinleştirir veya devre dışı bırakır. Varsayılan olarak, mesaj teslimi metrikleri BigQuery'ye aktarılmaz. Çalışma zamanında dışa aktarmayı etkinleştirmek veya devre dışı bırakmak için bu yöntemi kullanın.
onBackgroundMessage(mesajlaşma, nextOrObserver)	Uygulama arka plandayken mesaj alındığında çağrılır. Etkin bir pencere görüntülenmiyorsa uygulamanın arka planda olduğu kabul edilir.
fonksiyon()
isSupported()	SW Bağlamında gerekli tüm API'lerin mevcut 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 getMessagingInSw(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, ...)

deneyselSetDeliveryMetricsExportedToBigQueryEnabled(mesajlaşma, etkinleştirme)

Firebase Cloud Messaging mesaj teslimi metriklerinin BigQuery'ye aktarılmasını etkinleştirir veya devre dışı bırakır. Varsayılan olarak, mesaj teslimi metrikleri BigQuery'ye aktarılmaz. Çalışma zamanında dışa aktarmayı etkinleştirmek veya devre dışı bırakmak için bu yöntemi kullanın.

İmza:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

Parametreler

Parametre	Tür	Açıklama
mesajlaşma	Mesajlaşma	FirebaseMessaging örneği.
enable	boolean	Firebase Cloud Messaging'in, mesaj teslimi metriklerini BigQuery'ye aktarıp aktarmayacağı.

Şunu döndürür:

geçersiz

onBackgroundMessage(mesajlaşma, sonrakiOrObserver)

Uygulama arka plandayken mesaj alındığında çağrılır. Etkin bir pencere görüntülenmiyorsa uygulamanın arka planda olduğu kabul edilir.

İmza:

export declare function onBackgroundMessage(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 uygulama o anda arka plandayken ç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()

SW Bağlamında gerekli tüm API'lerin mevcut olup olmadığını kontrol eder

İmza:

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

Şunu döndürür:

Promise<boolean>

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