MessagingOptions interface

Interfejs reprezentujący opcje, które można udostępnić podczas wysyłania wiadomości za pośrednictwem starszych interfejsów API FCM.

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

Podpis:

export interface MessagingOptions 

Nieruchomości

Nieruchomość Typ Opis
zwińKlucz strunowy Ciąg identyfikujący grupę wiadomości (na przykład „Dostępne aktualizacje”), którą można zwinąć, tak aby po wznowieniu dostarczania została wysłana tylko ostatnia wiadomość. Pozwala to uniknąć wysyłania zbyt wielu takich samych wiadomości, gdy urządzenie wróci do trybu online lub stanie się aktywne. Nie ma gwarancji kolejności wysyłania wiadomości. W danym momencie dozwolone są maksymalnie cztery różne klawisze zwijania. Oznacza to, że serwer FCM może jednocześnie przechowywać cztery różne komunikaty wysyłania do synchronizacji dla każdej aplikacji klienckiej. Jeśli przekroczysz tę liczbę, nie ma gwarancji, które cztery klucze zwijania zachowa serwer FCM. **Wartość domyślna:** Brak
treśćDostępna wartość logiczna W systemie iOS użyj tego pola, aby przedstawić content-available w ładunku APN. Po wysłaniu powiadomienia lub wiadomości z danymi i ustawieniu tej opcji na true , zostanie obudzona nieaktywna aplikacja kliencka. W systemie Android wiadomości danych domyślnie budzą aplikację. W przeglądarce Chrome ta flaga nie jest obecnie obsługiwana. **Wartość domyślna:** false
próba wartość logiczna Określa, czy wiadomość powinna faktycznie zostać wysłana. Po ustawieniu na true umożliwia programistom testowanie żądania bez wysyłania wiadomości. Po ustawieniu wartości false wiadomość zostanie wysłana. **Wartość domyślna:** false
zmienna zawartość wartość logiczna W systemie iOS użyj tego pola, aby reprezentować mutable-content w ładunku APN. Po wysłaniu powiadomienia i ustawieniu tej opcji na true treść powiadomienia można zmodyfikować przed jego wyświetleniem, korzystając z rozszerzenia aplikacji Notification Service . W systemie Android i Internecie ten parametr będzie ignorowany. **Wartość domyślna:** false
priorytet strunowy Priorytet wiadomości. Prawidłowe wartości to "normal" i "high". W systemie iOS odpowiadają one priorytetom APN 5 i 10 . Domyślnie powiadomienia są wysyłane z wysokim priorytetem, a wiadomości z danymi są wysyłane z normalnym priorytetem. Priorytet normalny optymalizuje zużycie baterii aplikacji klienckiej i powinien być używany, chyba że wymagana jest natychmiastowa dostawa. W przypadku wiadomości o normalnym priorytecie aplikacja może odebrać wiadomość z nieokreślonym opóźnieniem. Gdy wiadomość zostanie wysłana z wysokim priorytetem, zostanie wysłana natychmiast, a aplikacja może wybudzić uśpione urządzenie i otworzyć połączenie sieciowe z Twoim serwerem. Aby uzyskać więcej informacji, zobacz Ustawianie priorytetu wiadomości . **Wartość domyślna:** "high" dla powiadomień, "normal" dla komunikatów danych
ograniczona nazwa pakietu strunowy Nazwa pakietu aplikacji, do której muszą pasować tokeny rejestracyjne, aby otrzymać wiadomość. **Wartość domyślna:** Brak
czas żyć numer Jak długo (w sekundach) wiadomość powinna być przechowywana w pamięci FCM, jeśli urządzenie jest w trybie offline. Maksymalny obsługiwany czas życia wynosi cztery tygodnie, a wartość domyślna to również cztery tygodnie. Aby uzyskać więcej informacji, zobacz Ustawianie czasu życia wiadomości . **Wartość domyślna:** 2419200 (oznaczająca cztery tygodnie w sekundach)

MessagingOptions.collapseKey

