La classe onDisconnect ti consente di scrivere o cancellare dati quando il tuo client si disconnette dal server database. Questi aggiornamenti si verificano indipendentemente dal fatto che il client si disconnetta in modo pulito o meno, quindi puoi fare affidamento su di essi per ripulire i dati anche se una connessione viene interrotta o un client si arresta in modo anomalo.
La classe onDisconnect viene comunemente utilizzata per gestire la presenza nelle applicazioni in cui è utile rilevare quanti client sono connessi e quando altri client si disconnettono. Per ulteriori informazioni, vedere Abilitazione delle funzionalità offline in JavaScript .
Per evitare problemi quando una connessione viene interrotta prima che le richieste possano essere trasferite al server del database, queste funzioni dovrebbero essere richiamate prima di scrivere qualsiasi dato.
Tieni presente che le operazioni onDisconnect vengono attivate solo una volta. Se desideri che un'operazione venga eseguita ogni volta che si verifica una disconnessione, dovrai ristabilire le operazioni onDisconnect ogni volta che ti riconnetti.
Firma:
export declare class OnDisconnect
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| Annulla() | Annulla tutti gli eventi di set o aggiornamento onDisconnect() precedentemente accodati per questa posizione e tutti i figli. Se una scrittura è stata accodata per questa posizione tramite set() o update() in una posizione principale, la scrittura in questa posizione verrà annullata, sebbene le scritture nelle posizioni di pari livello verranno comunque eseguite. | |
| rimuovere() | Garantisce che i dati in questa posizione vengano eliminati quando il client viene disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete). | |
| valore impostato) | Garantisce che i dati in questa posizione siano impostati sul valore specificato quando il client è disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete). set() è particolarmente utile per implementare sistemi di "presenza", in cui un valore deve essere modificato o cancellato quando un utente si disconnette in modo che appaia "offline" agli altri utenti. Per ulteriori informazioni, vedere Abilitazione delle funzionalità offline in JavaScript . Tieni presente che le operazioni onDisconnect vengono attivate solo una volta. Se desideri che un'operazione venga eseguita ogni volta che si verifica una disconnessione, dovrai ristabilire ogni volta le operazioni onDisconnect . | |
| setWithPriority(valore, priorità) | Garantisce che i dati in questa posizione siano impostati sul valore e sulla priorità specificati quando il client viene disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete). | |
| aggiornamento(valori) | Scrive più valori in questa posizione quando il client è disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete). L'argomento values contiene più coppie proprietà-valore che verranno scritte insieme nel database. Ogni proprietà figlio può essere una proprietà semplice (ad esempio, "nome") o un percorso relativo (ad esempio, "nome/nome") dalla posizione corrente ai dati da aggiornare. A differenza del metodo set() , update() può essere utilizzato per aggiornare selettivamente solo le proprietà a cui si fa riferimento nella posizione corrente (invece di sostituire tutte le proprietà figlie nella posizione corrente). |
OnDisconnect.cancel()
Annulla tutti gli eventi di set o aggiornamento onDisconnect() precedentemente accodati per questa posizione e tutti i figli.
Se una scrittura è stata accodata per questa posizione tramite set() o update() in una posizione principale, la scrittura in questa posizione verrà annullata, sebbene le scritture nelle posizioni di pari livello verranno comunque eseguite.
Firma:
cancel(): Promise<void>;
Ritorna:
Promesso<vuoto>
Si risolve quando la sincronizzazione con il server è completa.
OnDisconnect.remove()
Garantisce che i dati in questa posizione vengano eliminati quando il client viene disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete).
Firma:
remove(): Promise<void>;
Ritorna:
Promesso<vuoto>
Si risolve quando la sincronizzazione con il server è completa.
OnDisconnect.set()
Garantisce che i dati in questa posizione siano impostati sul valore specificato quando il client è disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete).
set() è particolarmente utile per implementare sistemi di "presenza", in cui un valore deve essere modificato o cancellato quando un utente si disconnette in modo che appaia "offline" agli altri utenti. Per ulteriori informazioni, vedere Abilitazione delle funzionalità offline in JavaScript .
Tieni presente che le operazioni onDisconnect vengono attivate solo una volta. Se desideri che un'operazione venga eseguita ogni volta che si verifica una disconnessione, dovrai ristabilire ogni volta le operazioni onDisconnect .
Firma:
set(value: unknown): Promise<void>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| valore | sconosciuto | Il valore da scrivere in questa posizione alla disconnessione (può essere un oggetto, un array, una stringa, un numero, un booleano o un null). |
Ritorna:
Promesso<vuoto>
Si risolve quando la sincronizzazione con il database è completa.
OnDisconnect.setWithPriority()
Garantisce che i dati in questa posizione siano impostati sul valore e sulla priorità specificati quando il client viene disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete).
Firma:
setWithPriority(value: unknown, priority: number | string | null): Promise<void>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| valore | sconosciuto | Il valore da scrivere in questa posizione alla disconnessione (può essere un oggetto, un array, una stringa, un numero, un booleano o un null). |
| priorità | numero | stringa | nullo | La priorità da scrivere (stringa, numero o null). |
Ritorna:
Promesso<vuoto>
Si risolve quando la sincronizzazione con il database è completa.
OnDisconnect.update()
Scrive più valori in questa posizione quando il client è disconnesso (a causa della chiusura del browser, della navigazione in una nuova pagina o di problemi di rete).
L'argomento values contiene più coppie proprietà-valore che verranno scritte insieme nel database. Ogni proprietà figlio può essere una proprietà semplice (ad esempio, "nome") o un percorso relativo (ad esempio, "nome/nome") dalla posizione corrente ai dati da aggiornare.
A differenza del metodo set() , update() può essere utilizzato per aggiornare selettivamente solo le proprietà a cui si fa riferimento nella posizione corrente (invece di sostituire tutte le proprietà figlie nella posizione corrente).
Firma:
update(values: object): Promise<void>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| valori | oggetto | Oggetto contenente più valori. |
Ritorna:
Promesso<vuoto>
Si risolve quando la sincronizzazione con il database è completa.