MessagingOptions interface

Interfaccia che rappresenta le opzioni che possono essere fornite quando si invia un messaggio tramite le API legacy FCM.

Vedi Compilare richieste di invio per esempi di codice e documentazione dettagliata.

Firma:

export interface MessagingOptions 

Proprietà

MessagingOptions.collapseKey

Stringa che identifica un gruppo di messaggi (ad esempio, "Aggiornamenti disponibili") che può essere compresso, in modo che solo l'ultimo messaggio venga inviato quando è possibile riprendere la consegna. Viene utilizzato per evitare di inviare troppi messaggi uguali quando il dispositivo torna online o diventa attivo.

Non esiste alcuna garanzia sull'ordine in cui i messaggi vengono inviati.

È consentito un massimo di quattro chiavi di compressione diverse alla volta. Ciò significa che il server FCM può archiviare contemporaneamente quattro diversi messaggi di invio alla sincronizzazione per app client. Se si supera questo numero, non vi è alcuna garanzia su quali quattro chiavi di compressione manterrà il server FCM.

**Valore predefinito:** Nessuno

Firma:

collapseKey?: string;

MessagingOptions.contentAvailable

Su iOS, utilizza questo campo per rappresentare content-available nel payload APN. Quando viene inviato un messaggio di notifica o di dati e questo è impostato su true , viene riattivata un'app client inattiva. Su Android, i messaggi di dati riattivano l'app per impostazione predefinita. Su Chrome, questo flag non è attualmente supportato.

**Valore predefinito:** false

Firma:

contentAvailable?: boolean;

MessagingOptions.dryRun

Indica se il messaggio deve essere effettivamente inviato o meno. Quando impostato su true , consente agli sviluppatori di testare una richiesta senza effettivamente inviare un messaggio. Quando impostato su false , il messaggio verrà inviato.

**Valore predefinito:** false

Firma:

dryRun?: boolean;

MessagingOptions.mutableContent

Su iOS, utilizza questo campo per rappresentare mutable-content nel payload APN. Quando viene inviata una notifica e questo è impostato su true , il contenuto della notifica può essere modificato prima che venga visualizzato, utilizzando un'estensione dell'app Notification Service .

Su Android e Web, questo parametro verrà ignorato.

**Valore predefinito:** false

Firma:

mutableContent?: boolean;

MessagingOptions.priority

La priorità del messaggio. I valori validi sono "normal" e "high". Su iOS, corrispondono alle priorità 5 e 10 degli APN .

Per impostazione predefinita, i messaggi di notifica vengono inviati con priorità alta mentre i messaggi di dati vengono inviati con priorità normale. La priorità normale ottimizza il consumo della batteria dell'app client e deve essere utilizzata a meno che non sia richiesta la consegna immediata. Per i messaggi con priorità normale, l'app potrebbe ricevere il messaggio con un ritardo non specificato.

Quando un messaggio viene inviato con priorità alta, viene inviato immediatamente e l'app può riattivare un dispositivo inattivo e aprire una connessione di rete al tuo server.

Per ulteriori informazioni, vedere Impostazione della priorità di un messaggio .

**Valore predefinito:** "high" per i messaggi di notifica, "normal" per i messaggi di dati

Firma:

priority?: string;

MessagingOptions.restrictedPackageName

Il nome del pacchetto dell'applicazione a cui devono corrispondere i token di registrazione per ricevere il messaggio.

**Valore predefinito:** Nessuno

Firma:

restrictedPackageName?: string;

MessagingOptions.timeToLive

Per quanto tempo (in secondi) il messaggio deve essere conservato nell'archivio FCM se il dispositivo è offline. Il periodo massimo di supporto è di quattro settimane e anche il valore predefinito è quattro settimane. Per ulteriori informazioni, vedere Impostazione della durata di un messaggio .

**Valore predefinito:** 2419200 (che rappresenta quattro settimane, in secondi)

Firma:

timeToLive?: number;