AndroidNotification interface

Rappresenta le opzioni di notifica specifiche di Android che possono essere incluse in AndroidConfig .

Firma:

export interface AndroidNotification 

Proprietà

AndroidNotification.body

Corpo della notifica Android. Quando fornito, sovrascrive il corpo impostato tramite admin.messaging.Notification .

Firma:

body?: string;

AndroidNotification.bodyLocArgs

Un array di chiavi di risorsa che verrà utilizzato al posto degli identificatori di formato in bodyLocKey .

Firma:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

Chiave della stringa del corpo nella risorsa stringa dell'app da utilizzare per localizzare il corpo del testo.

Firma:

bodyLocKey?: string;

AndroidNotification.channelId

L'ID del canale di notifica Android (nuovo in Android O). L'app deve creare un canale con questo ID canale prima di poter ricevere qualsiasi notifica con questo ID canale. Se non invii questo ID canale nella richiesta o se l'ID canale fornito non è stato ancora creato dall'app, FCM utilizza l'ID canale specificato nel manifest dell'app.

Firma:

channelId?: string;

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

Firma:

clickAction?: string;

AndroidNotification.color

Colore dell'icona di notifica nel formato #rrggbb .

Firma:

color?: string;

AndroidNotification.defaultLightSettings

Se impostato su true , utilizza le impostazioni di luce LED predefinite del framework Android per la notifica. I valori predefiniti sono specificati in config.xml . Se default_light_settings è impostato su true e anche light_settings è impostato, viene utilizzato light_settings specificato dall'utente al posto del valore predefinito.

Firma:

defaultLightSettings?: boolean;

AndroidNotification.defaultSuono

Se impostato su true , utilizza il suono predefinito del framework Android per la notifica. I valori predefiniti sono specificati in config.xml .

Firma:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

Se impostato su true , utilizza il modello di vibrazione predefinito del framework Android per la notifica. I valori predefiniti sono specificati in config.xml . Se default_vibrate_timings è impostato su true e vibrate_timings è impostato, viene utilizzato il valore predefinito al posto del vibrate_timings specificato dall'utente .

Firma:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

Per le notifiche che informano gli utenti sugli eventi con un riferimento temporale assoluto, imposta l'ora in cui si è verificato l'evento nella notifica. Le notifiche nel pannello vengono ordinate in base a questo orario.

Firma:

eventTimestamp?: Date;

AndroidNotification.icon

Risorsa icona per la notifica Android.

Firma:

icon?: string;

AndroidNotification.imageUrl

URL di un'immagine da visualizzare nella notifica.

Firma:

imageUrl?: string;

AndroidNotification.lightSettings

Impostazioni per controllare la frequenza e il colore di lampeggiamento del LED della notifica se il LED è disponibile sul dispositivo. Il tempo totale di lampeggio è controllato dal sistema operativo.

Firma:

lightSettings?: LightSettings;

AndroidNotification.localOnly

Imposta se questa notifica è rilevante o meno solo per il dispositivo corrente. Alcune notifiche possono essere collegate ad altri dispositivi per la visualizzazione remota, come un orologio Wear OS. Questo suggerimento può essere impostato per consigliare di non ignorare questa notifica. Consulta le guide del sistema operativo Wear .

Firma:

localOnly?: boolean;

AndroidNotification.notificationCount

Imposta il numero di elementi rappresentati da questa notifica. Può essere visualizzato come conteggio di badge per i launcher che supportano i badge. Vedi Badge di notifica . Ad esempio, ciò potrebbe essere utile se utilizzi una sola notifica per rappresentare più nuovi messaggi ma desideri che il conteggio qui rappresenti il ​​numero totale di nuovi messaggi. Se zero o non specificato, i sistemi che supportano il badge utilizzano l'impostazione predefinita, ovvero incrementare un numero visualizzato nel menu a pressione prolungata ogni volta che arriva una nuova notifica.

Firma:

notificationCount?: number;

AndroidNotification.priority

Imposta la priorità relativa per questa notifica. Le notifiche a bassa priorità potrebbero essere nascoste all'utente in determinate situazioni. Tieni presente che questa priorità è diversa da AndroidMessagePriority . Questa priorità viene elaborata dal client dopo che il messaggio è stato consegnato. Mentre AndroidMessagePriority è un concetto FCM che controlla quando il messaggio viene consegnato.

Firma:

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

AndroidNotification.sound

Nome del file audio da riprodurre quando il dispositivo riceve la notifica.

Firma:

sound?: string;

AndroidNotification.sticky

Se impostata su false o non impostata, la notifica viene automaticamente ignorata quando l'utente fa clic su di essa nel pannello. Quando impostato su true , la notifica persiste anche quando l'utente fa clic su di essa.

Firma:

sticky?: boolean;

AndroidNotification.tag

Etichetta di notifica. Questo è un identificatore utilizzato per sostituire le notifiche esistenti nel cassetto delle notifiche. Se non specificato, ogni richiesta crea una nuova notifica.

Firma:

tag?: string;

AndroidNotification.ticker

Imposta il testo "ticker", che viene inviato ai servizi di accessibilità. Prima del livello API 21 (Lollipop), imposta il testo visualizzato nella barra di stato quando arriva la notifica per la prima volta.

Firma:

ticker?: string;

AndroidNotification.titolo

Titolo della notifica Android. Quando fornito, sovrascrive il titolo impostato tramite admin.messaging.Notification .

Firma:

title?: string;

AndroidNotification.titleLocArgs

Un array di chiavi di risorsa che verrà utilizzato al posto degli identificatori di formato in titleLocKey .

Firma:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

Chiave della stringa del titolo nella risorsa stringa dell'app da utilizzare per localizzare il testo del titolo.

Firma:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

Imposta il modello di vibrazione da utilizzare. Passano una serie di millisecondi per accendere o spegnere il vibratore. Il primo valore indica il tempo da attendere prima di accendere il vibratore. Il valore successivo indica la durata per mantenere acceso il vibratore. I valori successivi si alternano tra la durata per spegnere il vibratore e per accenderlo. Se vibrate_timings è impostato e default_vibrate_timings è impostato su true , viene utilizzato il valore predefinito al posto del vibrate_timings specificato dall'utente .

Firma:

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

Imposta la visibilità della notifica. Deve essere private , public o secret . Se non specificato, il valore predefinito è private .

Firma:

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