NotificationMessagePayload interface

Interfejs reprezentujący ładunek wiadomości powiadomienia starszego interfejsu API FCM. Wiadomości z powiadomieniami pozwalają programistom wysyłać do 4 KB wstępnie zdefiniowanych par klucz-wartość. Poniżej znajdziesz akceptowane klucze.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Tworzenie żądań wysyłania.

Podpis:

export interface NotificationMessagePayload 

Właściwości

Właściwość Typ Opis
plakietka ciąg znaków Wartość plakietki umieszczonej na ikonie aplikacji na ekranie głównym.Jeśli jej nie podasz, plakietka nie zostanie zmieniona.Jeśli ustawisz wartość 0, plakietka zostanie usunięta.**Platformy:** iOS
body ciąg znaków Treść powiadomienia.**Platformy:** iOS, Android, internet
bodyLocArgs ciąg znaków Wartości ciągów zmiennych, które mają być używane zamiast specyfikatorów formatu w zasadzie body_loc_key w celu zlokalizowania tekstu treści w aktualnej lokalizacji użytkownika.Wartość powinna być tablicą JSON zgodną z ciągiem znaków.**iOS:** odpowiada loc-args w ładunku APNs. Więcej informacji znajdziesz w opisie klucza ładunku i lokalizacji zawartości powiadomień zdalnych.**Android:** więcej informacji znajdziesz w artykule Formatowanie i styl.**Platformy:** iOS, Android
bodyLocKey ciąg znaków Klucz do ciągu tekstowego w zasobach ciągu aplikacji w celu zlokalizowania tekstu treści w aktualnej lokalizacji użytkownika.**iOS:** odpowiada parametrowi loc-key w ładunku APNs. Więcej informacji znajdziesz w opisie klucza ładunku i lokalizacji zawartości powiadomień zdalnych.**Android:** aby dowiedzieć się więcej, zapoznaj się z zasobami dotyczącymi ciągów znaków.**Platformy:** iOS, Android
clickAction ciąg znaków Działanie powiązane z kliknięciem powiadomienia przez użytkownika. Jeśli określisz działanie z pasującym filtrem intencji, uruchamia się ona, gdy użytkownik kliknie powiadomienie.* **Platformy:** Android
color [kolor] ciąg znaków Kolor ikony powiadomienia wyrażony w formacie #rrggbb.**Platformy:** Android
ikona ciąg znaków Ikona powiadomienia.**Android:** ustawia ikonę powiadomień na myicon dla zasobu rysowalnego myicon. Jeśli nie wyślesz tego klucza w żądaniu, FCM wyświetli ikonę programu uruchamiającego określoną w manifeście aplikacji.**Web:** URL używany jako ikona powiadomienia.**Platformy:** Android, internet
dźwięk ciąg znaków Dźwięk, który będzie odtwarzany, gdy urządzenie otrzyma powiadomienie. Obsługuje ustawienie „default” dla domyślnego dźwięku powiadomień urządzenia lub nazwy pliku zasobu dźwiękowego dołączonego do aplikacji. Pliki dźwiękowe muszą znajdować się w: /res/raw/.**Platformy:** Android
otaguj ciąg znaków Identyfikator używany do zastępowania dotychczasowych powiadomień w panelu powiadomień.Jeśli nie podasz go, każde żądanie utworzy nowe powiadomienie.Jeśli określisz powiadomienie z tym samym tagiem, a powiadomienie z tym samym tagiem jest już wyświetlane, nowe powiadomienie zastąpi dotychczasowe.**Platformy:** Android
title ciąg znaków Tytuł powiadomienia.**Platformy:** iOS, Android, internet
titleLocArgs ciąg znaków Wartości ciągów zmiennych, które mają być używane zamiast specyfikatorów formatu w zasadzie title_loc_key, które mają być używane do zlokalizowania tekstu tytułu w aktualnej lokalizacji użytkownika.Wartość powinna być tablicą JSON zgodną z ciągiem znaków.**iOS:** odpowiada title-loc-args w ładunku APNs. Więcej informacji znajdziesz w opisie klucza ładunku i lokalizacji zawartości powiadomień zdalnych.**Android:** więcej informacji znajdziesz w artykule Formatowanie i styl.**Platformy:** iOS, Android
klucz titleLocKey ciąg znaków Klucz do ciągu tytułu w zasobach ciągu aplikacji w aplikacji, który ma być używany do zlokalizowania tekstu tytułu w aktualnej lokalizacji użytkownika.**iOS:** odpowiada parametrowi title-loc-key w ładunku APNs. Więcej informacji znajdziesz w opisie klucza ładunku i lokalizacji zawartości powiadomień zdalnych.**Android:** aby dowiedzieć się więcej, zapoznaj się z zasobami dotyczącymi ciągów znaków.**Platformy:** iOS, Android

