NotificationMessagePayload interface

Interfejs reprezentujący ładunek komunikatu powiadomienia API starszego typu FCM. Komunikaty powiadomień umożliwiają programistom wysyłanie do 4 KB predefiniowanych par klucz-wartość. Akceptowane klucze opisano poniżej.

Zobacz Kompiluj żądania wysyłania , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.

Podpis:

export interface NotificationMessagePayload 

Nieruchomości

Nieruchomość Typ Opis
odznaka strunowy Wartość odznaki na ikonie aplikacji na ekranie głównym. Jeśli nie określono inaczej, odznaka nie ulega zmianie. Jeśli ustawione na 0 , odznaka zostanie usunięta. **Platformy:** iOS
ciało strunowy Treść powiadomienia. **Platformy:** iOS, Android, Internet
bodyLocArgs strunowy Zmienne wartości ciągu, które mają być używane zamiast specyfikatorów formatu w body_loc_key w celu zlokalizowania tekstu treści w bieżącej lokalizacji użytkownika. Wartość powinna być ciągłą tablicą JSON. **iOS:** Odpowiada loc-args w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień . **Android:** Aby uzyskać więcej informacji, zobacz Formatowanie i stylizacja . **Platformy:** iOS, Android
bodyLocKey strunowy Klucz do ciągu treści w zasobach ciągu aplikacji, który ma być używany do lokalizowania tekstu treści w bieżącej lokalizacji użytkownika. **iOS:** Odpowiada loc-key w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień . **Android:** Aby uzyskać więcej informacji, zobacz Zasoby ciągów znaków . **Platformy:** iOS, Android
kliknij Akcja strunowy Akcja powiązana z kliknięciem przez użytkownika powiadomienia. Jeśli określono, działanie z pasującym filtrem intencji zostanie uruchomione, gdy użytkownik kliknie powiadomienie. * **Platformy:** Android
kolor strunowy Kolor ikony powiadomienia wyrażony w formacie #rrggbb . **Platformy:** Android
Ikona strunowy Ikona powiadomienia. **Android:** Ustawia ikonę powiadomienia na myicon dla myicon zasobu do rysowania. Jeśli nie wyślesz tego klucza w żądaniu, FCM wyświetli ikonę programu uruchamiającego określoną w manifeście aplikacji. **Sieć internetowa:** Adres URL ikony powiadomienia. **Platformy:** Android, internet
dźwięk strunowy Dźwięk odtwarzany, gdy urządzenie otrzyma powiadomienie. Obsługuje „domyślny” dźwięk powiadomienia urządzenia lub nazwę pliku zasobu dźwiękowego dołączonego do aplikacji. Pliki dźwiękowe muszą znajdować się w /res/raw/ . **Platformy:** Android
etykietka strunowy Identyfikator używany do zastąpienia istniejących powiadomień w szufladzie powiadomień. Jeśli nie określono, każde żądanie tworzy nowe powiadomienie. Jeśli zostało to określone, a powiadomienie z tym samym tagiem jest już wyświetlane, nowe powiadomienie zastępuje istniejące w szufladzie powiadomień. **Platformy:** Android
tytuł strunowy Tytuł powiadomienia. **Platformy:** iOS, Android, Internet
tytułLocArgs strunowy Zmienne wartości łańcuchowe, które mają być używane zamiast specyfikatorów formatu w title_loc_key w celu zlokalizowania tekstu tytułu w bieżącej lokalizacji użytkownika. Wartość powinna być ciągłą tablicą JSON. **iOS:** Odpowiada title-loc-args w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień . **Android:** Aby uzyskać więcej informacji, zobacz Formatowanie i stylizacja . **Platformy:** iOS, Android
tytułLocKey strunowy Klucz do ciągu tytułu w zasobach ciągu aplikacji, który ma być używany do lokalizowania tekstu tytułu w bieżącej lokalizacji użytkownika. **iOS:** Odpowiada title-loc-key w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień . **Android:** Aby uzyskać więcej informacji, zobacz Zasoby ciągów znaków . **Platformy:** iOS, Android

NotificationMessagePayload.badge

Wartość odznaki na ikonie aplikacji na ekranie głównym.

