database package

Database in tempo reale Firebase

Funzioni

Funzione	Descrizione
funzione(app, ...)
getDatabase(app, URL)	Restituisce l'istanza dell'SDK di Realtime Database associato alla FirebaseApp fornita . Inizializza una nuova istanza con le impostazioni predefinite se non esiste alcuna istanza o se l'istanza esistente utilizza un URL di database personalizzato.
funzione(db, ...)
connectDatabaseEmulator(db, host, porta, opzioni)	Modificare l'istanza fornita per comunicare con l'emulatore Realtime Database. Nota: questo metodo deve essere chiamato prima di eseguire qualsiasi altra operazione.
vai offline(db)	Si disconnette dal server (tutte le operazioni del database verranno completate offline). Il client mantiene automaticamente una connessione persistente al server database, che rimarrà attivo indefinitamente e si ricollegherà quando disconnesso. Tuttavia, i metodi goOffline() e goOnline() possono essere utilizzati per controllare la connessione del client nei casi in cui una connessione persistente non è auspicabile. Mentre è offline, il client non riceverà più gli aggiornamenti dei dati dal database. Tuttavia, tutte le operazioni del database eseguite localmente continueranno a generare immediatamente eventi, consentendo all'applicazione di continuare a comportarsi normalmente. Inoltre, ogni operazione eseguita localmente verrà automaticamente accodata e ritentata alla riconnessione al server database. Per riconnettersi al database e iniziare a ricevere eventi remoti, vedere goOnline() .
vai online(db)	Si riconnette al server e sincronizza lo stato del database offline con lo stato del server. Questo metodo dovrebbe essere utilizzato dopo aver disabilitato la connessione attiva con goOffline() . Una volta ricollegato, il client trasmetterà i dati corretti e attiverà gli eventi appropriati in modo che il client "regga" automaticamente.
rif(db, percorso)	Restituisce un Reference che rappresenta la posizione nel database corrispondente al percorso fornito. Se non viene fornito alcun percorso, il Reference punterà alla radice del database.
refFromURL(db, url)	Restituisce un Reference che rappresenta la posizione nel database corrispondente all'URL Firebase fornito. Viene generata un'eccezione se l'URL non è un URL del database Firebase valido o ha un dominio diverso rispetto all'istanza Database corrente. Tieni presente che tutti i parametri di query ( orderBy , limitToLast e così via) vengono ignorati e non vengono applicati al Reference restituito.
funzione()
forceLongPolling()	Forza l'uso di longPolling invece di websocket. Questo verrà ignorato se nel databaseURL viene utilizzato il protocollo websocket.
forzaWebSocket()	Forza l'uso dei websocket invece del longPolling.
ordinePerChiave()	Crea un nuovo QueryConstraint che ordina in base alla chiave. Ordina i risultati di una query in base ai valori chiave (ascendenti). Puoi leggere ulteriori informazioni su orderByKey() in Ordinamento dei dati .
ordinePerPriorità()	Crea un nuovo QueryConstraint che ordina in base alla priorità. Le applicazioni non devono necessariamente utilizzare la priorità ma possono ordinare le raccolte in base alle proprietà ordinarie (vedere Ordinare i dati per alternative alla priorità.
ordinePerValore()	Crea un nuovo QueryConstraint che ordina in base al valore. Se i figli di una query sono tutti valori scalari (stringa, numero o booleano), è possibile ordinare i risultati in base ai relativi valori (ascendenti). Puoi leggere ulteriori informazioni su orderByValue() in Ordinamento dei dati .
serverTimestamp()	Restituisce un valore segnaposto per il popolamento automatico del timestamp corrente (tempo dall'epoca di Unix, in millisecondi) come determinato dai server Firebase.
funzione(delta, ...)
incremento(delta)	Restituisce un valore segnaposto che può essere utilizzato per incrementare atomicamente il valore del database corrente in base al delta fornito.
funzione (abilitata, ...)
abilitaLogging(abilitato, persistente)	Registra le informazioni di debug nella console.
funzione(limite, ...)
limitealprimo(limite)	Crea un nuovo QueryConstraint limitato al primo numero specifico di figli. Il metodo limitToFirst() viene utilizzato per impostare un numero massimo di figli da sincronizzare per un determinato callback. Se impostiamo un limite di 100, inizialmente riceveremo solo fino a 100 eventi child_added . Se abbiamo meno di 100 messaggi archiviati nel nostro database, verrà attivato un evento child_added per ciascun messaggio. Tuttavia, se abbiamo più di 100 messaggi, riceveremo solo un evento child_added per i primi 100 messaggi ordinati. Man mano che gli elementi cambiano, riceveremo eventi child_removed per ogni elemento che esce dall'elenco attivo in modo che il numero totale rimanga a 100. Puoi leggere ulteriori informazioni su limitToFirst() in Filtraggio dei dati .
limite all'ultimo(limite)	Crea un nuovo QueryConstraint limitato a restituire solo l'ultimo numero specificato di figli. Il metodo limitToLast() viene utilizzato per impostare un numero massimo di figli da sincronizzare per un determinato callback. Se impostiamo un limite di 100, inizialmente riceveremo solo fino a 100 eventi child_added . Se abbiamo meno di 100 messaggi archiviati nel nostro database, verrà attivato un evento child_added per ciascun messaggio. Tuttavia, se abbiamo più di 100 messaggi, riceveremo solo un evento child_added per gli ultimi 100 messaggi ordinati. Man mano che gli elementi cambiano, riceveremo eventi child_removed per ogni elemento che esce dall'elenco attivo in modo che il numero totale rimanga a 100. Puoi leggere ulteriori informazioni su limitToLast() in Filtraggio dei dati .
funzione(logger, ...)
abilitaLogging(logger)	Registra le informazioni di debug nella console.
funzione(genitore, ...)
figlio(genitore, percorso)	Ottiene un Reference per la posizione nel percorso relativo specificato. Il percorso relativo può essere un semplice nome figlio (ad esempio, "ada") o un percorso più profondo separato da barre (ad esempio, "ada/nome/primo").
push(genitore, valore)	Genera una nuova posizione figlio utilizzando una chiave univoca e restituisce il relativo Reference . Questo è il modello più comune per aggiungere dati a una raccolta di elementi. Se fornisci un valore a push() , il valore viene scritto nella posizione generata. Se non passi un valore, non viene scritto nulla nel database e il figlio rimane vuoto (ma puoi utilizzare il Reference altrove). Le chiavi univoche generate da push() sono ordinate in base all'ora corrente, quindi l'elenco di elementi risultante è ordinato cronologicamente. Le chiavi sono inoltre progettate per essere impercettibili (contengono 72 bit casuali di entropia). Vedere Aggiungere a un elenco di dati . Vedi I 2^120 modi per garantire identificatori univoci .
funzione(percorso, ...)
ordinePerChild(percorso)	Crea un nuovo QueryConstraint che ordina in base alla chiave figlio specificata. Le query possono essere ordinate solo per una chiave alla volta. Chiamare orderByChild() più volte sulla stessa query è un errore. Le query Firebase ti consentono di ordinare al volo i tuoi dati in base a qualsiasi chiave figlio. Tuttavia, se sai in anticipo quali saranno i tuoi indici, puoi definirli tramite la regola .indexOn nelle tue Regole di sicurezza per prestazioni migliori. Consulta la regola https://firebase.google.com/docs/database/security/indexing-data per ulteriori informazioni. Puoi leggere ulteriori informazioni su orderByChild() in Ordinamento dei dati .
funzione(query, ...)
ottenere (interrogare)	Ottiene il risultato più aggiornato per questa query.
off(query, eventType, callback)	Scollega una richiamata precedentemente collegata al corrispondente ascoltatore on () ( onValue , onChildAdded ). Nota: questo non è il metodo consigliato per rimuovere un ascoltatore. Utilizzare invece la funzione di callback restituita dai on callback. Scollega un callback precedentemente collegato con on*() . Chiamare off() su un ascoltatore genitore non rimuoverà automaticamente gli ascoltatori registrati sui nodi figli, off() deve essere chiamato anche su qualsiasi ascoltatore figlio per rimuovere la richiamata. Se non viene specificato un callback, tutti i callback per l'eventType specificato verranno rimossi. Allo stesso modo, se non viene specificato alcun eventType, tutti i callback per il Reference verranno rimossi. I singoli ascoltatori possono anche essere rimossi invocando i loro callback di annullamento dell'iscrizione.
onChildAdded(query, callback, cancelCallback)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildAdded verrà attivato una volta per ogni figlio iniziale in questa posizione e verrà attivato nuovamente ogni volta che viene aggiunto un nuovo figlio. Il DataSnapshot passato alla richiamata rifletterà i dati per il figlio in questione. A scopo di ordinamento, viene passato un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildAdded(query, callback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildAdded verrà attivato una volta per ogni figlio iniziale in questa posizione e verrà attivato nuovamente ogni volta che viene aggiunto un nuovo figlio. Il DataSnapshot passato alla richiamata rifletterà i dati per il figlio in questione. A scopo di ordinamento, viene passato un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildAdded(query, callback, cancelCallback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildAdded verrà attivato una volta per ogni figlio iniziale in questa posizione e verrà attivato nuovamente ogni volta che viene aggiunto un nuovo figlio. Il DataSnapshot passato alla richiamata rifletterà i dati per il figlio in questione. A scopo di ordinamento, viene passato un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildChanged(query, callback, cancelCallback)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildChanged verrà attivato quando i dati archiviati in un figlio (o in uno qualsiasi dei suoi discendenti) cambiano. Tieni presente che un singolo evento child_changed può rappresentare più modifiche al figlio. Il DataSnapshot passato al callback conterrà i nuovi contenuti secondari. Ai fini dell'ordinamento, al callback viene passato anche un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildChanged(query, callback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildChanged verrà attivato quando i dati archiviati in un figlio (o in uno qualsiasi dei suoi discendenti) cambiano. Tieni presente che un singolo evento child_changed può rappresentare più modifiche al figlio. Il DataSnapshot passato al callback conterrà i nuovi contenuti secondari. Ai fini dell'ordinamento, al callback viene passato anche un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildChanged(query, callback, cancelCallback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildChanged verrà attivato quando i dati archiviati in un figlio (o in uno qualsiasi dei suoi discendenti) cambiano. Tieni presente che un singolo evento child_changed può rappresentare più modifiche al figlio. Il DataSnapshot passato al callback conterrà i nuovi contenuti secondari. Ai fini dell'ordinamento, al callback viene passato anche un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildMoved(query, callback, cancelCallback)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildMoved verrà attivato quando l'ordinamento di un bambino cambia in modo tale da cambiare la sua posizione rispetto ai suoi fratelli. Il DataSnapshot passato alla richiamata riguarderà i dati del bambino che si è spostato. Viene anche passato un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildMoved(query, callback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildMoved verrà attivato quando l'ordinamento di un bambino cambia in modo tale da cambiare la sua posizione rispetto ai suoi fratelli. Il DataSnapshot passato alla richiamata riguarderà i dati del bambino che si è spostato. Viene anche passato un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildMoved(query, callback, cancelCallback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildMoved verrà attivato quando l'ordinamento di un bambino cambia in modo tale da cambiare la sua posizione rispetto ai suoi fratelli. Il DataSnapshot passato alla richiamata riguarderà i dati del bambino che si è spostato. Viene anche passato un secondo argomento che è una stringa contenente la chiave del figlio fratello precedente in base all'ordinamento, o null se è il primo figlio.
onChildRemoved(query, callback, cancelCallback)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildRemoved verrà attivato ogni volta che un bambino viene rimosso. Il DataSnapshot passato alla richiamata saranno i vecchi dati per il bambino che è stato rimosso. Un bambino verrà rimosso quando: - un client chiama esplicitamente remove() su quel bambino o uno dei suoi antenati - un client chiama set(null) su quel bambino o uno dei suoi antenati - a quel bambino sono stati rimossi tutti i suoi figli - c'è una query in vigore che ora filtra il bambino (perché è stato modificato l'ordinamento o è stato raggiunto il limite massimo)
onChildRemoved(query, callback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildRemoved verrà attivato ogni volta che un bambino viene rimosso. Il DataSnapshot passato alla richiamata saranno i vecchi dati per il bambino che è stato rimosso. Un bambino verrà rimosso quando: - un client chiama esplicitamente remove() su quel bambino o uno dei suoi antenati - un client chiama set(null) su quel bambino o uno dei suoi antenati - a quel bambino sono stati rimossi tutti i suoi figli - c'è una query in vigore che ora filtra il bambino (perché è stato modificato l'ordinamento o è stato raggiunto il limite massimo)
onChildRemoved(query, callback, cancelCallback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onChildRemoved verrà attivato ogni volta che un bambino viene rimosso. Il DataSnapshot passato alla richiamata saranno i vecchi dati per il bambino che è stato rimosso. Un bambino verrà rimosso quando: - un client chiama esplicitamente remove() su quel bambino o uno dei suoi antenati - un client chiama set(null) su quel bambino o uno dei suoi antenati - a quel bambino sono stati rimossi tutti i suoi figli - c'è una query in vigore che ora filtra il bambino (perché è stato modificato l'ordinamento o è stato raggiunto il limite massimo)
onValue(query, callback, cancelCallback)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onValue verrà attivato una volta con i dati iniziali archiviati in questa posizione, quindi verrà attivato nuovamente ogni volta che i dati cambiano. Il DataSnapshot passato al callback sarà per la posizione in cui è stato chiamato on() . Non si attiverà finché l'intero contenuto non sarà stato sincronizzato. Se la posizione non ha dati, verrà attivata con un DataSnapshot vuoto ( val() restituirà null ).
onValue(query, callback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onValue verrà attivato una volta con i dati iniziali archiviati in questa posizione, quindi verrà attivato nuovamente ogni volta che i dati cambiano. Il DataSnapshot passato al callback sarà per la posizione in cui è stato chiamato on() . Non si attiverà finché l'intero contenuto non sarà stato sincronizzato. Se la posizione non ha dati, verrà attivata con un DataSnapshot vuoto ( val() restituirà null ).
onValue(query, callback, cancelCallback, opzioni)	Ascolta le modifiche ai dati in una posizione particolare. Questo è il modo principale per leggere i dati da un database. La richiamata verrà attivata per i dati iniziali e nuovamente ogni volta che i dati cambiano. Richiama la richiamata di annullamento dell'iscrizione restituita per interrompere la ricezione degli aggiornamenti. Per ulteriori dettagli vedere Recuperare dati sul Web . Un evento onValue verrà attivato una volta con i dati iniziali archiviati in questa posizione, quindi verrà attivato nuovamente ogni volta che i dati cambiano. Il DataSnapshot passato al callback sarà per la posizione in cui è stato chiamato on() . Non si attiverà finché l'intero contenuto non sarà stato sincronizzato. Se la posizione non ha dati, verrà attivata con un DataSnapshot vuoto ( val() restituirà null ).
query(query, queryVincoli)	Crea una nuova istanza immutabile di Query che viene estesa per includere anche vincoli di query aggiuntivi.
funzione(rif, ...)
onDisconnect(rif)	Restituisce un oggetto OnDisconnect : vedere Abilitazione delle funzionalità offline in JavaScript per ulteriori informazioni su come utilizzarlo.
rimuovi (rif)	Rimuove i dati in questa posizione del database. Verranno eliminati anche tutti i dati presenti nelle sedi secondarie. L'effetto della rimozione sarà immediatamente visibile e verrà attivato il "valore" dell'evento corrispondente. Verrà avviata anche la sincronizzazione della rimozione sui server Firebase e la promessa restituita verrà risolta una volta completata. Se fornito, il callback onComplete verrà chiamato in modo asincrono al termine della sincronizzazione.
runTransaction(rif, TransactionUpdate, opzioni)	Modifica atomicamente i dati in questa posizione. Modifica atomicamente i dati in questa posizione. A differenza di un normale set() , che sovrascrive semplicemente i dati indipendentemente dal loro valore precedente, runTransaction() viene utilizzato per modificare il valore esistente in un nuovo valore, garantendo che non ci siano conflitti con altri client che scrivono nella stessa posizione allo stesso tempo . Per ottenere ciò, passi runTransaction() una funzione di aggiornamento che viene utilizzata per trasformare il valore corrente in un nuovo valore. Se un altro client scrive nella posizione prima che il nuovo valore venga scritto con successo, la funzione di aggiornamento verrà richiamata nuovamente con il nuovo valore corrente e la scrittura verrà ritentata. Ciò accadrà ripetutamente finché la tua scrittura non avrà successo senza conflitti o finché non interrompi la transazione non restituendo un valore dalla funzione di aggiornamento. Nota: la modifica dei dati con set() annullerà tutte le transazioni in sospeso in quella posizione, quindi è necessario prestare la massima attenzione se si combinano set() e runTransaction() per aggiornare gli stessi dati. Nota: quando si utilizzano transazioni con regole di sicurezza e Firebase attive, tenere presente che un client necessita dell'accesso .read oltre all'accesso .write per eseguire una transazione. Questo perché la natura delle transazioni lato client richiede che il client legga i dati per aggiornarli a livello transazionale.
set(rif, valore)	Scrive i dati in questa posizione del database. Ciò sovrascriverà tutti i dati in questa posizione e in tutte le posizioni secondarie. L'effetto della scrittura sarà immediatamente visibile e verranno attivati ​​gli eventi corrispondenti ("valore", "child_added", ecc.). Verrà avviata anche la sincronizzazione dei dati sui server Firebase e la promessa restituita verrà risolta una volta completata. Se fornito, il callback onComplete verrà chiamato in modo asincrono al termine della sincronizzazione. Passare null per il nuovo valore equivale a chiamare remove() ; vale a dire, tutti i dati in questa posizione e tutte le posizioni secondarie verranno eliminati. set() rimuoverà qualsiasi priorità memorizzata in questa posizione, quindi se si intende preservare la priorità, è necessario utilizzare invece setWithPriority() . Tieni presente che la modifica dei dati con set() annullerà qualsiasi transazione in sospeso in quella posizione, quindi è necessario prestare estrema attenzione se si combinano set() e transaction() per modificare gli stessi dati. Un singolo set() genererà un singolo evento "valore" nella posizione in cui è stato eseguito set() .
setPriority(rif, priorità)	Imposta una priorità per i dati in questa posizione del database. Le applicazioni non devono necessariamente utilizzare la priorità ma possono ordinare le raccolte in base alle proprietà ordinarie (vedere Ordinamento e filtraggio dei dati ).
setWithPriority(rif, valore, priorità)	Scrive i dati nella posizione del database. Come set() ma specifica anche la priorità per quei dati. Le applicazioni non devono necessariamente utilizzare la priorità ma possono ordinare le raccolte in base alle proprietà ordinarie (vedere Ordinamento e filtraggio dei dati ).
aggiornamento(rif, valori)	Scrive più valori contemporaneamente nel database. 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). L'effetto della scrittura sarà immediatamente visibile e verranno attivati ​​gli eventi corrispondenti ('value', 'child_added', ecc.). Verrà avviata anche la sincronizzazione dei dati sui server Firebase e la promessa restituita verrà risolta una volta completata. Se fornito, il callback onComplete verrà chiamato in modo asincrono al termine della sincronizzazione. Un singolo update() genererà un singolo evento "valore" nella posizione in cui è stato eseguito update() , indipendentemente da quanti figli sono stati modificati. Tieni presente che la modifica dei dati con update() annullerà tutte le transazioni in sospeso in quella posizione, quindi è necessario prestare estrema attenzione se si combinano update() e transaction() per modificare gli stessi dati. Passando null a update() verranno rimossi i dati in questa posizione. Vedi Presentazione degli aggiornamenti multi-località e altro ancora .
funzione(valore, ...)
endAt(valore, chiave)	Crea un QueryConstraint con il punto finale specificato. Utilizzando startAt() , startAfter() , endBefore() , endAt() e equalTo() ti consente di scegliere punti iniziali e finali arbitrari per le tue query. Il punto finale è inclusivo, quindi i figli con esattamente il valore specificato verranno inclusi nella query. L'argomento chiave facoltativo può essere utilizzato per limitare ulteriormente l'intervallo della query. Se è specificato, i figli che hanno esattamente il valore specificato devono avere anche un nome di chiave minore o uguale alla chiave specificata. Puoi leggere ulteriori informazioni su endAt() in Filtraggio dei dati .
endBefore(valore, chiave)	Crea un QueryConstraint con il punto finale specificato (esclusivo). Utilizzando startAt() , startAfter() , endBefore() , endAt() e equalTo() ti consente di scegliere punti iniziali e finali arbitrari per le tue query. Il punto finale è esclusivo. Se viene fornito solo un valore, nella query verranno inclusi i figli con un valore inferiore al valore specificato. Se viene specificata una chiave, i figli devono avere un valore inferiore o uguale al valore specificato e un nome chiave inferiore alla chiave specificata.
uguale a(valore, chiave)	Crea un QueryConstraint che include elementi secondari che corrispondono al valore specificato. Utilizzando startAt() , startAfter() , endBefore() , endAt() e equalTo() ti consente di scegliere punti iniziali e finali arbitrari per le tue query. L'argomento chiave facoltativo può essere utilizzato per limitare ulteriormente l'intervallo della query. Se è specificato, i figli che hanno esattamente il valore specificato devono avere anche esattamente la chiave specificata come nome della chiave. Questo può essere utilizzato per filtrare i set di risultati con molte corrispondenze per lo stesso valore. Puoi leggere ulteriori informazioni su equalTo() in Filtraggio dei dati .
startAfter(valore, chiave)	Crea un QueryConstraint con il punto iniziale specificato (esclusivo). Utilizzando startAt() , startAfter() , endBefore() , endAt() e equalTo() ti consente di scegliere punti iniziali e finali arbitrari per le tue query. Il punto di partenza è esclusivo. Se viene fornito solo un valore, nella query verranno inclusi i figli con un valore maggiore del valore specificato. Se viene specificata una chiave, i figli devono avere un valore maggiore o uguale al valore specificato e un nome chiave maggiore della chiave specificata.
startAt(valore, chiave)	Crea un QueryConstraint con il punto iniziale specificato. Utilizzando startAt() , startAfter() , endBefore() , endAt() e equalTo() ti consente di scegliere punti iniziali e finali arbitrari per le tue query. Il punto iniziale è inclusivo, quindi i figli con esattamente il valore specificato verranno inclusi nella query. L'argomento chiave facoltativo può essere utilizzato per limitare ulteriormente l'intervallo della query. Se è specificato, i figli che hanno esattamente il valore specificato devono avere anche un nome di chiave maggiore o uguale alla chiave specificata. Puoi leggere ulteriori informazioni su startAt() in Filtraggio dei dati .

Classi

Classe	Descrizione
Banca dati	Classe che rappresenta un database Firebase Realtime.
DataSnapshot	Un DataSnapshot contiene dati da una posizione del database. Ogni volta che leggi i dati dal database, ricevi i dati come DataSnapshot . Un DataSnapshot viene passato ai callback degli eventi collegati con on() o once() . Puoi estrarre il contenuto dello snapshot come oggetto JavaScript chiamando il metodo val() . In alternativa, puoi entrare nell'istantanea chiamando child() per restituire istantanee figlie (su cui potresti quindi chiamare val() ). Un DataSnapshot è una copia immutabile e generata in modo efficiente dei dati in una posizione del database. Non può essere modificato e non cambierà mai (per modificare i dati, chiami sempre direttamente il metodo set() su un Reference ).
OnDisconnect	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.
Vincolo di query	Un QueryConstraint viene utilizzato per restringere l'insieme di documenti restituiti da una query del database. I QueryConstraint vengono creati invocando endAt() , finePrima() , iniziare a() , startAfter() , limitealprimo() , limite all'ultimo() , ordinePerBambino() , ordinePerBambino() , orderByKey() , orderByPriority() , orderByValue() o equalTo() e può quindi essere passato a query() per creare una nuova istanza di query che contenga anche questo QueryConstraint .
Risultato della transazione	Un tipo per il valore di risoluzione di runTransaction() .

Interfacce

Interfaccia	Descrizione
Riferimento al database	Un DatabaseReference rappresenta una posizione specifica nel database e può essere utilizzato per leggere o scrivere dati in quella posizione del database. Puoi fare riferimento alla posizione root o child nel tuo database chiamando ref() o ref("child/path") . La scrittura viene eseguita con il metodo set() e la lettura può essere eseguita con il metodo on*() . Vedi https://firebase.google.com/docs/database/web/read-and-write
IteratedDataSnapshot	Rappresenta uno snapshot figlio di un Reference su cui viene eseguita l'iterazione. La chiave non sarà mai indefinita.
AscoltaOpzioni	Un oggetto opzioni che può essere utilizzato per personalizzare un ascoltatore.
Domanda	Una Query ordina e filtra i dati in una posizione del database in modo che venga incluso solo un sottoinsieme dei dati figlio. Questo può essere utilizzato per ordinare una raccolta di dati in base ad alcuni attributi (ad esempio, l'altezza dei dinosauri) nonché per limitare un ampio elenco di elementi (ad esempio, messaggi di chat) a un numero adatto per la sincronizzazione con il client. Le query vengono create concatenando uno o più metodi di filtro definiti qui. Proprio come con un DatabaseReference , puoi ricevere dati da una Query utilizzando i metodi on*() . Riceverai solo eventi e DataSnapshot per il sottoinsieme di dati che corrisponde alla tua query. Vedi https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data per ulteriori informazioni.
PoiableReference	Una Promise che può anche fungere da DatabaseReference quando restituita da push() . Il riferimento è immediatamente disponibile e la Promise si risolve non appena viene completata la scrittura nel backend.
Opzioni di transazione	Un oggetto opzioni per configurare le transazioni.

Digitare Alias

Digita Alias	Descrizione
Tipo di evento	Una delle seguenti stringhe: "value", "child_added", "child_changed", "child_removed" o "child_moved".
TipoConstraintQuery	Descrive i diversi vincoli di query disponibili in questo SDK.
Annulla l'iscrizione	Una richiamata che può essere invocata per rimuovere un ascoltatore.

funzione(app, ...)

GetDatabase (app, URL)

Restituisce l'istanza dell'SDK del database in tempo reale associato al FireBasepp fornito . Inizializza una nuova istanza con le impostazioni predefinite se non esiste un'istanza o se l'istanza esistente utilizza un URL di database personalizzato.

Firma:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

Parametri

Parametro	Tipo	Descrizione
app	FireBasepp	L'istanza FireBasepp a cui è associata l'istanza del database in tempo reale restituito.
URL	corda	L'URL dell'istanza del database in tempo reale a cui connettersi. Se non fornito, l'SDK si collega all'istanza predefinita dell'app Firebase.

Ritorna:

Banca dati

L'istanza Database dell'app fornita.

funzione (db, ...)

ConnectDatabaseEmulator (db, host, porta, opzioni)

Modifica l'istanza fornita per comunicare con l'emulatore del database in tempo reale.

Nota: questo metodo deve essere chiamato prima di eseguire qualsiasi altra operazione.

Firma:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parametri

Parametro	Tipo	Descrizione
db	Banca dati	L'istanza da modificare.
ospite	corda	The Emulator Host (Ex: LocalHost)
porta	numero	La porta Emulator (Ex: 8080)
opzioni	{MockUserToken?: EmulatormockTokenOptions | corda; }

Ritorna:

vuoto

Gooffline (DB)

Scollegare dal server (tutte le operazioni di database saranno completate offline).

Il client mantiene automaticamente una connessione persistente al server di database, che rimarrà attivo indefinitamente e si riconnetterà quando si è disconnesso. Tuttavia, i metodi goOffline() e goOnline() possono essere utilizzati per controllare la connessione client nei casi in cui una connessione persistente è indesiderabile.

Sebbene offline, il client non riceverà più aggiornamenti di dati dal database. Tuttavia, tutte le operazioni di database eseguite localmente continueranno a attivare immediatamente eventi, consentendo all'applicazione di continuare a comportarsi normalmente. Inoltre, ciascuna operazione eseguita localmente verrà automaticamente cotta e ritenuta al momento della riconnessione al server di database.

Per riconnettersi al database e iniziare a ricevere eventi remoti, vedi goOnline() .

Firma:

export declare function goOffline(db: Database): void;

Parametri

Parametro	Tipo	Descrizione
db	Banca dati	L'istanza da disconnettersi.

Ritorna:

vuoto

Goonline (DB)

Si riconnette al server e sincronizza lo stato del database offline con lo stato del server.

Questo metodo dovrebbe essere utilizzato dopo aver disabilitato la connessione attiva con goOffline() . Una volta riconnesso, il client trasmetterà i dati adeguati e accenderà gli eventi appropriati in modo che il cliente "raggiunga" automaticamente.

Firma:

export declare function goOnline(db: Database): void;

Parametri

Parametro	Tipo	Descrizione
db	Banca dati	L'istanza da riconnettersi.

Ritorna:

vuoto

Rif (db, percorso)

Restituisce un Reference che rappresenta la posizione nel database corrispondente al percorso fornito. Se non viene fornito alcun percorso, il Reference indicherà la radice del database.

Firma:

export declare function ref(db: Database, path?: string): DatabaseReference;

Parametri

Parametro	Tipo	Descrizione
db	Banca dati	L'istanza del database per ottenere un riferimento per.
sentiero	corda	Percorso opzionale che rappresenta la posizione in cui il Reference restituito punterà. Se non previsto, il Reference restituito indicherà la radice del database.

Ritorna:

Databasereference

Se viene fornito un percorso, un Reference che punta al percorso fornito. Altrimenti, un Reference che punta alla radice del database.

Reffromurl (db, URL)

Restituisce un Reference che rappresenta la posizione nel database corrispondente all'URL Firebase fornito.

Viene lanciata un'eccezione se l'URL non è un URL del database Firebase valido o ha un dominio diverso rispetto all'istanza Database corrente.

Si noti che tutti i parametri di query ( orderBy , limitToLast , ecc.) vengono ignorati e non vengono applicati al Reference restituito .

Firma:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

Parametri

Parametro	Tipo	Descrizione
db	Banca dati	L'istanza del database per ottenere un riferimento per.
URL	corda	L'URL di Firebase in cui indicherà il Reference restituito.

Ritorna:

Databasereference

Un Reference che punta all'URL Firebase fornito.

funzione()

forcelongpolling ()

Forzare l'uso di longpolling anziché websocket. Questo verrà ignorato se il protocollo WebSocket viene utilizzato in DatabaseUrl.

Firma:

export declare function forceLongPolling(): void;

Ritorna:

vuoto

ForceWebSockets ()

Forzare l'uso di websocket invece di longpolling.

Firma:

export declare function forceWebSockets(): void;

Ritorna:

vuoto

orderBykey ()

Crea un nuovo QueryConstraint che ordina per chiave.

Ordina i risultati di una query per i loro valori chiave (ascendenti).

Puoi leggere di più su orderByKey() nei dati di ordinamento .

Firma:

export declare function orderByKey(): QueryConstraint;

Ritorna:

Queryconstraint

orderByPriority ()

Crea un nuovo QueryConstraint che ordina per priorità.

Le applicazioni non devono utilizzare la priorità ma possono ordinare raccolte per proprietà ordinarie (vedere i dati di ordinamento per le alternative alla priorità.

Firma:

export declare function orderByPriority(): QueryConstraint;

Ritorna:

Queryconstraint

orderByValue ()

Crea un nuovo QueryConstraint che ordina per valore.

Se i bambini di una query sono tutti valori scalari (stringa, numero o booleano), è possibile ordinare i risultati per i loro valori (ascendenti).

Puoi leggere di più su orderByValue() nei dati di ordinamento .

Firma:

export declare function orderByValue(): QueryConstraint;

Ritorna:

Queryconstraint

servertimestamp ()

Restituisce un valore segnaposto per l'auto-popolazione del timestamp attuale (tempo dall'epoca UNIX, in millisecondi) come determinato dai server Firebase.

Firma:

export declare function serverTimestamp(): object;

Ritorna:

oggetto

funzione (delta, ...)

incremento (delta)

Restituisce un valore di segnaposto che può essere utilizzato per incrementare atomicamente il valore del database corrente da parte del Delta fornito.

Firma:

export declare function increment(delta: number): object;

Parametri

Parametro	Tipo	Descrizione
delta	numero	l'importo per modificare atomicamente il valore corrente.

Ritorna:

oggetto

Un valore di segnaposto per la modifica dei dati sul lato server atomico.

funzione (abilitata, ...)

EnableLogging (abilitato, persistente)

Registri le informazioni di debug alla console.

Firma:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

Parametri

Parametro	Tipo	Descrizione
abilitato	booleano	Abilita la registrazione se true , disabilita la registrazione se false .
persistente	booleano	Ricorda lo stato di registrazione tra la pagina aggiorna se true .

Ritorna:

Qualunque

funzione (limite, ...)

LimittoFirst (limite)

Crea un nuovo QueryConstraint che se limitato al primo numero specifico di bambini.

Il metodo limitToFirst() viene utilizzato per impostare un numero massimo di bambini da sincronizzare per un determinato callback. Se fissiamo un limite di 100, inizialmente riceveremo solo fino a 100 eventi child_added . Se abbiamo meno di 100 messaggi archiviati nel nostro database, un evento child_added ti farà fuoco per ogni messaggio. Tuttavia, se abbiamo oltre 100 messaggi, riceveremo solo un evento child_added per i primi 100 messaggi ordinati. Man mano che gli articoli cambiano, riceveremo eventi child_removed per ciascun articolo che scende dall'elenco attivo in modo che il numero totale rimanga a 100.

Puoi leggere di più su limitToFirst() nei dati di filtraggio .

Firma:

export declare function limitToFirst(limit: number): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
limite	numero	Il numero massimo di nodi da includere in questa query.

Ritorna:

Queryconstraint

Limittolast (limite)

Crea un nuovo QueryConstraint che è limitato a restituire solo l'ultimo numero specificato di bambini.

Il metodo limitToLast() viene utilizzato per impostare un numero massimo di bambini da sincronizzare per un determinato callback. Se fissiamo un limite di 100, inizialmente riceveremo solo fino a 100 eventi child_added . Se abbiamo meno di 100 messaggi archiviati nel nostro database, un evento child_added ti farà fuoco per ogni messaggio. Tuttavia, se abbiamo oltre 100 messaggi, riceveremo solo un evento child_added per gli ultimi 100 messaggi ordinati. Man mano che gli articoli cambiano, riceveremo eventi child_removed per ciascun articolo che scende dall'elenco attivo in modo che il numero totale rimanga a 100.

Puoi leggere di più su limitToLast() nei dati di filtraggio .

Firma:

export declare function limitToLast(limit: number): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
limite	numero	Il numero massimo di nodi da includere in questa query.

Ritorna:

Queryconstraint

funzione (logger, ...)

EnableLogging (Logger)

Registri le informazioni di debug alla console.

Firma:

export declare function enableLogging(logger: (message: string) => unknown): any;

Parametri

Parametro	Tipo	Descrizione
registratore	(Messaggio: String) => sconosciuto	Una funzione di logger personalizzata per controllare il modo in cui le cose vengono registrate.

Ritorna:

Qualunque

funzione (genitore, ...)

figlio (genitore, percorso)

Ottiene un Reference per la posizione sul percorso relativo specificato.

Il percorso relativo può essere un nome figlio semplice (ad esempio, "ADA") o un percorso più profondo separato da barra (ad esempio, "Ada/Nome/First").

Firma:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

Parametri

Parametro	Tipo	Descrizione
genitore	Databasereference	La posizione del genitore.
sentiero	corda	Un percorso relativo da questa posizione alla posizione del bambino desiderata.

Ritorna:

Databasereference

La posizione specifica del bambino.

push (genitore, valore)

Genera una nuova posizione del bambino utilizzando una chiave univoca e restituisce il suo Reference .

Questo è il modello più comune per l'aggiunta di dati a una raccolta di articoli.

Se fornisci un valore da push() , il valore è scritto nella posizione generata. Se non si passa un valore, nulla è scritto nel database e il bambino rimane vuoto (ma puoi usare il Reference altrove).

Le chiavi uniche generate da push() sono ordinate dall'ora corrente, quindi l'elenco risultante di elementi è ordinato cronologicamente. Le chiavi sono inoltre progettate per essere incudute (contengono 72 bit casuali di entropia).

Vedere Aggiungi a un elenco di dati . Vedere i 2^120 modi per garantire identificatori univoci .

Firma:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

Parametri

Parametro	Tipo	Descrizione
genitore	Databasereference	La posizione del genitore.
valore	sconosciuto	Valore opzionale da scrivere nella posizione generata.

Ritorna:

Allorablereference

Promise e Reference combinati ; Risolve quando la scrittura è completa, ma può essere utilizzata immediatamente come Reference alla posizione del bambino.

funzione (percorso, ...)

OrderByChild (Path)

Crea un nuovo QueryConstraint che ordina dalla chiave del bambino specificata.

Le domande possono ordinare solo per una chiave alla volta. Calling orderByChild() più volte sulla stessa query è un errore.

Le query Firebase ti consentono di ordinare i tuoi dati tramite qualsiasi chiave per bambini al volo. Tuttavia, se sai in anticipo quali saranno i tuoi indici, puoi definirli tramite la regola .Indexon nelle regole di sicurezza per prestazioni migliori. Vedi la regola della regola https://firebase.google.com/docs/database/security/indexing-data per ulteriori informazioni.

Puoi leggere di più su orderByChild() nei dati di ordinamento .

Firma:

export declare function orderByChild(path: string): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
sentiero	corda	Il percorso da ordinare di.

Ritorna:

Queryconstraint

funzione (query, ...)

Ottieni (query)

Ottiene il risultato più aggiornato per questa query.

Firma:

export declare function get(query: Query): Promise<DataSnapshot>;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.

Ritorna:

Promise < DataSNapShot >

Una Promise che si risolve ai dati di dati risultanti se è disponibile un valore o rifiuta se il client non è in grado di restituire un valore (ad esempio, se il server è irraggiungibile e non c'è nulla memorizzata nella cache).

OFF (query, eventtype, callback)

Distacco un callback precedentemente collegato al corrispondente on*() ( onValue , onChildAdded ) ascoltatore. Nota: questo non è il modo consigliato per rimuovere un ascoltatore. Invece, utilizzare la funzione di callback restituita dai rispettivi on* callback.

Staccare un callback precedentemente allegato con on*() . Chiamare off() su un ascoltatore madre non rimuoverà automaticamente gli ascoltatori registrati sui nodi figlio, off() deve anche essere chiamato su qualsiasi ascoltatori di figli per rimuovere il callback.

Se non viene specificato un callback, tutti i callback per EventType specificati verranno rimossi. Allo stesso modo, se non viene specificato alcun tipo di eventType, tutti i callback per il Reference verranno rimossi.

I singoli ascoltatori possono anche essere rimossi invocando i loro callback di annullamento dell'iscrizione.

Firma:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda con cui l'ascoltatore è stato registrato.
Tipo di evento	Tipo di evento	Una delle seguenti stringhe: "Value", "Child_Added", "Child_Changed", "Child_removed" o "Child_moved". Se omessi, tutti i callback per il Reference verranno rimossi.
richiamare	(Snapshot: DataSNapShot , PrecedentiChildName?: String | null) => sconosciuto	La funzione di callback che è stata passata on() o undefined per rimuovere tutti i callback.

Ritorna:

vuoto

OnChildadded (query, callback, cancelcallback)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildAdded verrà attivato una volta per ogni bambino iniziale in questa posizione e verrà nuovamente attivato ogni volta che viene aggiunto un nuovo bambino. DataSnapshot trasmesso nel callback rifletterà i dati per il bambino pertinente. Ai fini dell'ordinamento, viene superata un secondo argomento che è una stringa contenente la chiave del precedente figlio di fratelli per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PrecedentiChildName?: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnChildadded (query, callback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildAdded verrà attivato una volta per ogni bambino iniziale in questa posizione e verrà nuovamente attivato ogni volta che viene aggiunto un nuovo bambino. DataSnapshot trasmesso nel callback rifletterà i dati per il bambino pertinente. Ai fini dell'ordinamento, viene superata un secondo argomento che è una stringa contenente la chiave del precedente figlio di fratelli per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnChildadded (query, callback, cancelCallback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildAdded verrà attivato una volta per ogni bambino iniziale in questa posizione e verrà nuovamente attivato ogni volta che viene aggiunto un nuovo bambino. DataSnapshot trasmesso nel callback rifletterà i dati per il bambino pertinente. Ai fini dell'ordinamento, viene superata un secondo argomento che è una stringa contenente la chiave del precedente figlio di fratelli per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnChildChanged (query, callback, cancelcallback)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildChanged verrà attivato quando i dati memorizzati in un bambino (o in uno qualsiasi dei suoi discendenti) cambia. Si noti che un singolo evento child_changed può rappresentare più modifiche al bambino. DataSnapshot passato al callback conterrà il nuovo contenuto figlio. Ai fini dell'ordinamento, il callback viene anche superato un secondo argomento che è una stringa contenente la chiave del bambino di fratelli precedenti per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnchildChanged (query, callback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildChanged verrà attivato quando i dati memorizzati in un bambino (o in uno qualsiasi dei suoi discendenti) cambia. Si noti che un singolo evento child_changed può rappresentare più modifiche al bambino. DataSnapshot passato al callback conterrà il nuovo contenuto figlio. Ai fini dell'ordinamento, il callback viene anche superato un secondo argomento che è una stringa contenente la chiave del bambino di fratelli precedenti per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnChildChanged (query, callback, cancelCallback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildChanged verrà attivato quando i dati memorizzati in un bambino (o in uno qualsiasi dei suoi discendenti) cambia. Si noti che un singolo evento child_changed può rappresentare più modifiche al bambino. DataSnapshot passato al callback conterrà il nuovo contenuto figlio. Ai fini dell'ordinamento, il callback viene anche superato un secondo argomento che è una stringa contenente la chiave del bambino di fratelli precedenti per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnchildMoved (query, callback, cancelcallback)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildMoved verrà attivato quando l'ordine di ordinamento di un bambino cambia in modo tale che la sua posizione rispetto ai suoi fratelli cambia. DataSnapshot passato al callback sarà per i dati del bambino che si è spostato. Viene inoltre superato un secondo argomento che è una stringa contenente la chiave del bambino di fratelli precedenti per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnchildMoved (query, callback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildMoved verrà attivato quando l'ordine di ordinamento di un bambino cambia in modo tale che la sua posizione rispetto ai suoi fratelli cambia. DataSnapshot passato al callback sarà per i dati del bambino che si è spostato. Viene inoltre superato un secondo argomento che è una stringa contenente la chiave del bambino di fratelli precedenti per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnChildMoved (query, callback, cancelCallback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildMoved verrà attivato quando l'ordine di ordinamento di un bambino cambia in modo tale che la sua posizione rispetto ai suoi fratelli cambia. DataSnapshot passato al callback sarà per i dati del bambino che si è spostato. Viene inoltre superato un secondo argomento che è una stringa contenente la chiave del bambino di fratelli precedenti per ordine di ordinamento o null se è il primo figlio.

Firma:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot , PriorChildName: String | null) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

Onchildremoved (query, callback, cancelcallback)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildRemoved verrà attivato una volta che ogni volta che un bambino viene rimosso. Il DataSnapshot è passato al callback saranno i vecchi dati per il bambino che è stato rimosso. Un bambino verrà rimosso quando uno dei due:

• Un cliente chiama esplicitamente remove() su quel bambino o uno dei suoi antenati - un cliente chiama set(null) su quel bambino o uno dei suoi antenati - quel bambino ha rimosso tutti i suoi figli - c'è una domanda in vigore che ora filtra fuori il bambino (perché è cambiato ordine o il limite massimo è stato colpito)

Firma:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot ) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

Onchildremoved (query, callback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildRemoved verrà attivato una volta che ogni volta che un bambino viene rimosso. Il DataSnapshot è passato al callback saranno i vecchi dati per il bambino che è stato rimosso. Un bambino verrà rimosso quando uno dei due:

• Un cliente chiama esplicitamente remove() su quel bambino o uno dei suoi antenati - un cliente chiama set(null) su quel bambino o uno dei suoi antenati - quel bambino ha rimosso tutti i suoi figli - c'è una domanda in vigore che ora filtra fuori il bambino (perché è cambiato ordine o il limite massimo è stato colpito)

Firma:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot ) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnChilDremoved (query, callback, cancelCallback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onChildRemoved verrà attivato una volta che ogni volta che un bambino viene rimosso. Il DataSnapshot è passato al callback saranno i vecchi dati per il bambino che è stato rimosso. Un bambino verrà rimosso quando uno dei due:

• Un cliente chiama esplicitamente remove() su quel bambino o uno dei suoi antenati - un cliente chiama set(null) su quel bambino o uno dei suoi antenati - quel bambino ha rimosso tutti i suoi figli - c'è una domanda in vigore che ora filtra fuori il bambino (perché è cambiato ordine o il limite massimo è stato colpito)

Firma:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot ) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot e una stringa contenente la chiave del bambino precedente, per ordinamento o null se è il primo figlio.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnValue (query, callback, cancelCallback)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onValue si attiverà una volta con i dati iniziali archiviati in questa posizione, quindi attiva nuovamente ogni volta che i dati cambiano. Il DataSnapshot è passato al callback sarà per la posizione in cui è stato chiamato on() . Non attiverà fino a quando l'intero contenuto non sarà stato sincronizzato. Se la posizione non ha dati, verrà attivato con un DataSnapshot vuoto ( val() restituirà null ).

Firma:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot ) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento dell'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnValue (query, callback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onValue si attiverà una volta con i dati iniziali archiviati in questa posizione, quindi attiva nuovamente ogni volta che i dati cambiano. Il DataSnapshot è passato al callback sarà per la posizione in cui è stato chiamato on() . Non attiverà fino a quando l'intero contenuto non sarà stato sincronizzato. Se la posizione non ha dati, verrà attivato con un DataSnapshot vuoto ( val() restituirà null ).

Firma:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot ) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

OnValue (query, callback, cancelCallback, opzioni)

Ascolta le modifiche ai dati in una posizione particolare.

Questo è il modo principale per leggere i dati da un database. Il callback verrà attivato per i dati iniziali e di nuovo ogni volta che i dati cambiano. Invocare il callback di annullamento restituito per interrompere la ricezione di aggiornamenti. Vedere Recupera i dati sul Web per maggiori dettagli.

Un evento onValue si attiverà una volta con i dati iniziali archiviati in questa posizione, quindi attiva nuovamente ogni volta che i dati cambiano. Il DataSnapshot è passato al callback sarà per la posizione in cui è stato chiamato on() . Non attiverà fino a quando l'intero contenuto non sarà stato sincronizzato. Se la posizione non ha dati, verrà attivato con un DataSnapshot vuoto ( val() restituirà null ).

Firma:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	La domanda da eseguire.
richiamare	(Snapshot: DataSNapShot ) => sconosciuto	Un callback che si accende quando si verifica l'evento specificato. Il callback verrà superato un DataSNapShot.
cancelCallback	(errore: errore) => sconosciuto	Un callback opzionale che verrà avvisato se l'abbonamento all'evento viene mai cancellato perché il tuo cliente non ha il permesso di leggere questi dati (o aveva il permesso ma ora lo ha perso). Questo callback verrà superato un oggetto Error che indica perché si è verificato il errore.
opzioni	Ascoltazioni	Un oggetto che può essere utilizzato per configurare onlyOnce , che quindi rimuove l'ascoltatore dopo la sua prima invocazione.

Ritorna:

Annulla l'iscrizione

Una funzione che può essere invocata per rimuovere l'ascoltatore.

query (query, querycostraints)

Crea una nuova istanza immutabile di Query che viene estesa per includere anche vincoli di query aggiuntivi.

Firma:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

Parametri

Parametro	Tipo	Descrizione
domanda	Domanda	L'istanza di query da utilizzare come base per i nuovi vincoli.
QueryConstraints	Queryconstraint []	L'elenco di QueryConstraint S da applicare.

Ritorna:

Domanda

Eccezioni

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(ref, ...)

onDisconnect(ref)

Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it.

Firma:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

Parametri

Parametro	Tipo	Descrizione
rif	DatabaseReference	The reference to add OnDisconnect triggers for.

Ritorna:

OnDisconnect

remove(ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Firma:

export declare function remove(ref: DatabaseReference): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
rif	DatabaseReference	The location to remove.

Ritorna:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

Note: Modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and runTransaction() to update the same data.

Note: When using transactions with Security and Firebase Rules in place, be aware that a client needs .read access in addition to .write access in order to perform a transaction. This is because the client-side nature of transactions requires the client to read the data in order to transactionally update it.

Firma:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

Parametri

Parametro	Tipo	Descrizione
rif	DatabaseReference	The location to atomically modify.
transactionUpdate	(currentData: any) => unknown	A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
opzioni	TransactionOptions	An options object to configure transactions.

Ritorna:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

Firma:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
rif	DatabaseReference	The location to write to.
valore	sconosciuto	The value to be written (string, number, boolean, object, array, or null).

Ritorna:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Firma:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
rif	DatabaseReference	The location to write to.
priorità	stringa | numero | nullo	The priority to be written (string, number, or null).

Ritorna:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Firma:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
rif	DatabaseReference	The location to write to.
valore	sconosciuto	The value to be written (string, number, boolean, object, array, or null).
priorità	stringa | numero | nullo	The priority to be written (string, number, or null).

Ritorna:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

Firma:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

Parametri

Parametro	Tipo	Descrizione
rif	DatabaseReference	The location to write to.
valori	oggetto	Object containing multiple values.

Ritorna:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

Firma:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
valore	numero | stringa | boolean | nullo	The value to end at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chiave	corda	The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Ritorna:

QueryConstraint

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

Firma:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
valore	numero | stringa | boolean | nullo	The value to end before. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chiave	corda	The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Ritorna:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

Firma:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
valore	numero | stringa | boolean | nullo	The value to match for. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chiave	corda	The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Ritorna:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

Firma:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
valore	numero | stringa | boolean | nullo	The value to start after. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chiave	corda	The child key to start after. This argument is only allowed if ordering by child, value, or priority.

Ritorna:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

Firma:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

Parametri

Parametro	Tipo	Descrizione
valore	numero | stringa | boolean | nullo	The value to start at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
chiave	corda	The child key to start at. This argument is only allowed if ordering by child, value, or priority.

Ritorna:

QueryConstraint

Tipo di evento

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

Firma:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

Firma:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

Annulla l'iscrizione

A callback that can invoked to remove a listener.

Firma:

export declare type Unsubscribe = () => void;