NotificationMessagePayload.badge

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

Jeśli go nie podasz, identyfikator się nie zmieni.

Jeśli ma wartość 0, plakietka zostanie usunięta.

**Platformy:** iOS

Podpis:

badge?: string;

NotificationMessagePayload.body

Treść powiadomienia.

**Platformy:** iOS, Android, internet

Podpis:

body?: string;

NotificationMessagePayload.bodyLocArgs

Wartości ciągów zmiennych, które mają być używane zamiast specyfikatorów formatu w tabeli body_loc_key służącej do zlokalizowania tekstu głównego w aktualnej lokalizacji użytkownika.

Wartość powinna być tablicą JSON w formie ciągu znaków.

**iOS:** odpowiada parametrowi loc-args w ładunku APNs. Więcej informacji znajdziesz w artykułach Odniesienie do klucza ładunku i Lokalizowanie treści powiadomień zdalnych.

**Android:** więcej informacji znajdziesz w artykule Formatowanie i styl.

**Platformy:** iOS, Android

Podpis:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

Klucz do ciągu tekstowego w zasobach ciągu tekstowego aplikacji, który ma być używany do zlokalizowania tekstu głównego w aktualnej lokalizacji użytkownika.

**iOS:** odpowiada parametrowi loc-key w ładunku APNs. Więcej informacji znajdziesz w artykułach Odniesienie do klucza ładunku i Lokalizowanie treści powiadomień zdalnych.

**Android:** więcej informacji znajdziesz w zasobach dotyczących ciągów tekstowych.

**Platformy:** iOS, Android

Podpis:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

Działanie powiązane z kliknięciem powiadomienia przez użytkownika. Jeśli zostanie określony, aktywność z pasującym filtrem intencji uruchamia się, gdy użytkownik kliknie powiadomienie.

* **Platformy:** Android

Podpis:

clickAction?: string;

NotificationMessagePayload.color

Kolor ikony powiadomienia w formacie #rrggbb.

**Platformy:** Android

Podpis:

color?: string;

NotificationMessagePayload.icon

Ikona powiadomienia.

**Android:** ustawia ikonę powiadomień na myicon dla zasobu, który można rysować myicon. Jeśli nie wyślesz tego klucza w żądaniu, FCM wyświetli ikonę programu uruchamiającego określoną w manifeście aplikacji.

**Internet**: adres URL, którego chcesz używać jako ikony powiadomienia.

**Platformy:** Android, internet

Podpis:

icon?: string;

NotificationMessagePayload.sound

Dźwięk, który będzie odtwarzany, gdy urządzenie otrzyma powiadomienie. Obsługuje ustawienie „default” dla domyślnego dźwięku powiadomień urządzenia lub nazwy pliku zasobu dźwiękowego dołączonego do aplikacji. Pliki dźwiękowe muszą znajdować się w lokalizacji /res/raw/.

**Platformy:** Android

Podpis:

sound?: string;

NotificationMessagePayload.tag

Identyfikator używany do zastępowania obecnych powiadomień w panelu powiadomień.

Jeśli go nie podasz, dla każdego żądania tworzone będzie nowe powiadomienie.

Jeśli określisz powiadomienie z tym samym tagiem i wyświetla się już powiadomienie z tym samym tagiem, nowe powiadomienie zastąpi dotychczasowe w panelu powiadomień.

**Platformy:** Android

Podpis:

tag?: string;

NotificationMessagePayload.title

Tytuł powiadomienia.

**Platformy:** iOS, Android, internet

Podpis:

title?: string;

NotificationMessagePayload.titleLocArgs

Wartości ciągów zmiennych, które mają być używane zamiast specyfikatorów formatu w tabeli title_loc_key służącej do zlokalizowania tekstu tytułu w aktualnej lokalizacji użytkownika.

Wartość powinna być tablicą JSON w formie ciągu znaków.

**iOS:** odpowiada parametrowi title-loc-args w ładunku APNs. Więcej informacji znajdziesz w artykułach Odniesienie do klucza ładunku i Lokalizowanie treści powiadomień zdalnych.

**Android:** więcej informacji znajdziesz w artykule Formatowanie i styl.

**Platformy:** iOS, Android

Podpis:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

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

**iOS:** odpowiada parametrowi title-loc-key w ładunku APNs. Więcej informacji znajdziesz w artykułach Odniesienie do klucza ładunku i Lokalizowanie treści powiadomień zdalnych.

**Android:** więcej informacji znajdziesz w zasobach dotyczących ciągów tekstowych.

**Platformy:** iOS, Android

Podpis:

titleLocKey?: string;