FCM'nin eski API bildirim mesajı yükünü temsil eden arayüz. Bildirim mesajları, geliştiricilerin 4 KB'a kadar önceden tanımlanmış anahtar/değer çiftleri göndermesine olanak tanır. Kabul edilen anahtarlar aşağıda özetlenmiştir.
Kod örnekleri ve ayrıntılı belgeler için Derleme istekleri derleme sayfasına göz atın.
İmza:
export interface NotificationMessagePayload
Özellikler
Özellik | Tür | Açıklama |
---|---|---|
rozet | dize | Ana ekran uygulama simgesindeki rozetin değeri.Belirtilmezse rozet değişmez.0 olarak ayarlanırsa rozet kaldırılır.**Platformlar:** iOS |
body | dize | Bildirimin gövde metni.**Platformlar:** iOS, Android, Web |
bodyLocArgs | dize | Gövde metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için body_loc_key içindeki biçim tanımlayıcılarının yerine kullanılacak değişken dize değerleri.Değer, dizeleştirilmiş bir JSON dizisi olmalıdır.**iOS:** APNs yükündeki loc-args 'ye karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine bakın.**Android:** Daha fazla bilgi için Biçimlendirme ve Stil bölümüne bakın.**Platformlar:** iOS, Android |
bodyLocKey | dize | Gövde metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için uygulamanın dize kaynaklarında kullanılacak gövde dizesinin anahtarı.**iOS:** APNs yükündeki loc-key değerine karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine bakın.**Android:** Daha fazla bilgi için Dize Kaynakları'na bakın.**Platformlar:** iOS, Android |
clickAction | dize | Bildirimdeki bir kullanıcı tıklamasıyla ilişkilendirilmiş işlem. Belirtilirse kullanıcı bildirimi tıkladığında eşleşen Intent Filtresine sahip bir etkinlik başlatılır.* **Platformlar:** Android |
color [renk] | dize | Bildirim simgesinin rengi (#rrggbb biçiminde gösterilir).**Platformlar:** Android |
simge | dize | Bildirimin simgesi.**Android:** Çekilebilir myicon kaynağı için bildirim simgesini myicon olarak ayarlar. İstekte bu anahtarı göndermezseniz FCM, uygulama manifestinizde belirtilen başlatıcı simgesini gösterir.**Web:** Bildirim simgesi için kullanılacak URL.**Platformlar:** Android, Web |
ses | dize | Cihaz bir bildirim aldığında çalınacak ses. "Varsayılan" değerini destekler (cihazın varsayılan bildirim sesi veya uygulamada paket halinde sunulan bir ses kaynağının dosya adı için) Ses dosyaları /res/raw/ içinde bulunmalıdır.**Platformlar:** Android |
etiket | dize | Bildirim çekmecesindeki mevcut bildirimlerin yerine kullanılan tanımlayıcı.Belirtilmezse her istek yeni bir bildirim oluşturur.Belirtilirse ve aynı etikete sahip bir bildirim zaten gösteriliyorsa yeni bildirim, bildirim çekmecesindeki mevcut bildirimin yerini alır.**Platformlar:** Android |
title | dize | Bildirimin başlığı.**Platformlar:** iOS, Android, Web |
BaşlıkLocArgs | dize | Başlık metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için title_loc_key içindeki biçim tanımlayıcılarının yerine kullanılacak değişken dize değerleri.Değer, dizeleştirilmiş bir JSON dizisi olmalıdır.**iOS:** APNs yükündeki title-loc-args 'ye karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine bakın.**Android:** Daha fazla bilgi için Biçimlendirme ve Stil bölümüne bakın.**Platformlar:** iOS, Android |
BaşlıkKonumuAnahtarı | dize | Başlık metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için uygulamanın dize kaynaklarında bulunan başlık dizesinin anahtarı.**iOS:** APNs yükündeki title-loc-key değerine karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine bakın.**Android:** Daha fazla bilgi için Dize Kaynakları'na bakın.**Platformlar:** iOS, Android |
NotificationMessagePayload.rozet
Ana ekrandaki uygulama simgesindeki rozetin değeri.
Belirtilmezse rozet değiştirilmez.
0
olarak ayarlanırsa rozet kaldırılır.
**Platformlar:** iOS
İmza:
badge?: string;
NotificationMessagePayload.body
Bildirimin gövde metni.
**Platformlar:** iOS, Android, Web
İmza:
body?: string;
NotificationMessagePayload.bodyLocArgs
Gövde metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için kullanılacak body_loc_key
içindeki biçim tanımlayıcılarının yerine kullanılacak değişken dize değerleri.
Değer, dizeleştirilmiş bir JSON dizisi olmalıdır.
**iOS:** APNs yükünde loc-args
değerine karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine göz atın.
**Android:** Daha fazla bilgi için Biçimlendirme ve Stil bölümüne bakın.
**Platformlar:** iOS, Android
İmza:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
Gövde metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için kullanılacak, uygulamanın dize kaynaklarındaki gövde dizesinin anahtarı.
**iOS:** APNs yükünde loc-key
değerine karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine göz atın.
**Android:** Daha fazla bilgi için Dize Kaynakları bölümüne bakın.
**Platformlar:** iOS, Android
İmza:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
Bildirimdeki bir kullanıcı tıklamasıyla ilişkilendirilmiş işlem. Belirtilirse kullanıcı bildirimi tıkladığında eşleşen Intent Filtresine sahip bir etkinlik başlatılır.
* **Platformlar:** Android
İmza:
clickAction?: string;
NotificationMessagePayload.renk
Bildirim simgesinin rengi (#rrggbb
biçiminde belirtilir).
**Platformlar:** Android
İmza:
color?: string;
NotificationMessagePayload.icon
Bildirimin simgesi.
**Android:** Çekilebilir kaynak myicon
için bildirim simgesini myicon
olarak ayarlar. İstekte bu anahtarı göndermezseniz FCM, uygulama manifestinizde belirtilen başlatıcı simgesini gösterir.
**Web:** Bildirim simgesi için kullanılacak URL.
**Platformlar:** Android, Web
İmza:
icon?: string;
NotificationMessagePayload.sound mesajı
Cihaz bir bildirim aldığında çalınacak ses. "Varsayılan" değerini destekler (cihazın varsayılan bildirim sesi veya uygulamada paket halinde sunulan bir ses kaynağının dosya adı için) Ses dosyaları /res/raw/
içinde bulunmalıdır.
**Platformlar:** Android
İmza:
sound?: string;
NotificationMessagePayload.tag
Bildirim çekmecesindeki mevcut bildirimleri değiştirmek için kullanılan tanımlayıcı.
Belirtilmezse her istek yeni bir bildirim oluşturur.
Belirtilmişse ve aynı etikete sahip bir bildirim zaten gösteriliyorsa yeni bildirim, bildirim çekmecesindeki mevcut bildirimin yerini alır.
**Platformlar:** Android
İmza:
tag?: string;
NotificationMessagePayload.title
Bildirimin başlığı.
**Platformlar:** iOS, Android, Web
İmza:
title?: string;
NotificationMessagePayload.titleLocArgs
Başlık metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için kullanılacak title_loc_key
içindeki biçim belirteçlerin yerine kullanılacak değişken dize değerleri.
Değer, dizeleştirilmiş bir JSON dizisi olmalıdır.
**iOS:** APNs yükünde title-loc-args
değerine karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine göz atın.
**Android:** Daha fazla bilgi için Biçimlendirme ve Stil bölümüne bakın.
**Platformlar:** iOS, Android
İmza:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
Başlık metnini kullanıcının mevcut yerelleştirmesine göre yerelleştirmek için kullanılacak, uygulamanın dize kaynaklarındaki başlık dizesinin anahtarı.
**iOS:** APNs yükünde title-loc-key
değerine karşılık gelir. Daha fazla bilgi için Yük Anahtarı Referansı ve Uzaktan Bildirimlerinizin İçeriğini Yerelleştirme bölümlerine göz atın.
**Android:** Daha fazla bilgi için Dize Kaynakları bölümüne bakın.
**Platformlar:** iOS, Android
İmza:
titleLocKey?: string;