Ciąg identyfikujący grupę wiadomości (na przykład „Dostępne aktualizacje”), którą można zwinąć, tak aby po wznowieniu dostarczania została wysłana tylko ostatnia wiadomość. Pozwala to uniknąć wysyłania zbyt wielu takich samych wiadomości, gdy urządzenie wróci do trybu online lub stanie się aktywne.

Nie ma gwarancji kolejności wysyłania wiadomości.

W danym momencie dozwolone są maksymalnie cztery różne klawisze zwijania. Oznacza to, że serwer FCM może jednocześnie przechowywać cztery różne komunikaty wysyłania do synchronizacji dla każdej aplikacji klienckiej. Jeśli przekroczysz tę liczbę, nie ma gwarancji, które cztery klucze zwijania zachowa serwer FCM.

**Wartość domyślna:** Brak

Podpis:

collapseKey?: string;

MessagingOptions.contentAvailable

W systemie iOS użyj tego pola, aby przedstawić content-available w ładunku APN. Gdy zostanie wysłane powiadomienie lub wiadomość z danymi i ta opcja jest ustawiona na true , zostanie obudzona nieaktywna aplikacja kliencka. W systemie Android wiadomości danych domyślnie budzą aplikację. W przeglądarce Chrome ta flaga nie jest obecnie obsługiwana.

**Wartość domyślna:** false

Podpis:

contentAvailable?: boolean;

MessagingOptions.dryRun

Określa, czy wiadomość powinna faktycznie zostać wysłana. Po ustawieniu na true , pozwala programistom przetestować żądanie bez wysyłania wiadomości. Po ustawieniu na false , wiadomość zostanie wysłana.

**Wartość domyślna:** false

Podpis:

dryRun?: boolean;

MessagingOptions.mutableContent

W systemie iOS użyj tego pola, aby reprezentować mutable-content w ładunku APN. Po wysłaniu powiadomienia i ustawieniu tej opcji na true , treść powiadomienia można zmodyfikować przed jego wyświetleniem, korzystając z rozszerzenia aplikacji Notification Service .

W systemie Android i Internecie ten parametr będzie ignorowany.

**Wartość domyślna:** false

Podpis:

mutableContent?: boolean;

Priorytet opcji przesyłania wiadomości

Priorytet wiadomości. Prawidłowe wartości to "normal" i "high". W systemie iOS odpowiadają one priorytetom APN 5 i 10 .

Domyślnie powiadomienia są wysyłane z wysokim priorytetem, a wiadomości z danymi są wysyłane z normalnym priorytetem. Priorytet normalny optymalizuje zużycie baterii aplikacji klienckiej i powinien być używany, chyba że wymagana jest natychmiastowa dostawa. W przypadku wiadomości o normalnym priorytecie aplikacja może odebrać wiadomość z nieokreślonym opóźnieniem.

Gdy wiadomość zostanie wysłana z wysokim priorytetem, zostanie wysłana natychmiast, a aplikacja może wybudzić uśpione urządzenie i otworzyć połączenie sieciowe z Twoim serwerem.

Aby uzyskać więcej informacji, zobacz Ustawianie priorytetu wiadomości .

**Wartość domyślna:** "high" dla powiadomień, "normal" dla komunikatów danych

Podpis:

priority?: string;

MessagingOptions.restrictedNazwaPakietu

Nazwa pakietu aplikacji, do której muszą pasować tokeny rejestracyjne, aby otrzymać wiadomość.

**Wartość domyślna:** Brak

Podpis:

restrictedPackageName?: string;

MessagingOptions.timeToLive

Jak długo (w sekundach) wiadomość powinna być przechowywana w pamięci FCM, jeśli urządzenie jest w trybie offline. Maksymalny obsługiwany czas życia wynosi cztery tygodnie, a wartość domyślna to również cztery tygodnie. Aby uzyskać więcej informacji, zobacz Ustawianie czasu życia wiadomości .

**Wartość domyślna:** 2419200 (oznaczająca cztery tygodnie w sekundach)

Podpis:

timeToLive?: number;