Jeśli nie określono inaczej, odznaka nie ulega zmianie.

Jeśli ustawione na 0 , odznaka zostaje usunięta.

**Platformy:** iOS

Podpis:

badge?: string;

NotificationMessagePayload.body

Treść powiadomienia.

**Platformy:** iOS, Android, Internet

Podpis:

body?: string;

NotificationMessagePayload.bodyLocArgs

Zmienne wartości ciągu, które mają być używane zamiast specyfikatorów formatu w body_loc_key w celu zlokalizowania tekstu treści w bieżącej lokalizacji użytkownika.

Wartość powinna być ciągłą tablicą JSON.

**iOS:** Odpowiada loc-args w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień .

**Android:** Aby uzyskać więcej informacji, zobacz Formatowanie i stylizacja .

**Platformy:** iOS, Android

Podpis:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

Klucz do ciągu treści w zasobach ciągu aplikacji, który ma być używany do lokalizowania tekstu treści w bieżącej lokalizacji użytkownika.

**iOS:** Odpowiada loc-key w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień .

**Android:** Aby uzyskać więcej informacji, zobacz Zasoby ciągów znaków .

**Platformy:** iOS, Android

Podpis:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

Akcja powiązana z kliknięciem przez użytkownika powiadomienia. Jeśli określono, działanie z pasującym filtrem intencji zostanie uruchomione, gdy użytkownik kliknie powiadomienie.

* **Platformy:** Android

Podpis:

clickAction?: string;

NotificationMessagePayload.color

Kolor ikony powiadomienia wyrażony w formacie #rrggbb .

**Platformy:** Android

Podpis:

color?: string;

NotificationMessagePayload.icon

Ikona powiadomienia.

**Android:** Ustawia ikonę powiadomienia na myicon dla myicon zasobu do rysowania . Jeśli nie wyślesz tego klucza w żądaniu, FCM wyświetli ikonę programu uruchamiającego określoną w manifeście aplikacji.

**Sieć internetowa:** Adres URL ikony powiadomienia.

**Platformy:** Android, internet

Podpis:

icon?: string;

NotificationMessagePayload.sound

Dźwięk odtwarzany, gdy urządzenie otrzyma powiadomienie. Obsługuje „domyślny” dźwięk powiadomienia urządzenia lub nazwę pliku zasobu dźwiękowego dołączonego do aplikacji. Pliki dźwiękowe muszą znajdować się w /res/raw/ .

**Platformy:** Android

Podpis:

sound?: string;

NotificationMessagePayload.tag

Identyfikator używany do zastąpienia istniejących powiadomień w szufladzie powiadomień.

Jeśli nie określono, każde żądanie tworzy nowe powiadomienie.

Jeśli zostało to określone, a powiadomienie z tym samym tagiem jest już wyświetlane, nowe powiadomienie zastępuje istniejące w szufladzie powiadomień.

**Platformy:** Android

Podpis:

tag?: string;

NotificationMessagePayload.title

Tytuł powiadomienia.

**Platformy:** iOS, Android, Internet

Podpis:

title?: string;

NotificationMessagePayload.titleLocArgs

Zmienne wartości łańcuchowe, które mają być używane zamiast specyfikatorów formatu w title_loc_key w celu zlokalizowania tekstu tytułu w bieżącej lokalizacji użytkownika.

Wartość powinna być ciągłą tablicą JSON.

**iOS:** Odpowiada title-loc-args w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień .

**Android:** Aby uzyskać więcej informacji, zobacz Formatowanie i stylizacja .

**Platformy:** iOS, Android

Podpis:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

Klucz do ciągu tytułu w zasobach ciągu aplikacji, który ma być używany do lokalizowania tekstu tytułu w bieżącej lokalizacji użytkownika.

**iOS:** Odpowiada title-loc-key w ładunku APN. Aby uzyskać więcej informacji, zobacz Informacje o kluczu ładunku i Lokalizowanie zawartości zdalnych powiadomień .

**Android:** Aby uzyskać więcej informacji, zobacz Zasoby ciągów znaków .

**Platformy:** iOS, Android

Podpis:

titleLocKey?: string;