Firebase Realtime Database
Funções
| Função | Descrição |
|---|---|
| function(app, ...) (link em inglês) | |
| getDatabase(app, url) (link em inglês) | Retorna a instância do SDK do Realtime Database associada ao FirebaseApp fornecido. Inicializa uma nova instância com configurações padrão se nenhuma instância existir ou se a instância atual usar um URL de banco de dados personalizado. |
| function(db, ...) | |
| connectDatabaseEmulator(db, host, porta, opções) | Modifique a instância fornecida para se comunicar com o emulador do Realtime Database. Observação: esse método precisa ser chamado antes de qualquer outra operação. |
| goOff-line(db) | Desconecta-se do servidor (todas as operações do Database serão concluídas off-line).O cliente mantém automaticamente uma conexão persistente com o servidor do Database, que permanece ativa por tempo indeterminado e reconectada quando desconectado. No entanto, os métodos goOffline() e goOnline() podem ser usados para controlar a conexão do cliente nos casos em que uma conexão persistente não é desejável.Enquanto estiver off-line, o cliente não receberá mais atualizações de dados do banco de dados. No entanto, todas as operações do banco de dados realizadas localmente continuarão a disparar eventos imediatamente, permitindo que o aplicativo continue se comportando normalmente. Além disso, cada operação realizada localmente será automaticamente enfileirada e repetida após a reconexão com o servidor do Database.Para se reconectar ao banco de dados e começar a receber eventos remotos, consulte goOnline(). |
| goOnline(db) (em inglês) | Reconecta-se ao servidor e sincroniza o estado do banco de dados off-line com o estado do servidor.Este método deve ser usado depois de desativar a conexão ativa com goOffline(). Depois de reconectado, o cliente transmitirá os dados adequados e acionará os eventos apropriados para que seu cliente consiga se recuperar automaticamente. |
| ref(db, path) | Retorna um Reference que representa o local no banco de dados correspondente ao caminho fornecido. Se nenhum caminho for fornecido, o Reference apontará para a raiz do banco de dados. |
| refFromURL(db, url) | Retorna um Reference que representa o local no Database correspondente ao URL do Firebase fornecido.Uma exceção vai ser gerada se o URL não for um URL válido do Firebase Database ou tiver um domínio diferente da instância atual do Database.Observe que todos os parâmetros de consulta (orderBy, limitToLast etc.) serão ignorados e não serão aplicados ao Reference retornado. |
| function(). | |
| forceLongPolling() (link em inglês) | Forçar o uso de longPolling em vez de websockets. Isso será ignorado se o protocolo websocket for usado em databaseURL. |
| forceWebSockets() (link em inglês) | Forçar o uso de websockets em vez de longPolling. |
| orderByKey(). | Cria uma nova QueryConstraint que ordena pela chave.Classifica os resultados de uma consulta pelos valores de chave (crescente).Leia mais sobre orderByKey() em Classificar dados. |
| orderBypriority() (link em inglês). | Cria uma nova QueryConstraint que ordena por prioridade.Os aplicativos não precisam usar prioridade, mas podem ordenar coleções por propriedades comuns. Consulte Classificar dados para conferir alternativas à prioridade. |
| orderByValue() (link em inglês). | Cria uma nova QueryConstraint que ordena por valor.Se os filhos de uma consulta forem todos valores escalares (string, número ou booleano), você poderá ordenar os resultados pelos valores (crescentes).Leia mais sobre orderByValue() em Classificar dados. |
| serverTimestamp(). | Retorna um valor de marcador para preencher automaticamente o carimbo de data/hora atual (tempo desde a época Unix, em milissegundos), conforme determinado pelos servidores do Firebase. |
| function(delta, ...) | |
| increment(delta) (em inglês) | Retorna um valor de marcador que pode ser usado para incrementar atomicamente o valor atual do banco de dados pelo delta fornecido. |
| function(enabled, ...) | |
| enableLogging(ativado, persistente) | Registra informações de depuração no console. |
| function(limit, ...) | |
| limitToFirst(limit) (em inglês) | Cria uma nova QueryConstraint que, se limitada ao primeiro número específico de filhos.O método limitToFirst() é usado para definir um número máximo de filhos a serem sincronizados para um determinado callback. Se definirmos um limite de 100, receberemos inicialmente até 100 eventos child_added. Se tivermos menos de 100 mensagens armazenadas no nosso banco de dados, um evento child_added será disparado para cada mensagem. No entanto, se tivermos mais de 100 mensagens, receberemos um evento child_added apenas para as 100 primeiras mensagens ordenadas. À medida que os itens mudarem, vamos receber child_removed eventos para cada item que sair da lista ativa, de modo que o número total permaneça 100.Leia mais sobre limitToFirst() em Como filtrar dados. |
| limitToLast(limit) (link em inglês) | Cria uma nova QueryConstraint limitada para retornar somente o último número especificado de filhos.O método limitToLast() é usado para definir um número máximo de filhos a serem sincronizados para um determinado callback. Se definirmos um limite de 100, receberemos inicialmente até 100 eventos child_added. Se tivermos menos de 100 mensagens armazenadas no nosso banco de dados, um evento child_added será disparado para cada mensagem. No entanto, se tivermos mais de 100 mensagens, receberemos um evento child_added apenas para as últimas 100 mensagens ordenadas. À medida que os itens mudarem, vamos receber child_removed eventos para cada item que sair da lista ativa, de modo que o número total permaneça 100.Leia mais sobre limitToLast() em Como filtrar dados. |
| function(logger, ...) | |
| enableLogging(logger) | Registra informações de depuração no console. |
| function(parent, ...) | |
| child(pai, path) | Recebe um Reference para o local no caminho relativo especificado.O caminho relativo pode ser um nome de filho simples (por exemplo, "ada") ou um caminho separado por barras mais profundas (por exemplo, "ada/name/first"). |
| push(parent, value) | Gera um novo local filho usando uma chave exclusiva e retorna o Reference dela.Este é o padrão mais comum para adicionar dados a uma coleção de itens.Se você fornecer um valor para push(), ele será gravado no local gerado. Se você não transmitir um valor, nada será gravado no banco de dados, e o filho permanecerá vazio, mas é possível usar Reference em outro lugar.Como as chaves exclusivas geradas por push() são ordenadas pelo horário atual, a lista de itens resultante é ordenada de forma cronológica. As chaves também são projetadas para não serem detectadas (elas contêm 72 bits aleatórios de entropia).Consulte Anexar a uma lista de dados. Consulte As 2^120 maneiras de garantir identificadores exclusivos. |
| function(path, ...) (link em inglês) | |
| orderByChild(caminho) | Cria um novo QueryConstraint que ordena pela chave filha especificada.As consultas só podem ser ordenadas com uma chave por vez. Chamar orderByChild() várias vezes na mesma consulta é um erro.As consultas do Firebase permitem ordenar seus dados por qualquer chave filha imediatamente. No entanto, se você souber com antecedência quais serão seus índices, poderá defini-los pela regra .indexOn nas suas regras de segurança para melhorar o desempenho. Consulte a regra https://firebase.google.com/docs/database/security/indexing-data para saber mais.Leia mais sobre orderByChild() em Classificar dados. |
| function(query, ...) | |
| get(query) (em inglês) | Recebe o resultado mais atualizado para esta consulta. |
| off(query, eventType, callback) | Separa um callback previamente anexado ao listener on() (onValue, onChildAdded) correspondente. Observação: essa não é a maneira recomendada de remover um listener. Em vez disso, use a função de callback retornada dos respectivos callbacks on.Remova um callback previamente anexado com on*(). Chamar off() em um listener pai não removerá automaticamente os listeners registrados nos nós filhos. off() também precisa ser chamado nos listeners filhos para remover o callback.Se um callback não for especificado, todos os callbacks do eventType especificado serão removidos. Da mesma forma, se nenhum eventType for especificado, todos os callbacks de Reference serão removidos.Os listeners individuais também podem ser removidos invocando os callbacks de cancelamento de inscrição. |
| onChildAdded(query, callback, cancelCallback) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildAdded será acionado uma vez para cada filho inicial nesse local e será acionado novamente sempre que um novo filho for adicionado. A DataSnapshot transmitida ao callback refletirá os dados do filho relevante. Para fins de ordenação, ele recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho. |
| onChildAdded(consulta, callback, opções) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildAdded será acionado uma vez para cada filho inicial nesse local e será acionado novamente sempre que um novo filho for adicionado. A DataSnapshot transmitida ao callback refletirá os dados do filho relevante. Para fins de ordenação, ele recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho. |
| onChildAdded(query, callback, cancelCallback, options) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildAdded será acionado uma vez para cada filho inicial nesse local e será acionado novamente sempre que um novo filho for adicionado. A DataSnapshot transmitida ao callback refletirá os dados do filho relevante. Para fins de ordenação, ele recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho. |
| onChildChanged(query, callback, cancelCallback) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.Um evento onChildChanged será acionado quando os dados armazenados em um filho (ou em qualquer um dos descendentes) mudarem. Um único evento child_changed pode representar várias mudanças no filho. O DataSnapshot transmitido ao callback terá o novo conteúdo filho. Para fins de ordenação, o callback também recebe um segundo argumento, que é uma string que contém a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho. |
| onChildChanged(query, callback, options) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.Um evento onChildChanged será acionado quando os dados armazenados em um filho (ou em qualquer um dos descendentes) mudarem. Um único evento child_changed pode representar várias mudanças no filho. O DataSnapshot transmitido ao callback terá o novo conteúdo filho. Para fins de ordenação, o callback também recebe um segundo argumento, que é uma string que contém a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho. |
| onChildChanged(query, callback, cancelCallback, options) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.Um evento onChildChanged será acionado quando os dados armazenados em um filho (ou em qualquer um dos descendentes) mudarem. Um único evento child_changed pode representar várias mudanças no filho. O DataSnapshot transmitido ao callback terá o novo conteúdo filho. Para fins de ordenação, o callback também recebe um segundo argumento, que é uma string que contém a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho. |
| onChildMoving(query, callback, cancelCallback) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildMoved será acionado quando a ordem de classificação de um filho mudar de forma que a posição dele em relação aos irmãos mude. O DataSnapshot transmitido ao callback será para os dados do filho que foi movido. Ele também recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null, se ele for o primeiro filho. |
| onChildMigração(consulta, callback, opções) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildMoved será acionado quando a ordem de classificação de um filho mudar de forma que a posição dele em relação aos irmãos mude. O DataSnapshot transmitido ao callback será para os dados do filho que foi movido. Ele também recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null, se ele for o primeiro filho. |
| onChildMoving(query, callback, cancelCallback, options) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildMoved será acionado quando a ordem de classificação de um filho mudar de forma que a posição dele em relação aos irmãos mude. O DataSnapshot transmitido ao callback será para os dados do filho que foi movido. Ele também recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null, se ele for o primeiro filho. |
| onChildRemoved(query, callback, cancelCallback) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildRemoved será acionado sempre que um filho for removido. O DataSnapshot transmitido ao callback serão os dados antigos do filho que foi removido. Um filho será removido quando:- um cliente chamar explicitamente remove() nesse filho ou em um dos ancestrais dele; um cliente chamar set(null) nesse filho ou em um dos ancestrais dele; quando o filho tiver todos os filhos removidos; e houver uma consulta em vigor que agora filtra o filho (porque a ordem de classificação dele foi alterada ou o limite máximo foi atingido). |
| onChildRemoved(consulta, callback, opções) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildRemoved será acionado sempre que um filho for removido. O DataSnapshot transmitido ao callback serão os dados antigos do filho que foi removido. Um filho será removido quando:- um cliente chamar explicitamente remove() nesse filho ou em um dos ancestrais dele; um cliente chamar set(null) nesse filho ou em um dos ancestrais dele; quando o filho tiver todos os filhos removidos; e houver uma consulta em vigor que agora filtra o filho (porque a ordem de classificação dele foi alterada ou o limite máximo foi atingido). |
| onChildRemoved(query, callback, cancelCallback, options) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados da Web para mais detalhes.Um evento onChildRemoved será acionado sempre que um filho for removido. O DataSnapshot transmitido ao callback serão os dados antigos do filho que foi removido. Um filho será removido quando:- um cliente chamar explicitamente remove() nesse filho ou em um dos ancestrais dele; um cliente chamar set(null) nesse filho ou em um dos ancestrais dele; quando o filho tiver todos os filhos removidos; e houver uma consulta em vigor que agora filtra o filho (porque a ordem de classificação dele foi alterada ou o limite máximo foi atingido). |
| onValue(query, callback, cancelCallback) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.Um evento onValue será acionado uma vez com os dados iniciais armazenados nesse local e mais tarde sempre que os dados forem alterados. O DataSnapshot transmitido ao callback será do local em que o on() foi chamado. Ele não será acionado até que todo o conteúdo seja sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio (val() retornará null). |
| onValue(consulta, callback, opções) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.Um evento onValue será acionado uma vez com os dados iniciais armazenados nesse local e mais tarde sempre que os dados forem alterados. O DataSnapshot transmitido ao callback será do local em que o on() foi chamado. Ele não será acionado até que todo o conteúdo seja sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio (val() retornará null). |
| onValue(query, callback, cancelCallback, options) | Detecta alterações de dados em um local específico.Esta é a maneira principal de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.Um evento onValue será acionado uma vez com os dados iniciais armazenados nesse local e mais tarde sempre que os dados forem alterados. O DataSnapshot transmitido ao callback será do local em que o on() foi chamado. Ele não será acionado até que todo o conteúdo seja sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio (val() retornará null). |
| query(query, queryConstraints) | Cria uma nova instância imutável de Query que é estendida para incluir outras restrições de consulta. |
| function(ref, ...) | |
| onDesconectar(ref) | Retorna um objeto OnDisconnect. Consulte Como ativar recursos off-line no JavaScript para mais informações sobre como usá-los. |
| remove(ref) | Remove os dados neste local do banco de dados.Todos os dados em locais filhos também serão excluídos.O efeito da remoção ficará visível imediatamente e o evento "valor" correspondente será acionado. A sincronização da remoção com os servidores do Firebase também será iniciada, e a promessa retornada será resolvida quando ela for concluída. Se fornecido, o callback onComplete será chamado de forma assíncrona após a conclusão da sincronização. |
| runTransaction(ref, transactionUpdate, options) | Modifica atomicamente os dados neste local.Modifica atomicamente os dados neste local. Ao contrário de um set() normal, que apenas substitui os dados independentemente do valor anterior, runTransaction() é usado para modificar o valor atual para um novo valor, garantindo que não haja conflitos com outros clientes gravando no mesmo local ao mesmo tempo.Para fazer isso, transmita a runTransaction() uma função de atualização usada para transformar o valor atual em um novo valor. Se outro cliente fizer uma gravação no local antes que seu novo valor seja gravado com sucesso, sua função de atualização será chamada novamente com o novo valor atual e a gravação será repetida. Isso acontecerá repetidamente até que a gravação seja bem-sucedida sem conflito ou até que você cancele a transação sem retornar um valor da função de atualização.Observação: a modificação de dados com set() cancelará todas as transações pendentes no local. Por isso, tenha cuidado extremo se misturar set() e runTransaction() para atualizar os mesmos dados.Observação: ao usar transações com regras de segurança e do Firebase, lembre-se de que um cliente precisa do acesso .read, além do acesso a .write, para realizar uma transação. Isso ocorre porque a natureza das transações do lado do cliente exige que o cliente leia os dados para atualizá-los de maneira transacional. |
| set(ref, value) | Grava dados neste local do banco de dados.Isso substituirá todos os dados neste local e em todos os locais filhos.O efeito da gravação ficará visível imediatamente, e os eventos correspondentes ("value", "child_added" etc.) serão acionados. A sincronização dos dados com os servidores do Firebase também será iniciada, e a promessa retornada será resolvida quando ela for concluída. Se fornecido, o callback onComplete será chamado de forma assíncrona após a conclusão da sincronização.Transmitir null para o novo valor é equivalente a chamar remove(). Ou seja, todos os dados neste local e todos os locais filhos serão excluídos. set() removerá qualquer prioridade armazenada nesse local. Portanto, se quiser preservar a prioridade, use setWithPriority().Observe que modificar os dados com set() cancelará todas as transações pendentes no local, portanto, tenha cuidado extremo se misturar set() e transaction() para modificar os mesmos dados.Um único set() gerará um único "valor". evento no local em que set() foi realizado. |
| setPrioridade(ref, prioridade) | Define uma prioridade para os dados no local do banco de dados.Os aplicativos não precisam usar prioridade, mas podem ordenar coleções por propriedades comuns. Consulte Como classificar e filtrar dados. |
| setWithPrioridade(ref, valor, prioridade) | Grava dados no local do banco de dados. É semelhante a set(), mas também especifica a prioridade dos dados.Os aplicativos não precisam usar prioridade, mas podem ordenar coleções por propriedades comuns. Consulte Como classificar e filtrar dados. |
| update(ref, values) | Grava vários valores no banco de dados de uma só vez.O argumento values contém vários pares de propriedade-valor que serão gravados no banco de dados juntos. Cada propriedade filha pode ser uma propriedade simples (por exemplo, "nome") ou um caminho relativo (por exemplo, "nome/nome") do local atual para os dados a serem atualizados.Ao contrário do método set(), update() pode ser usado para atualizar seletivamente apenas as propriedades referenciadas no local atual (em vez de substituir todas as propriedades filhas no local atual).O efeito da gravação será visível imediatamente, e os eventos correspondentes ("child_added", "child_value") serão acionados imediatamente. A sincronização dos dados com os servidores do Firebase também será iniciada, e a promessa retornada será resolvida quando ela for concluída. Se fornecido, o callback onComplete será chamado de forma assíncrona após a conclusão da sincronização.Um único update() gerará um único "valor" no local em que o update() foi realizado, independentemente de quantos filhos foram modificados.A modificação de dados com update() cancela todas as transações pendentes nesse local. Por isso, tome cuidado se combinar update() e transaction() para modificar os mesmos dados.Transmitir null para update() removerá os dados nesse local.Consulte Atualizações em vários locais e muito mais. |
| function(value, ...) | |
| endAt(value, key) | Cria uma QueryConstraint com o ponto final especificado.O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para as consultas.O ponto final é inclusivo, então filhos com o valor especificado vão ser incluídos na consulta. O argumento de chave opcional pode ser usado para limitar ainda mais o intervalo da consulta. Se for especificado, os filhos que tiverem exatamente o valor especificado também precisarão ter um nome de chave menor ou igual à chave especificada.Leia mais sobre endAt() em Como filtrar dados. |
| endBefore(valor, chave) | Cria um QueryConstraint com o ponto final especificado (exclusivo).O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para suas consultas.O ponto final é exclusivo. Se apenas um valor for fornecido, filhos com um valor menor que o especificado serão incluídos na consulta. Se uma chave for especificada, os filhos precisarão ter um valor menor ou igual ao valor especificado e um nome de chave menor que a chave especificada. |
| equalTo(value, key) | Cria um QueryConstraint que inclui filhos que correspondem ao valor especificado.O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para as consultas.O argumento de chave opcional pode ser usado para limitar ainda mais o intervalo da consulta. Se for especificada, os filhos que tiverem exatamente o valor especificado também precisarão ter exatamente a chave especificada como nome de chave. Isso pode ser usado para filtrar conjuntos de resultados com muitas correspondências para o mesmo valor.Leia mais sobre equalTo() em Como filtrar dados. |
| startAfter(value, key) | Cria uma QueryConstraint com o ponto de partida especificado (exclusivo).O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para suas consultas.O ponto de partida é exclusivo. Se apenas um valor for fornecido, filhos com um valor maior que o especificado serão incluídos na consulta. Se uma chave for especificada, os filhos precisarão ter um valor maior ou igual ao valor especificado e um nome de chave maior que a chave especificada. |
| startAt(value, key) | Cria uma QueryConstraint com o ponto de partida especificado.O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para as consultas.O ponto de partida é inclusivo, ou seja, filhos com exatamente o valor especificado serão incluídos na consulta. O argumento de chave opcional pode ser usado para limitar ainda mais o intervalo da consulta. Se for especificado, os filhos que tiverem exatamente o valor especificado também precisarão ter um nome de chave maior ou igual à chave especificada.Leia mais sobre startAt() em Como filtrar dados. |
Classes
| Turma | Descrição |
|---|---|
| banco de dados | Classe que representa um Firebase Realtime Database. |
| DataSnapshot (em inglês) | Um DataSnapshot contém dados de um local do Database.Sempre que você lê dados do Database, os recebe como um DataSnapshot. Um DataSnapshot é transmitido aos callbacks do evento anexados com on() ou once(). Para extrair o conteúdo do snapshot como um objeto JavaScript, chame o método val(). Como alternativa, é possível acessar o snapshot chamando child() para retornar snapshots filhos (onde você pode chamar val()).Um DataSnapshot é uma cópia imutável e gerada de forma eficiente dos dados em um local do banco de dados. Ele não pode ser modificado e nunca vai mudar. Para modificar os dados, sempre chame o método set() diretamente em uma Reference. |
| OnDesconectar | A classe onDisconnect permite gravar ou limpar dados quando seu cliente se desconecta do servidor do Database. Essas atualizações ocorrem mesmo quando o cliente se desconecta incorretamente. Assim, você pode confiar nelas para limpar os dados mesmo se uma conexão for perdida ou se um cliente falhar.A classe onDisconnect é mais usada para gerenciar a presença em aplicativos em que é útil para detectar quantos clientes estão conectados e quando outros clientes se desconectam. Consulte Como ativar recursos off-line no JavaScript para mais informações.Para evitar problemas quando uma conexão é perdida antes da transferência das solicitações para o servidor do Database, essas funções devem ser chamadas antes de gravar qualquer dado.Observe que as operações onDisconnect são acionadas apenas uma vez. Se você quiser que uma operação ocorra sempre que ocorrer uma desconexão, será necessário restabelecer as operações onDisconnect sempre que você se reconectar. |
| QueryConstraint (link em inglês) | Um QueryConstraint é usado para restringir o conjunto de documentos retornados por uma consulta ao banco de dados. QueryConstraintQueryConstraint |
| TransactionResult (em inglês) | Um tipo para o valor de resolução de runTransaction(). |
Interfaces
| Interface | Descrição |
|---|---|
| DatabaseReference (em inglês) | Um DatabaseReference representa um local específico no seu banco de dados e pode ser usado para ler ou gravar dados nesse local do banco de dados.Você pode fazer referência ao local raiz ou filho no seu banco de dados chamando ref() ou ref("child/path").A gravação é feita com o método set() e a leitura pode ser feita com o método on*(). Consulte https://firebase.google.com/docs/database/web/read-and-write |
| IteratedDataSnapshot (em inglês) | Representa um snapshot filho de um Reference que está sendo iterado. A chave nunca será indefinida. |
| ListenOptions (link em inglês) | Objetos de opções que podem ser usados para personalizar um listener. |
| Consulta | Um Query classifica e filtra os dados no local do banco de dados para que apenas um subconjunto dos dados filhos seja incluído. Isso pode ser usado para ordenar uma coleção de dados por algum atributo (por exemplo, altura de dinossauros), bem como para restringir uma grande lista de itens (por exemplo, mensagens de chat) a um número adequado para sincronização com o cliente. As consultas são criadas encadeando um ou mais métodos de filtro definidos aqui.Assim como com um DatabaseReference, você pode receber dados de um Query usando os métodos on*(). Você só receberá eventos e DataSnapshots para o subconjunto de dados que corresponde à sua consulta.Consulte https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data para mais informações. |
| thenableReference (link em inglês) | Um Promise que também pode atuar como um DatabaseReference quando retornado por push(). A referência fica disponível imediatamente, e o Promise é resolvido à medida que a gravação no back-end é concluída. |
| TransactionOptions | Um objeto de opções para configurar transações. |
Aliases de tipos
| Alias de tipo | Descrição |
|---|---|
| EventType | Uma das seguintes strings: "value", "child_added", "child_ changed", "child_ removed" ou "child_moved". |
| QueryConstraintType (em inglês) | Descreve as diferentes restrições de consulta disponíveis neste SDK. |
| Cancelar inscrição | Um callback que pode ser invocado para remover um listener. |
função(app, ...)
getDatabase(app, url)
Retorna a instância do SDK do Realtime Database associada ao FirebaseApp fornecido. Inicializa uma nova instância com configurações padrão se nenhuma instância existir ou se a instância atual usar um URL de banco de dados personalizado.
Assinatura:
export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | FirebaseApp | A instância FirebaseApp à qual a instância retornada do Realtime Database está associada. |
| url | string | O URL da instância do Realtime Database à qual se conectar. Se não for fornecido, o SDK se conectará à instância padrão do app do Firebase. |
Retorna:
A instância Database do app fornecido.
função(db, ...)
connectDatabaseEmulator(db; host, porta; opções)
Modifique a instância fornecida para se comunicar com o emulador do Realtime Database.
Observação: esse método precisa ser chamado antes de qualquer outra operação.
Assinatura:
export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| db | banco de dados | A instância a ser modificada. |
| host | string | O host do emulador (por exemplo: localhost) |
| porta | number | A porta do emulador (por exemplo: 8080) |
| options | { mockUserToken? EmulatorMockTokenOptions | string } |
Retorna:
void
goOff-line(db)
Desconecta-se do servidor (todas as operações do Database serão concluídas off-line).
O cliente mantém automaticamente uma conexão persistente com o servidor do banco de dados, que permanece ativa indefinidamente e reconectada quando desconectado. No entanto, os métodos goOffline() e goOnline() podem ser usados para controlar a conexão do cliente nos casos em que uma conexão persistente não é desejável.
Enquanto estiver off-line, o cliente não receberá mais atualizações de dados do banco de dados. No entanto, todas as operações do banco de dados realizadas localmente continuarão a disparar eventos imediatamente, permitindo que o aplicativo continue se comportando normalmente. Além disso, cada operação realizada localmente será automaticamente enfileirada e repetida após a reconexão com o servidor do Database.
Para se reconectar ao banco de dados e começar a receber eventos remotos, consulte goOnline().
Assinatura:
export declare function goOffline(db: Database): void;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| db | banco de dados | A instância a ser desconectada. |
Retorna:
void
goOnline(db)
Reconecta-se ao servidor e sincroniza o estado do banco de dados off-line com o estado do servidor.
Use esse método após desativar a conexão ativa com goOffline(). Depois de reconectado, o cliente transmitirá os dados adequados e acionará os eventos apropriados para que seu cliente consiga se recuperar automaticamente.
Assinatura:
export declare function goOnline(db: Database): void;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| db | banco de dados | A instância a ser reconectada. |
Retorna:
void
ref(db, caminho)
Retorna um Reference que representa o local no banco de dados correspondente ao caminho fornecido. Se nenhum caminho for fornecido, o Reference apontará para a raiz do banco de dados.
Assinatura:
export declare function ref(db: Database, path?: string): DatabaseReference;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| db | banco de dados | A instância de banco de dados para a qual receber uma referência. |
| path | string | Caminho opcional que representa o local que o Reference retornado vai apontar. Se não for fornecido, o Reference retornado apontará para a raiz do banco de dados. |
Retorna:
DatabaseReference (em inglês)
Se um caminho for fornecido, um Reference apontando para o caminho fornecido. Caso contrário, um Reference apontando para a raiz do banco de dados.
refFromURL(db, url)
Retorna um Reference que representa o local no banco de dados correspondente ao URL do Firebase fornecido.
Uma exceção será gerada se o URL não for um URL válido do Firebase Database ou tiver um domínio diferente da instância atual do Database.
Todos os parâmetros de consulta (orderBy, limitToLast etc.) são ignorados e não são aplicados ao Reference retornado.
Assinatura:
export declare function refFromURL(db: Database, url: string): DatabaseReference;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| db | banco de dados | A instância de banco de dados para a qual receber uma referência. |
| url | string | O URL do Firebase para o qual o Reference retornado apontará. |
Retorna:
DatabaseReference (em inglês)
Um Reference que aponta para o URL do Firebase fornecido.
função()
forceLongPolling()
Forçar o uso de longPolling em vez de websockets. Isso será ignorado se o protocolo websocket for usado em databaseURL.
Assinatura:
export declare function forceLongPolling(): void;
Retorna:
void
forceWebSockets()
Forçar o uso de websockets em vez de longPolling.
Assinatura:
export declare function forceWebSockets(): void;
Retorna:
void
orderByKey()
Cria um novo QueryConstraint que faz pedidos pela chave.
Classifica os resultados de uma consulta por seus valores-chave (crescente).
Saiba mais sobre orderByKey() em Classificar dados.
Assinatura:
export declare function orderByKey(): QueryConstraint;
Retorna:
QueryConstraint (link em inglês)
orderByPrioridade().
Cria um novo QueryConstraint que faz pedidos por prioridade.
Os aplicativos não precisam usar prioridade, mas podem ordenar coleções por propriedades comuns. Consulte Classificar dados para alternativas à prioridade.
Assinatura:
export declare function orderByPriority(): QueryConstraint;
Retorna:
QueryConstraint (link em inglês)
orderByValue().
Cria um novo QueryConstraint que faz pedidos por valor.
Se os filhos de uma consulta forem todos valores escalares (string, número ou booleano), você poderá ordenar os resultados pelos valores (crescentes).
Saiba mais sobre orderByValue() em Classificar dados.
Assinatura:
export declare function orderByValue(): QueryConstraint;
Retorna:
QueryConstraint (link em inglês)
serverTimestamp()
Retorna um valor de marcador para preencher automaticamente o carimbo de data/hora atual (tempo desde a época Unix, em milissegundos), conforme determinado pelos servidores do Firebase.
Assinatura:
export declare function serverTimestamp(): object;
Retorna:
objeto
função(delta, ...)
incremento(delta)
Retorna um valor de marcador que pode ser usado para incrementar atomicamente o valor atual do banco de dados pelo delta fornecido.
Assinatura:
export declare function increment(delta: number): object;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| dado | number | a quantidade para modificar o valor atual atomicamente. |
Retorna:
objeto
Um valor de marcador para modificar dados atomicamente no lado do servidor.
function(enabled, ...)
enableLogging(ativado, persistente)
Registra informações de depuração no console.
Assinatura:
export declare function enableLogging(enabled: boolean, persistent?: boolean): any;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ativado | booleano | Ativa a geração de registros se true e desativa a geração de registros se false. |
| permanentes | booleano | Lembra o estado de geração de registros entre as atualizações da página se true. |
Retorna:
qualquer um
função(limit; ...)
limitToFirst(limit)
Cria um novo QueryConstraint que, se limitado ao primeiro número específico de filhos.
O método limitToFirst() é usado para definir um número máximo de filhos a serem sincronizados para um determinado callback. Se definirmos um limite de 100, receberemos inicialmente até 100 eventos child_added. Se tivermos menos de 100 mensagens armazenadas no nosso banco de dados, um evento child_added será disparado para cada mensagem. No entanto, se tivermos mais de 100 mensagens, receberemos um evento child_added apenas para as 100 primeiras mensagens ordenadas. À medida que os itens mudarem, vamos receber eventos child_removed para cada item que sair da lista ativa, de modo que o número total permaneça em 100.
Saiba mais sobre limitToFirst() em Como filtrar dados.
Assinatura:
export declare function limitToFirst(limit: number): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| limite | number | O número máximo de nós a serem incluídos nessa consulta. |
Retorna:
QueryConstraint (link em inglês)
limitToLast(limit)
Cria um novo QueryConstraint limitado para retornar apenas o último número especificado de filhos.
O método limitToLast() é usado para definir um número máximo de filhos a serem sincronizados para um determinado callback. Se definirmos um limite de 100, receberemos inicialmente até 100 eventos child_added. Se tivermos menos de 100 mensagens armazenadas no nosso banco de dados, um evento child_added será disparado para cada mensagem. No entanto, se tivermos mais de 100 mensagens, receberemos um evento child_added apenas para as últimas 100 mensagens ordenadas. À medida que os itens mudarem, vamos receber eventos child_removed para cada item que sair da lista ativa, de modo que o número total permaneça em 100.
Saiba mais sobre limitToLast() em Como filtrar dados.
Assinatura:
export declare function limitToLast(limit: number): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| limite | number | O número máximo de nós a serem incluídos nessa consulta. |
Retorna:
QueryConstraint (link em inglês)
função(logger, ...)
enableLogging(logger)
Registra informações de depuração no console.
Assinatura:
export declare function enableLogging(logger: (message: string) => unknown): any;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| logger | (mensagem: string) => desconhecido | Uma função personalizada de geração de registros para controlar como os itens são registrados. |
Retorna:
qualquer um
function(parent, ...)
filho(pai, caminho)
Recebe um Reference para o local no caminho relativo especificado.
O caminho relativo pode ser um nome de filho simples (por exemplo, "ada") ou um caminho separado por barras mais profundas (por exemplo, "ada/nome/nome").
Assinatura:
export declare function child(parent: DatabaseReference, path: string): DatabaseReference;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| primária | DatabaseReference (em inglês) | O local pai. |
| path | string | Um caminho relativo deste local para o local filho desejado. |
Retorna:
DatabaseReference (em inglês)
O local do filho especificado.
push(pai, valor)
Gera um novo local filho usando uma chave exclusiva e retorna o Reference.
Esse é o padrão mais comum para adicionar dados a uma coleção de itens.
Se você fornecer um valor para push(), o valor será gravado no local gerado. Se você não transmitir um valor, nada será gravado no banco de dados e o filho permanecerá vazio, mas é possível usar o Reference em outro lugar.
As chaves exclusivas geradas por push() são ordenadas pelo horário atual. Portanto, a lista de itens resultante é organizada cronologicamente. As chaves também são projetadas para não serem adivinhadas (elas contêm 72 bits aleatórios de entropia).
Consulte Anexar a uma lista de dados. Consulte As 2^120 maneiras de garantir identificadores exclusivos.
Assinatura:
export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| primária | DatabaseReference (em inglês) | O local pai. |
| valor | desconhecido | Valor opcional a ser gravado no local gerado. |
Retorna:
thenableReference (link em inglês)
Promise e Reference combinados; resolve quando a gravação é concluída, mas pode ser usado imediatamente como Reference no local filho.
função(caminho; ...)
orderByChild(caminho)
Cria um novo QueryConstraint que ordena pela chave filha especificada.
As consultas podem ser ordenadas apenas de chave em chave. Chamar orderByChild() várias vezes na mesma consulta é um erro.
As consultas do Firebase permitem que você ordene seus dados por qualquer chave filha imediatamente. No entanto, se você souber com antecedência quais serão seus índices, poderá defini-los pela regra .indexOn nas suas regras de segurança para melhorar o desempenho. Consulte a regra https://firebase.google.com/docs/database/security/indexing-data para mais informações.
Saiba mais sobre orderByChild() em Classificar dados.
Assinatura:
export declare function orderByChild(path: string): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| path | string | O caminho para ordenar. |
Retorna:
QueryConstraint (link em inglês)
função(consulta, ...)
get(consulta)
Recebe o resultado mais atualizado para esta consulta.
Assinatura:
export declare function get(query: Query): Promise<DataSnapshot>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
Retorna:
Promessa<DataSnapshot>
Um Promise que é resolvido para o DataSnapshot resultante se um valor está disponível ou será rejeitada se o cliente não conseguir retornar um valor (por exemplo, se o servidor estiver inacessível e não houver nada armazenado em cache).
off(consulta, eventType, callback)
Separa um callback previamente anexado ao listener on*() (onValue, onChildAdded) correspondente. Observação: essa não é a maneira recomendada de remover um listener. Em vez disso, use a função de callback retornada dos respectivos callbacks on*.
Desconecte um callback que antes era anexado a on*(). Chamar off() em um listener pai não removerá automaticamente os listeners registrados nos nós filhos. off() também precisa ser chamado nos listeners filhos para remover o callback.
Se um callback não for especificado, todos os callbacks do eventType especificado serão removidos. Da mesma forma, se nenhum eventType for especificado, todos os callbacks de Reference serão removidos.
Listeners individuais também podem ser removidos invocando seus callbacks de cancelamento de inscrição.
Assinatura:
export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta em que o listener foi registrado. |
| eventType | EventType | Uma das seguintes strings: "value", "child_added", "child_ changed", "child_ removed" ou "child_moved". Se omitido, todos os callbacks de Reference serão removidos. |
| callback | (snapshot: DataSnapshot, previousChildName?: string | nulo) => desconhecido | A função de callback que foi transmitida para on() ou undefined para remover todos os callbacks. |
Retorna:
void
onChildAdded(query, callback, cancelCallback)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildAdded será acionado uma vez para cada filho inicial nesse local e será acionado novamente sempre que um novo filho for adicionado. A DataSnapshot transmitida ao callback refletirá os dados do filho relevante. Para fins de ordenação, ele recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho.
Assinatura:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName?: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildAdded(consulta, callback, opções)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildAdded será acionado uma vez para cada filho inicial nesse local e será acionado novamente sempre que um novo filho for adicionado. A DataSnapshot transmitida ao callback refletirá os dados do filho relevante. Para fins de ordenação, ele recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho.
Assinatura:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildAdded(query, callback, cancelCallback, options)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildAdded será acionado uma vez para cada filho inicial nesse local e será acionado novamente sempre que um novo filho for adicionado. A DataSnapshot transmitida ao callback refletirá os dados do filho relevante. Para fins de ordenação, ele recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho.
Assinatura:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildChanged(query, callback, cancelCallback)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildChanged será acionado quando os dados armazenados em um filho (ou em qualquer um dos descendentes) mudarem. Um único evento child_changed pode representar várias mudanças no filho. O DataSnapshot transmitido ao callback terá o novo conteúdo filho. Para fins de ordenação, o callback também recebe um segundo argumento, que é uma string que contém a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho.
Assinatura:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildChanged(consulta, callback, opções)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildChanged será acionado quando os dados armazenados em um filho (ou em qualquer um dos descendentes) mudarem. Um único evento child_changed pode representar várias mudanças no filho. O DataSnapshot transmitido ao callback terá o novo conteúdo filho. Para fins de ordenação, o callback também recebe um segundo argumento, que é uma string que contém a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho.
Assinatura:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildChanged(query, callback, cancelCallback, options)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildChanged será acionado quando os dados armazenados em um filho (ou em qualquer um dos descendentes) mudarem. Um único evento child_changed pode representar várias mudanças no filho. O DataSnapshot transmitido ao callback terá o novo conteúdo filho. Para fins de ordenação, o callback também recebe um segundo argumento, que é uma string que contém a chave do filho irmão anterior por ordem de classificação, ou null se for o primeiro filho.
Assinatura:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildMove(consulta, callback, cancelCallback)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildMoved será acionado quando a ordem de classificação de um filho mudar de forma que a posição dele em relação aos irmãos mude. O DataSnapshot transmitido ao callback será para os dados do filho que foi movido. Ele também recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null, se ele for o primeiro filho.
Assinatura:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildMobile(consulta, retorno de chamada, opções)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildMoved será acionado quando a ordem de classificação de um filho mudar de forma que a posição dele em relação aos irmãos mude. O DataSnapshot transmitido ao callback será para os dados do filho que foi movido. Ele também recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null, se ele for o primeiro filho.
Assinatura:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildMoveed(consulta, callback, cancelCallback, opções)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildMoved será acionado quando a ordem de classificação de um filho mudar de forma que a posição dele em relação aos irmãos mude. O DataSnapshot transmitido ao callback será para os dados do filho que foi movido. Ele também recebe um segundo argumento, que é uma string contendo a chave do filho irmão anterior por ordem de classificação, ou null, se ele for o primeiro filho.
Assinatura:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot, previousChildName: string | nulo) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildRemoved(query, callback, cancelCallback)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildRemoved será acionado uma vez sempre que um filho for removido. O DataSnapshot transmitido ao callback serão os dados antigos do filho que foi removido. Um filho será removido quando:
- um cliente chama explicitamente
remove()nesse filho ou em um dos ancestrais dele; um cliente chamaset(null)nesse filho ou em um dos ancestrais dele; esse filho tem todos os filhos removidos. Agora, há uma consulta em vigor que agora filtra o filho, porque a ordem de classificação dele mudou ou o limite máximo foi atingido.
Assinatura:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildRemoved(consulta, retorno de chamada, opções)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildRemoved será acionado uma vez sempre que um filho for removido. O DataSnapshot transmitido ao callback serão os dados antigos do filho que foi removido. Um filho será removido quando:
- um cliente chama explicitamente
remove()nesse filho ou em um dos ancestrais dele; um cliente chamaset(null)nesse filho ou em um dos ancestrais dele; esse filho tem todos os filhos removidos. Agora, há uma consulta em vigor que agora filtra o filho, porque a ordem de classificação dele mudou ou o limite máximo foi atingido.
Assinatura:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onChildRemoved(query, callback, cancelCallback, options)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onChildRemoved será acionado uma vez sempre que um filho for removido. O DataSnapshot transmitido ao callback serão os dados antigos do filho que foi removido. Um filho será removido quando:
- um cliente chama explicitamente
remove()nesse filho ou em um dos ancestrais dele; um cliente chamaset(null)nesse filho ou em um dos ancestrais dele; esse filho tem todos os filhos removidos. Agora, há uma consulta em vigor que agora filtra o filho, porque a ordem de classificação dele mudou ou o limite máximo foi atingido.
Assinatura:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot e uma string que contém a chave do filho anterior, por ordem de classificação, ou null se for o primeiro filho. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onValue(query, callback, cancelCallback)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onValue será acionado uma vez com os dados iniciais armazenados nesse local e mais uma vez sempre que os dados forem alterados. O DataSnapshot transmitido ao callback será do local em que o on() foi chamado. Ele não será acionado até que todo o conteúdo seja sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio (val() retornará null).
Assinatura:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onValue(consulta, callback, opções)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onValue será acionado uma vez com os dados iniciais armazenados nesse local e mais uma vez sempre que os dados forem alterados. O DataSnapshot transmitido ao callback será do local em que o on() foi chamado. Ele não será acionado até que todo o conteúdo seja sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio (val() retornará null).
Assinatura:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
onValue(consulta, callback, cancelCallback, opções)
Detecta mudanças de dados em um local específico.
Essa é a principal maneira de ler dados de um banco de dados. Seu callback será acionado para os dados iniciais e novamente sempre que os dados forem alterados. Invoque o callback de cancelamento de inscrição retornado para parar de receber atualizações. Consulte Recuperar dados na Web para mais detalhes.
Um evento onValue será acionado uma vez com os dados iniciais armazenados nesse local e mais uma vez sempre que os dados forem alterados. O DataSnapshot transmitido ao callback será do local em que o on() foi chamado. Ele não será acionado até que todo o conteúdo seja sincronizado. Se o local não tiver dados, ele será acionado com um DataSnapshot vazio (val() retornará null).
Assinatura:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A consulta a ser executada. |
| callback | (snapshot: DataSnapshot) => desconhecido | Um callback acionado quando ocorre o evento especificado. O callback receberá um DataSnapshot. |
| cancelCallback | (erro: Erro) => desconhecido | Um retorno de chamada opcional que será notificado se a assinatura do evento for cancelada porque seu cliente não tem permissão para ler esses dados (ou teve permissão, mas agora os perdeu). Esse callback receberá um objeto Error indicando o motivo da falha. |
| options | ListenOptions (link em inglês) | Um objeto que pode ser usado para configurar onlyOnce, que remove o listener após a primeira invocação. |
Retorna:
Uma função que pode ser invocada para remover o listener.
query(query, queryConstraints)
Cria uma nova instância imutável de Query que é estendida para incluir outras restrições de consulta.
Assinatura:
export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| consulta | Consulta | A instância de Query a ser usada como base para as novas restrições. |
| queryConstraints | QueryConstraint[] | Lista de QueryConstraints a serem aplicadas. |
Retorna:
Exceções
se alguma das restrições de consulta fornecidas não puder ser combinada com as restrições atuais ou novas.
function(ref, ...)
onDesconectar(ref)
Retorna um objeto OnDisconnect. Consulte Como ativar recursos off-line no JavaScript para mais informações sobre como usá-los.
Assinatura:
export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ref | DatabaseReference (em inglês) | A referência para adicionar acionadores OnDesconectar. |
Retorna:
remover(ref)
Remove os dados neste local do banco de dados.
Todos os dados nos locais filhos também serão excluídos.
O efeito da remoção ficará visível imediatamente, e o evento correspondente "value" será acionado. A sincronização da remoção com os servidores do Firebase também será iniciada, e a promessa retornada será resolvida quando ela for concluída. Se fornecido, o callback onComplete será chamado de forma assíncrona após a conclusão da sincronização.
Assinatura:
export declare function remove(ref: DatabaseReference): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ref | DatabaseReference (em inglês) | O local a ser removido. |
Retorna:
Promessa<void>
Resolve quando a remoção no servidor é concluída.
runTransaction(ref, transactionUpdate, options)
Modifica atomicamente os dados neste local.
Modificar atomicamente os dados neste local. Ao contrário de um set() normal, que apenas substitui os dados independentemente do valor anterior, runTransaction() é usado para modificar o valor existente para um novo valor, garantindo que não haja conflitos com outros clientes gravando no mesmo local ao mesmo tempo.
Para fazer isso, transmita a runTransaction() uma função de atualização usada para transformar o valor atual em um novo. Se outro cliente fizer uma gravação no local antes que seu novo valor seja gravado com sucesso, sua função de atualização será chamada novamente com o novo valor atual e a gravação será repetida. Isso acontecerá repetidamente até que a gravação seja bem-sucedida sem conflitos ou que você cancele a transação sem retornar um valor da sua função de atualização.
Assinatura:
export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ref | DatabaseReference (em inglês) | O local a ser modificado atomicamente. |
| Atualização da transação | (currentData: qualquer) => desconhecido | Uma função fornecida pelo desenvolvedor que receberá os dados atuais armazenados neste local (como um objeto JavaScript). A função deve retornar o novo valor que gostaria que fosse escrito (como um objeto JavaScript). Se undefined for retornado (ou seja, você retornar sem argumentos), a transação será cancelada e os dados nesse local não serão modificados. |
| options | TransactionOptions | Um objeto de opções para configurar transações. |
Retorna:
Promessa<TransactionResult>
Um Promise que pode ser usado opcionalmente em vez do callback onComplete para lidar com sucessos e falhas.
set(ref; value)
Grava dados neste local do banco de dados.
Essa ação substituirá todos os dados neste local e em todos os locais filhos.
O efeito da gravação ficará visível imediatamente, e os eventos correspondentes ("value", "child_added" etc.) serão acionados. A sincronização dos dados com os servidores do Firebase também será iniciada, e a promessa retornada será resolvida quando ela for concluída. Se fornecido, o callback onComplete será chamado de forma assíncrona após a conclusão da sincronização.
Transmitir null para o novo valor é equivalente a chamar remove(). Ou seja, todos os dados neste local e todos os locais filhos serão excluídos.
set() vai remover qualquer prioridade armazenada nesse local. Portanto, se a prioridade precisar ser preservada, use setWithPriority().
A modificação de dados com set() vai cancelar todas as transações pendentes no local. Por isso, tenha cuidado ao combinar set() e transaction() para modificar os mesmos dados.
Uma única set() vai gerar um "valor" único evento no local em que set() foi realizado.
Assinatura:
export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ref | DatabaseReference (em inglês) | O local de gravação. |
| valor | desconhecido | O valor a ser gravado (string, número, booleano, objeto, matriz ou nulo). |
Retorna:
Promessa<void>
Resolve quando a gravação no servidor é concluída.
setPrioridade(ref, prioridade)
Define uma prioridade para os dados neste local do banco de dados.
Os aplicativos não precisam usar prioridade, mas podem ordenar as coleções por propriedades comuns. Consulte Como classificar e filtrar dados.
Assinatura:
export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ref | DatabaseReference (em inglês) | O local de gravação. |
| priority | string | número | nulo | A prioridade a ser gravada (string, número ou nulo). |
Retorna:
Promessa<void>
Resolve quando a gravação no servidor é concluída.
setWithPrioridade(ref, valor, prioridade)
Grava dados no local do banco de dados. Semelhante a set(), mas também especifica a prioridade desses dados.
Os aplicativos não precisam usar prioridade, mas podem ordenar as coleções por propriedades comuns. Consulte Como classificar e filtrar dados.
Assinatura:
export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ref | DatabaseReference (em inglês) | O local de gravação. |
| valor | desconhecido | O valor a ser gravado (string, número, booleano, objeto, matriz ou nulo). |
| priority | string | número | nulo | A prioridade a ser gravada (string, número ou nulo). |
Retorna:
Promessa<void>
Resolve quando a gravação no servidor é concluída.
update(ref, values)
Grava diversos valores no banco de dados de uma só vez.
O argumento values contém vários pares de propriedade-valor que serão gravados no banco de dados juntos. Cada propriedade filha pode ser uma propriedade simples (por exemplo, "nome") ou um caminho relativo (por exemplo, "nome/nome") do local atual para os dados a serem atualizados.
Ao contrário do método set(), o update() pode ser usado para atualizar seletivamente as propriedades referenciadas no local atual, em vez de substituir todas as propriedades filhas no local atual.
O efeito da gravação ficará visível imediatamente, e os eventos correspondentes ("value", "child_added" etc.) serão acionados. A sincronização dos dados com os servidores do Firebase também será iniciada, e a promessa retornada será resolvida quando ela for concluída. Se fornecido, o callback onComplete será chamado de forma assíncrona após a conclusão da sincronização.
Uma única update() vai gerar um "valor" único evento no local em que o update() foi realizado, independentemente de quantos filhos foram modificados.
A modificação de dados com update() vai cancelar todas as transações pendentes no local. Por isso, tenha cuidado ao combinar update() e transaction() para modificar os mesmos dados.
Transmitir null para update() removerá os dados neste local.
Consulte Apresentando atualizações em vários locais e muito mais.
Assinatura:
export declare function update(ref: DatabaseReference, values: object): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ref | DatabaseReference (em inglês) | O local de gravação. |
| values | objeto | Objeto que contém vários valores. |
Retorna:
Promessa<void>
Resolve quando a atualização no servidor é concluída.
função(valor; ...)
endAt(valor; chave)
Cria um QueryConstraint com o ponto final especificado.
O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para suas consultas.
O ponto final é inclusivo, ou seja, filhos com exatamente o valor especificado serão incluídos na consulta. O argumento de chave opcional pode ser usado para limitar ainda mais o intervalo da consulta. Se for especificado, os filhos que tiverem exatamente o valor especificado também precisarão ter um nome de chave menor ou igual à chave especificada.
Saiba mais sobre endAt() em Como filtrar dados.
Assinatura:
export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| valor | número | string | booleano | nulo | O valor de término. O tipo de argumento depende da função orderBy() usada nesta consulta. Especifique um valor que corresponda ao tipo orderBy(). Quando usado em combinação com orderByKey(), o valor precisa ser uma string. |
| chave | string | A chave filha a ser encerrada, entre os filhos com a prioridade especificada anteriormente. Esse argumento só é permitido ao ordenar por filho, valor ou prioridade. |
Retorna:
QueryConstraint (link em inglês)
endBefore(valor; chave)
Cria um QueryConstraint com o ponto final especificado (exclusivo).
O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para suas consultas.
O destino é exclusivo. Se apenas um valor for fornecido, filhos com um valor menor que o especificado serão incluídos na consulta. Se uma chave for especificada, os filhos precisarão ter um valor menor ou igual ao valor especificado e um nome de chave menor que a chave especificada.
Assinatura:
export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| valor | número | string | booleano | nulo | O valor que deve terminar antes. O tipo de argumento depende da função orderBy() usada nesta consulta. Especifique um valor que corresponda ao tipo orderBy(). Quando usado em combinação com orderByKey(), o valor precisa ser uma string. |
| chave | string | A chave filha para terminar antes, entre os filhos com a prioridade especificada anteriormente. Esse argumento só é permitido ao ordenar por filho, valor ou prioridade. |
Retorna:
QueryConstraint (link em inglês)
equalTo(valor, chave)
Cria um QueryConstraint que inclui filhos que correspondem ao valor especificado.
O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para suas consultas.
O argumento de chave opcional pode ser usado para limitar ainda mais o intervalo da consulta. Se for especificada, os filhos que tiverem exatamente o valor especificado também precisarão ter exatamente a chave especificada como nome de chave. Isso pode ser usado para filtrar conjuntos de resultados com muitas correspondências para o mesmo valor.
Saiba mais sobre equalTo() em Como filtrar dados.
Assinatura:
export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| valor | número | string | booleano | nulo | O valor a ser correspondido. O tipo de argumento depende da função orderBy() usada nesta consulta. Especifique um valor que corresponda ao tipo orderBy(). Quando usado em combinação com orderByKey(), o valor precisa ser uma string. |
| chave | string | Chave filha para começar, entre os filhos com a prioridade especificada anteriormente. Esse argumento só é permitido ao ordenar por filho, valor ou prioridade. |
Retorna:
QueryConstraint (link em inglês)
startAfter(valor; chave)
Cria uma QueryConstraint com o ponto de partida especificado (exclusivo).
O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para suas consultas.
O ponto de partida é exclusivo. Se apenas um valor for fornecido, filhos com um valor maior que o especificado serão incluídos na consulta. Se uma chave for especificada, os filhos precisarão ter um valor maior ou igual ao valor especificado e um nome de chave maior que a chave especificada.
Assinatura:
export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| valor | número | string | booleano | nulo | O valor a iniciar depois. O tipo de argumento depende da função orderBy() usada nesta consulta. Especifique um valor que corresponda ao tipo orderBy(). Quando usado em combinação com orderByKey(), o valor precisa ser uma string. |
| chave | string | A chave filha que será iniciada depois. Esse argumento só é permitido ao ordenar por filho, valor ou prioridade. |
Retorna:
QueryConstraint (link em inglês)
startAt(valor; chave)
Cria um QueryConstraint com o ponto de partida especificado.
O uso de startAt(), startAfter(), endBefore(), endAt() e equalTo() permite escolher pontos arbitrários de início e fim para suas consultas.
O ponto de partida é inclusivo, ou seja, filhos com exatamente o valor especificado serão incluídos na consulta. O argumento de chave opcional pode ser usado para limitar ainda mais o intervalo da consulta. Se for especificado, os filhos que tiverem exatamente o valor especificado também precisarão ter um nome de chave maior ou igual à chave especificada.
Saiba mais sobre startAt() em Como filtrar dados.
Assinatura:
export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| valor | número | string | booleano | nulo | Valor inicial. O tipo de argumento depende da função orderBy() usada nesta consulta. Especifique um valor que corresponda ao tipo orderBy(). Quando usado em combinação com orderByKey(), o valor precisa ser uma string. |
| chave | string | A chave filha a partir da qual começar. Esse argumento só é permitido ao ordenar por filho, valor ou prioridade. |
Retorna:
QueryConstraint (link em inglês)
EventType
Uma das seguintes strings: "value", "child_added", "child_ changed", "child_ removed" ou "child_moved".
Assinatura:
export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
QueryConstraintType
Descreve as diferentes restrições de consulta disponíveis neste SDK.
Assinatura:
export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
Cancelar inscrição
Um callback que pode ser invocado para remover um listener.
Assinatura:
export declare type Unsubscribe = () => void;