Reprezentuje opcje powiadomień związane z Androidem, które można uwzględnić w elemencie AndroidConfig.
Podpis:
export interface AndroidNotification
Właściwości
Właściwość | Typ | Opis |
---|---|---|
body | ciąg znaków | Treść powiadomienia z Androida. Jeśli zostanie podany, zastąpi treść ustawioną w polu admin.messaging.Notification . |
bodyLocArgs | ciąg znaków[] | Tablica kluczy zasobów, które będą używane zamiast specyfikatorów formatu w bodyLocKey . |
bodyLocKey | ciąg znaków | Klucz ciągu tekstowego treści w zasobie ciągu tekstowego aplikacji, który ma być używany do lokalizowania tekstu treści. |
channelId, | ciąg znaków | Identyfikator kanału powiadomień Androida (nowość w Androidzie O). Aplikacja musi utworzyć kanał z tym identyfikatorem, zanim będzie można otrzymywać powiadomienia z tym identyfikatorem. Jeśli nie prześlesz identyfikatora kanału w prośbie lub jeśli podany identyfikator kanału nie został jeszcze utworzony przez aplikację, FCM użyje identyfikatora kanału określonego w pliku manifestu aplikacji. |
clickAction | ciąg znaków | 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. |
color [kolor] | ciąg znaków | Kolor ikony powiadomień w formacie #rrggbb . |
domyślne ustawienia oświetlenia | wartość logiczna | Jeśli zasada ma wartość true , jako powiadomienia użyj domyślnych ustawień diody LED na platformie Androida. Wartości domyślne są podane w pliku config.xml. Jeśli zasada default_light_settings ma wartość true , a zasada light_settings jest ustawiona, zamiast wartości domyślnej jest używana określona przez użytkownika light_settings . |
defaultDźwięk | wartość logiczna | Jeśli ma wartość true , użyj dla powiadomienia domyślnego dźwięku platformy Androida. Wartości domyślne są podane w pliku config.xml. |
domyślne ustawienia wibracji | wartość logiczna | Jeśli zasada ma wartość true , użyj domyślnego wzoru wibracji platformy Androida dla powiadomienia. Wartości domyślne są podane w pliku config.xml. Jeśli zasada default_vibrate_timings ma wartość true i jest skonfigurowana vibrate_timings , zamiast określonej przez użytkownika wartości vibrate_timings używana jest wartość domyślna. |
eventTimestamp | Data | W przypadku powiadomień informujących użytkowników o zdarzeniach za pomocą odwołania w czasie bezwzględnym określa czas wystąpienia zdarzenia w powiadomieniu. Powiadomienia w panelu są sortowane według tej godziny. |
ikona | ciąg znaków | Ikona zasobu powiadomień Androida. |
imageUrl | ciąg znaków | Adres URL obrazu, który ma być wyświetlany w powiadomieniu. |
Ustawienia oświetlenia | Ustawienia oświetlenia | Ustawienia sterujące szybkością migania i kolorem diody LED powiadomienia, jeśli na urządzeniu jest dostępna dioda LED. Całkowity czas migania zależy od systemu operacyjnego. |
localOnly | wartość logiczna | Określa, czy to powiadomienie dotyczy tylko bieżącego urządzenia. Niektóre powiadomienia można połączyć z innymi urządzeniami, aby wyświetlać zdalne, np. zegarkiem z Wear OS. Tę wskazówkę można skonfigurować tak, aby zalecała, że to powiadomienie nie jest mostowane. Zobacz przewodniki po Wear OS. |
notificationCount, | liczba | Ustawia liczbę elementów reprezentowanych przez to powiadomienie. Może być wyświetlana jako liczba odznak w przypadku Launcherów obsługujących plakietki. Patrz sekcja notificationBadge. Może to być na przykład przydatne, jeśli używasz tylko jednego powiadomienia do reprezentowania wielu nowych wiadomości, ale chcesz, aby liczba nowych wiadomości odzwierciedlała łączną liczbę nowych wiadomości. Jeśli wartość nie jest określona lub nie ma podanej wartości, systemy obsługujące plakietki używają wartości domyślnej, która powoduje zwiększanie liczby wyświetlanej w menu przytrzymanym za każdym razem, gdy przychodzi nowe powiadomienie. |
priorytet | ('min' | 'low' | „default” | „high” | „max” (maks.) | Określa względny priorytet tego powiadomienia. W niektórych sytuacjach powiadomienia o niskim priorytecie mogą być ukryte przed użytkownikiem. Pamiętaj, że ten priorytet różni się od tego priorytetu: AndroidMessagePriority . Ten priorytet jest przetwarzany przez klienta po dostarczeniu wiadomości. Natomiast AndroidMessagePriority to pojęcie FCM określające, kiedy wiadomość jest dostarczana. |
dźwięk | ciąg znaków | Nazwa pliku z dźwiękiem, który ma być odtwarzany, gdy urządzenie otrzyma powiadomienie. |
przyklejone | wartość logiczna | Jeśli zasada ma wartość false lub jest nieskonfigurowana, powiadomienie jest automatycznie zamykane, gdy użytkownik kliknie je w panelu. Gdy ma wartość true , powiadomienie jest wyświetlane nawet wtedy, gdy użytkownik je kliknie. |
otaguj | ciąg znaków | Tag powiadomienia. To identyfikator, który zastępuje dotychczasowe powiadomienia w panelu powiadomień. Jeśli go nie podasz, dla każdego żądania tworzone będzie nowe powiadomienie. |
symbol_giełdowy | ciąg znaków | Ustawia pasek aktywności tekst, który jest wysyłany do usług ułatwień dostępu. Przed poziomem interfejsu API 21 (Lollipop) ustawia tekst, który ma być wyświetlany na pasku stanu w chwili otrzymania powiadomienia. |
title | ciąg znaków | Tytuł powiadomienia z Androida. Jeśli zostanie podany, zastąpi tytuł ustawiony w polu admin.messaging.Notification . |
titleLocArgs | ciąg znaków[] | Tablica kluczy zasobów, które będą używane zamiast specyfikatorów formatu w titleLocKey . |
klucz titleLocKey | ciąg znaków | Klucz ciągu tytułu w zasobie ciągu tekstowego aplikacji, który ma być używany do lokalizowania tekstu tytułu. |
vibrrateTimingsMillis | liczba[] | Określa używany wzór wibracji. Aby włączyć lub wyłączyć wibracje, podaj milisekundy. Pierwsza wartość określa czas oczekiwania przed włączeniem wibracji. Następna wartość wskazuje czas, przez jaki wibracje mają być włączone. Kolejne wartości zmieniają czas trwania, aby wyłączyć lub włączyć wibracje. Jeśli zasada vibrate_timings jest ustawiona, a default_vibrate_timings ma wartość true , używana jest wartość domyślna zamiast określonej przez użytkownika wartości vibrate_timings . |
widoczność | ('private' | 'public' | 'tajny') | Ustawia widoczność powiadomienia. Musi to być private , public lub secret . Jeśli nie określono inaczej, domyślna wartość to private . |
AndroidPowiadomienie.body
Treść powiadomienia z Androida. Jeśli zostanie podany, zastąpi treść ustawioną w polu admin.messaging.Notification
.
Podpis:
body?: string;
AndroidPowiadomienie.bodyLocArgs
Tablica kluczy zasobów, które będą używane zamiast specyfikatorów formatu w bodyLocKey
.
Podpis:
bodyLocArgs?: string[];
AndroidPowiadomienie.bodyLocKey
Klucz ciągu tekstowego treści w zasobie ciągu tekstowego aplikacji, który ma być używany do lokalizowania tekstu treści.
Podpis:
bodyLocKey?: string;
Androidnotification.channelId
Identyfikator kanału powiadomień Androida (nowość w Androidzie O). Aplikacja musi utworzyć kanał z tym identyfikatorem, zanim będzie można otrzymywać powiadomienia z tym identyfikatorem. Jeśli nie prześlesz identyfikatora kanału w prośbie lub jeśli podany identyfikator kanału nie został jeszcze utworzony przez aplikację, FCM użyje identyfikatora kanału określonego w pliku manifestu aplikacji.
Podpis:
channelId?: string;
AndroidPowiadomienie.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.
Podpis:
clickAction?: string;
AndroidPowiadomienie.color
Kolor ikony powiadomień w formacie #rrggbb
.
Podpis:
color?: string;
AndroidPowiadomienie.defaultLightSettings
Jeśli zasada ma wartość true
, jako powiadomienia użyj domyślnych ustawień diody LED na platformie Androida. Wartości domyślne są podane w pliku config.xml. Jeśli zasada default_light_settings
ma wartość true
, a zasada light_settings
jest ustawiona, zamiast wartości domyślnej jest używana określona przez użytkownika light_settings
.
Podpis:
defaultLightSettings?: boolean;
AndroidPowiadomienie.defaultSound
Jeśli ma wartość true
, użyj dla powiadomienia domyślnego dźwięku platformy Androida. Wartości domyślne są podane w pliku config.xml.
Podpis:
defaultSound?: boolean;
AndroidPowiadomienie.defaultVibrateTimings
Jeśli ma wartość true
, użyj domyślnego wzoru wibracji platformy Androida dla powiadomienia. Wartości domyślne są podane w pliku config.xml. Jeśli zasada default_vibrate_timings
ma wartość true
, a ustawienie vibrate_timings
jest określone, zamiast wartości vibrate_timings
określonej przez użytkownika używana jest wartość domyślna.
Podpis:
defaultVibrateTimings?: boolean;
AndroidPowiadomienie.eventTimestamp
W przypadku powiadomień informujących użytkowników o zdarzeniach za pomocą odwołania w czasie bezwzględnym określa czas wystąpienia zdarzenia w powiadomieniu. Powiadomienia w panelu są sortowane według tej godziny.
Podpis:
eventTimestamp?: Date;
AndroidPowiadomienie.ikona
Ikona zasobu powiadomień Androida.
Podpis:
icon?: string;
AndroidPowiadomienie.imageUrl
Adres URL obrazu, który ma być wyświetlany w powiadomieniu.
Podpis:
imageUrl?: string;
AndroidPowiadomienie.lightSettings.
Ustawienia sterujące szybkością migania i kolorem diody LED powiadomienia, jeśli na urządzeniu jest dostępna dioda LED. Całkowity czas migania zależy od systemu operacyjnego.
Podpis:
lightSettings?: LightSettings;
AndroidPowiadomienie.localOnly
Określa, czy to powiadomienie dotyczy tylko bieżącego urządzenia. Niektóre powiadomienia można połączyć z innymi urządzeniami, aby wyświetlać zdalne, np. zegarkiem z Wear OS. Tę wskazówkę można skonfigurować tak, aby zalecała, że to powiadomienie nie jest mostowane. Zobacz przewodniki po Wear OS.
Podpis:
localOnly?: boolean;
AndroidPowiadomienie.notificationCount
Ustawia liczbę elementów reprezentowanych przez to powiadomienie. Może być wyświetlana jako liczba odznak w przypadku Launcherów obsługujących plakietki. Patrz sekcja notificationBadge. Może to być na przykład przydatne, jeśli używasz tylko jednego powiadomienia do reprezentowania wielu nowych wiadomości, ale chcesz, aby liczba nowych wiadomości odzwierciedlała łączną liczbę nowych wiadomości. Jeśli wartość nie jest określona lub nie ma podanej wartości, systemy obsługujące plakietki używają wartości domyślnej, która powoduje zwiększanie liczby wyświetlanej w menu przytrzymanym za każdym razem, gdy przychodzi nowe powiadomienie.
Podpis:
notificationCount?: number;
AndroidPowiadomienie.Priority
Określa względny priorytet tego powiadomienia. W niektórych sytuacjach powiadomienia o niskim priorytecie mogą być ukryte przed użytkownikiem. Pamiętaj, że ten priorytet różni się od tego priorytetu: AndroidMessagePriority
. Ten priorytet jest przetwarzany przez klienta po dostarczeniu wiadomości. Natomiast AndroidMessagePriority
to pojęcie FCM określające, kiedy wiadomość jest dostarczana.
Podpis:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
AndroidPowiadomienie.sound
Nazwa pliku z dźwiękiem, który ma być odtwarzany, gdy urządzenie otrzyma powiadomienie.
Podpis:
sound?: string;
Androidnotification.sticky.
Jeśli zasada ma wartość false
lub jest nieskonfigurowana, powiadomienie jest automatycznie zamykane, gdy użytkownik kliknie je w panelu. Gdy ustawisz wartość true
, powiadomienie będzie się powtarzało nawet wtedy, gdy użytkownik je kliknie.
Podpis:
sticky?: boolean;
AndroidPowiadomienie.tag
Tag powiadomienia. To identyfikator, który zastępuje dotychczasowe powiadomienia w panelu powiadomień. Jeśli go nie podasz, dla każdego żądania tworzone będzie nowe powiadomienie.
Podpis:
tag?: string;
AndroidPowiadomienie.ticker
Ustawia pasek aktywności tekst, który jest wysyłany do usług ułatwień dostępu. Przed poziomem interfejsu API 21 (Lollipop) ustawia tekst, który ma być wyświetlany na pasku stanu w chwili otrzymania powiadomienia.
Podpis:
ticker?: string;
AndroidPowiadomienie.title
Tytuł powiadomienia z Androida. Jeśli zostanie podany, zastąpi tytuł ustawiony w polu admin.messaging.Notification
.
Podpis:
title?: string;
AndroidPowiadomienie.titleLocArgs
Tablica kluczy zasobów, które będą używane zamiast specyfikatorów formatu w titleLocKey
.
Podpis:
titleLocArgs?: string[];
AndroidPowiadomienie.titleLocKey
Klucz ciągu tytułu w zasobie ciągu tekstowego aplikacji, który ma być używany do lokalizowania tekstu tytułu.
Podpis:
titleLocKey?: string;
AndroidPowiadomienie.vibrateTimingsMillis
Określa używany wzór wibracji. Aby włączyć lub wyłączyć wibracje, podaj milisekundy. Pierwsza wartość określa czas oczekiwania przed włączeniem wibracji. Następna wartość wskazuje czas, przez jaki wibracje mają być włączone. Kolejne wartości zmieniają czas trwania, aby wyłączyć lub włączyć wibracje. Jeśli zasada vibrate_timings
jest ustawiona, a zasada default_vibrate_timings
ma wartość true
, używana jest wartość domyślna zamiast określonej przez użytkownika wartości vibrate_timings
.
Podpis:
vibrateTimingsMillis?: number[];
AndroidPowiadomienie.visibility
Ustawia widoczność powiadomienia. Musi to być private
, public
lub secret
. Jeśli nie określono inaczej, domyślna wartość to private
.
Podpis:
visibility?: ('private' | 'public' | 'secret');