NotificationMessagePayload interface

Interfaccia che rappresenta un payload del messaggio di notifica dell'API legacy FCM. I messaggi di notifica consentono agli sviluppatori di inviare fino a 4 KB di coppie chiave-valore predefinite. Le chiavi accettate sono descritte di seguito.

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

Firma:

export interface NotificationMessagePayload 

Proprietà

NotificationMessagePayload.badge

Il valore del badge sull'icona dell'app nella schermata iniziale.

Se non specificato il badge non viene modificato.

Se impostato su 0 , il badge viene rimosso.

**Piattaforme:** iOS

Firma:

badge?: string;

NotificationMessagePayload.body

Il corpo del testo della notifica.

**Piattaforme:** iOS, Android, Web

Firma:

body?: string;

NotificationMessagePayload.bodyLocArgs

Valori di stringa variabili da utilizzare al posto degli identificatori di formato in body_loc_key da utilizzare per localizzare il corpo del testo nella localizzazione corrente dell'utente.

Il valore deve essere un array JSON stringato.

**iOS:** corrisponde a loc-args nel payload APN. Per ulteriori informazioni, consulta Riferimento alla chiave del payload e Localizzazione del contenuto delle notifiche remote .

**Android:** consulta Formattazione e stile per ulteriori informazioni.

**Piattaforme:** iOS, Android

Firma:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

Chiave della stringa del corpo nelle risorse stringa dell'app da utilizzare per localizzare il corpo del testo nella localizzazione corrente dell'utente.

**iOS:** corrisponde a loc-key nel payload APN. Per ulteriori informazioni, consulta Riferimento alla chiave del payload e Localizzazione del contenuto delle notifiche remote .

**Android:** consulta Risorse sulle stringhe per ulteriori informazioni.

**Piattaforme:** iOS, Android

Firma:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

Azione associata al clic di un utente sulla notifica. Se specificato, viene avviata un'attività con un filtro intento corrispondente quando un utente fa clic sulla notifica.

* **Piattaforme:** Android

Firma:

clickAction?: string;

NotificationMessagePayload.color

Il colore dell'icona di notifica, espresso nel formato #rrggbb .

**Piattaforme:** Android

Firma:

color?: string;

NotificationMessagePayload.icon

L'icona della notifica.

**Android:** imposta l'icona di notifica su myicon per la risorsa disegnabile myicon . Se non invii questa chiave nella richiesta, FCM visualizza l'icona di avvio specificata nel manifest dell'app.

**Web:** l'URL da utilizzare per l'icona della notifica.

**Piattaforme:** Android, Web

Firma:

icon?: string;

NotificationMessagePayload.sound

Il suono da riprodurre quando il dispositivo riceve una notifica. Supporta "predefinito" per il suono di notifica predefinito del dispositivo o il nome file di una risorsa audio inclusa nell'app. I file audio devono risiedere in /res/raw/ .

**Piattaforme:** Android

Firma:

sound?: string;

NotificationMessagePayload.tag

Identificatore utilizzato per sostituire le notifiche esistenti nel cassetto delle notifiche.

Se non specificato, ogni richiesta crea una nuova notifica.

Se specificato ed è già visualizzata una notifica con lo stesso tag, la nuova notifica sostituisce quella esistente nel cassetto delle notifiche.

**Piattaforme:** Android

Firma:

tag?: string;

NotificationMessagePayload.title

Il titolo della notifica.

**Piattaforme:** iOS, Android, Web

Firma:

title?: string;

NotificationMessagePayload.titleLocArgs

Valori di stringa variabili da utilizzare al posto degli identificatori di formato in title_loc_key da utilizzare per localizzare il testo del titolo nella localizzazione corrente dell'utente.

Il valore deve essere un array JSON stringato.

**iOS:** corrisponde a title-loc-args nel payload APN. Per ulteriori informazioni, consulta Riferimento alla chiave del payload e Localizzazione del contenuto delle notifiche remote .

**Android:** consulta Formattazione e stile per ulteriori informazioni.

**Piattaforme:** iOS, Android

Firma:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

Chiave della stringa del titolo nelle risorse stringa dell'app da utilizzare per localizzare il testo del titolo nella localizzazione corrente dell'utente.

**iOS:** corrisponde alla title-loc-key nel payload APN. Per ulteriori informazioni, consulta Riferimento alla chiave del payload e Localizzazione del contenuto delle notifiche remote .

**Android:** consulta Risorse sulle stringhe per ulteriori informazioni.

**Piattaforme:** iOS, Android

Firma:

titleLocKey?: string;