FireSync
  • Documentação
  • FireSync.APP
    • Bancos de Dados
      • Criação
        • Autorização de IP's
      • Edição
    • Menus
      • Criação
      • Edição
        • Busca Avançada
        • Header
        • Vinculos
    • Dashboards
    • Conta FireSync
      • Integrações
      • Usuários
      • Permissões
  • Serviços
    • Connector
      • NodeJS Modulo
      • Criação de Conector
      • Edição / Acesso
      • API
    • DBRealTime
      • Cliente Javascript
        • Introdução
        • Versão Atual
        • Instalação / Configuração
        • Conceitos Fundamentais
          • Conexão e Autenticação
          • Referência do Banco de Dados (DatabaseReference)
          • Caminhos (path vs relativePath)
          • Snapshot de Dados (DataSnapshot)
          • Chaves Inválidas
        • Guia Rápido / Uso Básico
        • Referência da API
          • Objeto fireSyncClient
          • Classe DatabaseReference
          • Classe DataSnapshot
        • Listeners em Tempo Real (onValue, off)
        • Eventos Públicos (on, off)
        • Tratamento de Erros
        • Exemplo Completo
      • Cliente NodeJS
        • Introdução
        • Instalação
        • Conceitos Fundamentais
          • Inicialização e Configuração
          • Cabeçalho Origin (Obrigatório)
          • Conexão, Estado e Reconexão
          • Autenticação (TOKEN)
          • Referência (DatabaseReference) e Caminhos
          • Snapshot de Dados (DataSnapshot)
          • IDs de Requisição (Uso Interno)
          • Chaves Inválidas
        • Guia Rápido / Uso Básico
        • Referência da API
          • Objeto fireSyncClient
          • Classe DatabaseReference
          • Classe DataSnapshot
        • Listeners em Tempo Real (onValue, off)
        • Eventos Públicos (on, off)
        • Tratamento de Erros
  • FireSync.Tools
    • FireSync Tools
    • XmlToJson
    • QRCode
    • Date
    • PIX
      • QRPIX
      • PIX
  • API Integrações
    • Integrações
    • Entry
    • Query
Fornecido por GitBook
Nesta página
  1. Serviços
  2. DBRealTime
  3. Cliente Javascript
  4. Referência da API

Classe DatabaseReference

Representa um local específico no banco de dados. Obtido via fireSyncClient.ref() ou ref.child().

  • key (Propriedade)

    • Retorna: String | null - O último componente (nome) do caminho desta referência, ou null se for a referência raiz (basePath).

  • path (Propriedade)

    • Retorna: String - O caminho absoluto completo desta referência no servidor.

    • key (Propriedade): String | null - Última parte do caminho.

    • path (Propriedade): String - Caminho absoluto completo.

    • relativePath (Propriedade): String - Caminho relativo ao basePath.

    • child(pathString)

      • Cria referência para um caminho filho.

      • Parâmetros: pathString (String).

      • Retorna: DatabaseReference.

    • set(value)

      • Escreve/sobrescreve dados. set(null) remove dados.

      • Parâmetros: value (any - serializável JSON, undefined não permitido).

      • Retorna: Promise<void> (Resolve no envio/fila).

    • get()

      • Lê dados uma vez.

      • Retorna: Promise<DataSnapshot>.

    • update(values)

      • Atualiza filhos diretos sem sobrescrever outros. Chaves com valor null são removidas.

      • Parâmetros: values (Object - não nulo, não array). Valida chaves contra caracteres inválidos (/ . $ [ ] #).

      • Retorna: Promise<void> (Resolve no envio/fila, Rejeita se validação de chave falhar).

    • remove()

      • Remove dados neste local (envia ação delete ao servidor).

      • Retorna: Promise<void> (Resolve no envio/fila).

    • push(value?)

      • Cria um filho com ID único

      • Parâmetros: value (any, Opcional) - Valor a ser escrito no novo filho.

      • Retorna:

        • Se value fornecido: Promise<DatabaseReference> (Resolve com a ref do novo filho após envio do set).

        • Se value omitido: DatabaseReference (Retorna a ref do novo filho imediatamente).

    • onValue(callback, cancelCallback?)

      • Escuta por dados em tempo real.

      • Parâmetros: callback (Function (snapshot: DataSnapshot) => void), cancelCallback (Function (error: Error) => void, Opcional).

      • Retorna: Function (Função unsubscribe).

    • off(callback?)

      • Cancela listeners onValue.

      • Parâmetros: callback (Function, Opcional - se omitido, remove todos no path).

      • Retorna: void.

AnteriorObjeto fireSyncClientPróximoClasse DataSnapshot

Atualizado há 1 mês