@firebase/messaging

Funzioni

Funzione Descrizione
funzione(app, ...)
getMessaging(app) Recupera un'istanza Firebase Cloud Messaging.
funzione (messaggistica, ...)
deleteToken(messaggistica) Elimina il token di registrazione associato a questa istanza di messaggistica e annulla la sottoscrizione dell'istanza di messaggistica dalla sottoscrizione push.
getToken(messaggistica, opzioni) Sottoscrive l'istanza di messaggistica per inviare notifiche. Restituisce un token di registrazione Firebase Cloud Messaging che può essere utilizzato per inviare messaggi push a tale istanza di Messaging . Se l'autorizzazione alla notifica non è già concessa, questo metodo richiede l'autorizzazione all'utente. La promessa restituita viene rifiutata se l'utente non consente all'app di mostrare le notifiche.
onMessage(messaggistica, nextOrObserver) Quando viene ricevuto un messaggio push e l'utente si trova attualmente su una pagina per la tua origine, il messaggio viene passato alla pagina e viene inviato un evento onMessage() con il payload del messaggio push.
funzione()
è supportato() Controlla se tutte le API richieste esistono nel browser.

Interfacce

Interfaccia Descrizione
Opzioni Fcm Opzioni per le funzionalità fornite da FCM SDK per il Web. Vedere Opzioni WebpushFcm .
OttieniOpzioniToken Opzioni per getToken() .
MessaggioPayload Payload del messaggio che contiene il payload della notifica rappresentato con NotificationPayload e il payload dei dati che contiene un numero arbitrario di coppie chiave-valore inviate dagli sviluppatori tramite l' API di invio .
Messaggistica Interfaccia pubblica dell'SDK Firebase Cloud Messaging.
NotificaPayload Visualizza i dettagli della notifica. I dettagli vengono inviati tramite l' API di invio .

funzione(app, ...)

getMessaging(app)

Recupera un'istanza Firebase Cloud Messaging.

Firma:

export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;

Parametri

Parametro Tipo Descrizione
app FirebaseApp

Ritorna:

Messaggistica

L'istanza Firebase Cloud Messaging associata all'app Firebase fornita.

funzione (messaggistica, ...)

deleteToken(messaggistica)

Elimina il token di registrazione associato a questa istanza di messaggistica e annulla la sottoscrizione dell'istanza di messaggistica dalla sottoscrizione push.

Firma:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Parametri

Parametro Tipo Descrizione
messaggistica Messaggistica L'istanza di messaggistica .

Ritorna:

Promesso<booleano>

La promessa si risolve quando il token è stato eliminato con successo.

getToken(messaggistica, opzioni)

Sottoscrive l'istanza di messaggistica per inviare notifiche. Restituisce un token di registrazione Firebase Cloud Messaging che può essere utilizzato per inviare messaggi push a tale istanza di Messaging .

Se l'autorizzazione alla notifica non è già concessa, questo metodo richiede l'autorizzazione all'utente. La promessa restituita viene rifiutata se l'utente non consente all'app di mostrare le notifiche.

Firma:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Parametri

Parametro Tipo Descrizione
messaggistica Messaggistica L'istanza di messaggistica .
opzioni OttieniOpzioniToken Fornisce una chiave vapid facoltativa e una registrazione facoltativa del lavoratore del servizio.

Ritorna:

Promesso<string>

La promessa si risolve con un token di registrazione FCM.

onMessage(messaggistica, nextOrObserver)

Quando viene ricevuto un messaggio push e l'utente si trova attualmente su una pagina per la tua origine, il messaggio viene passato alla pagina e viene inviato un evento onMessage() con il payload del messaggio push.

Firma:

export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Parametri

Parametro Tipo Descrizione
messaggistica Messaggistica L'istanza di messaggistica .
nextOrObserver SuccessivoFn < MessaggioPayload > | Osservatore < MessaggioPayload > Questa funzione, o oggetto osservatore con next definizione, viene chiamata quando viene ricevuto un messaggio e l'utente sta attualmente visualizzando la tua pagina.

Ritorna:

Annulla l'iscrizione

Per interrompere l'ascolto dei messaggi, eseguire questa funzione restituita.

funzione()

è supportato()

Controlla se tutte le API richieste esistono nel browser.

Firma:

export declare function isWindowSupported(): Promise<boolean>;

Ritorna:

Promesso<booleano>

una Promessa che si risolve in un valore booleano.