AndroidNotification interface

Reprezentuje opcje powiadomień specyficzne dla systemu Android, które można uwzględnić w AndroidConfig .

Podpis:

export interface AndroidNotification 

Nieruchomości

AndroidNotification.body

Treść powiadomienia Androida. Jeśli jest podany, zastępuje treść ustawioną poprzez admin.messaging.Notification .

Podpis:

body?: string;

AndroidNotification.bodyLocArgs

Tablica kluczy zasobów, które będą używane zamiast specyfikatorów formatu w bodyLocKey .

Podpis:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

Klucz ciągu treści w zasobie ciągu aplikacji, który ma zostać użyty do zlokalizowania tekstu treści.

Podpis:

bodyLocKey?: string;

AndroidNotification.channelId

Identyfikator kanału powiadomień systemu Android (nowość w systemie Android O). Aby możliwe było odebranie powiadomienia z tym identyfikatorem, aplikacja musi utworzyć kanał z tym identyfikatorem kanału. Jeśli nie wyślesz tego identyfikatora kanału w żądaniu lub jeśli podany identyfikator kanału nie został jeszcze utworzony przez aplikację, FCM użyje identyfikatora kanału określonego w manifeście aplikacji.

Podpis:

channelId?: string;

AndroidNotification.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.

Podpis:

clickAction?: string;

AndroidNotification.color

Kolor ikony powiadomienia w formacie #rrggbb .

Podpis:

color?: string;

AndroidNotification.defaultUstawienia światła

Jeśli ustawione na true , użyj domyślnych ustawień oświetlenia LED systemu Android dla powiadomień. Wartości domyślne są określone w pliku config.xml . Jeśli default_light_settings ma wartość true i light_settings jest również ustawiony, zamiast wartości domyślnej używane jest light_settings określone przez użytkownika.

Podpis:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

Jeśli ustawione na true , użyj domyślnego dźwięku platformy Android dla powiadomienia. Wartości domyślne są określone w pliku config.xml .

Podpis:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

Jeśli ustawione na true , użyj domyślnego wzorca wibracji platformy Android dla powiadomienia. Wartości domyślne są określone w pliku config.xml . Jeśli default_vibrate_timings jest ustawiony na true i vibrate_timings jest również ustawiony, używana jest wartość domyślna zamiast określonego przez użytkownika vibrate_timings .

Podpis:

defaultVibrateTimings?: boolean;

AndroidNotification.eventZnacznik czasu

Dla powiadomień informujących użytkowników o zdarzeniach z bezwzględnym odniesieniem czasowym, ustawia czas wystąpienia zdarzenia w powiadomieniu. Powiadomienia w panelu sortowane są według tego czasu.

Podpis:

eventTimestamp?: Date;

Ikona powiadomienia Androida

Zasób ikon dla powiadomienia Androida.

Podpis:

icon?: string;

AndroidNotification.imageUrl

Adres URL obrazu, który będzie wyświetlany w powiadomieniu.

Podpis:

imageUrl?: string;

Ustawienia AndroidNotification.light

Ustawienia sterujące częstotliwością i kolorem migania diody LED powiadomienia, jeśli na urządzeniu dostępna jest dioda LED. Całkowity czas migania jest kontrolowany przez system operacyjny.

Podpis:

lightSettings?: LightSettings;

Tylko AndroidNotification.local

Określa, czy to powiadomienie dotyczy tylko bieżącego urządzenia. Niektóre powiadomienia można połączyć z innymi urządzeniami w celu zdalnego wyświetlania, takimi jak zegarek z systemem Wear OS. Tę wskazówkę można ustawić tak, aby zalecała, aby to powiadomienie nie było mostkowane. Zobacz przewodniki dotyczące Wear OS .

Podpis:

localOnly?: boolean;

AndroidNotification.notificationCount

Ustawia liczbę elementów reprezentowanych przez to powiadomienie. Może być wyświetlany jako liczba odznak w przypadku wyrzutni obsługujących odznaki. Zobacz Odznakę powiadomienia . 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 tutaj przedstawiała całkowitą liczbę nowych wiadomości. Jeśli zero lub nieokreślone, systemy obsługujące plakietki używają ustawienia domyślnego, które polega na zwiększaniu liczby wyświetlanej w menu po długim naciśnięciu za każdym razem, gdy nadejdzie nowe powiadomienie.

Podpis:

notificationCount?: number;

Priorytet powiadomienia Androida

Ustawia względny priorytet tego powiadomienia. W niektórych sytuacjach powiadomienia o niskim priorytecie mogą być ukryte przed użytkownikiem. Należy pamiętać, że ten priorytet różni się od AndroidMessagePriority . Priorytet ten jest przetwarzany przez klienta po dostarczeniu wiadomości. Natomiast AndroidMessagePriority to koncepcja FCM, która kontroluje, kiedy wiadomość jest dostarczana.

Podpis:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

Dźwięk powiadomienia Androida

Nazwa pliku dźwięku, który będzie odtwarzany, gdy urządzenie odbierze powiadomienie.

Podpis:

sound?: string;

Powiadomienia Androida.przyklejone

Jeśli opcja ma false lub jest nieskonfigurowana, powiadomienie zostanie automatycznie odrzucone, gdy użytkownik kliknie je w panelu. Po ustawieniu na true , powiadomienie będzie widoczne nawet po kliknięciu przez użytkownika.

Podpis:

sticky?: boolean;

AndroidNotification.tag

Znacznik powiadomienia. Jest to identyfikator używany do zastąpienia istniejących powiadomień w szufladzie powiadomień. Jeśli nie określono, każde żądanie tworzy nowe powiadomienie.

Podpis:

tag?: string;

AndroidNotification.ticker

Ustawia tekst „tickera”, który jest wysyłany do usług ułatwień dostępu. Przed wersją interfejsu API 21 (Lollipop) ustawia tekst wyświetlany na pasku stanu po pierwszym nadejściu powiadomienia.

Podpis:

ticker?: string;

AndroidNotification.title

Tytuł powiadomienia na Androidzie. Jeśli jest podany, zastępuje tytuł ustawiony za pośrednictwem admin.messaging.Notification .

Podpis:

title?: string;

AndroidNotification.titleLocArgs

Tablica kluczy zasobów, które będą używane zamiast specyfikatorów formatu w titleLocKey .

Podpis:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

Klucz ciągu tytułu w zasobie ciągu aplikacji, który ma zostać użyty do zlokalizowania tekstu tytułu.

Podpis:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

Ustawia używany wzór wibracji. Podaj tablicę milisekund, aby włączyć lub wyłączyć wibrator. Pierwsza wartość wskazuje czas oczekiwania przed włączeniem wibratora. Następna wartość wskazuje czas działania wibratora. Kolejne wartości zmieniają się pomiędzy czasem trwania wyłączenia wibratora i włączenia wibratora. Jeśli ustawiono vibrate_timings i default_vibrate_timings ustawiono na true , zamiast określonego przez użytkownika vibrate_timings używana jest wartość domyślna .

Podpis:

vibrateTimingsMillis?: number[];

Widoczność powiadomień Androida

Ustawia widoczność powiadomienia. Musi być private , public lub secret . Jeśli nie określono, domyślnie jest to private .

Podpis:

visibility?: ('private' | 'public' | 'secret');