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

Objeto fireSyncClient

AnteriorReferência da APIPróximoClasse DatabaseReference

Atualizado há 1 mês

Objeto principal da biblioteca, geralmente acessado como window.fireSyncClient.

Objeto fireSyncClient

  • setAuthToken(token)

    • Define o token JWT a ser usado. Chamar antes de connect().

    • Parâmetros: token (String).

    • Retorna: void.

  • connect()

    • Inicia conexão e autenticação.

    • Retorna: Promise<void> (Resolve na autenticação, Rejeita na falha/timeout).

  • disconnect()

    • Fecha a conexão manualmente e previne reconexão automática.

    • Retorna: void.

  • getConnectionState()

    • Retorna o estado atual.

    • Retorna: 'disconnected' | 'connecting' | 'connected' | 'authenticating' | 'authenticated' | 'reconnecting' | 'error'.

  • isAuthenticated()

    • Verifica se está conectado e autenticado.

    • Retorna: boolean.

  • ref(pathString = '')

    • Obtém DatabaseReference para um caminho relativo ao basePath do JWT.

    • Parâmetros: pathString (String, Opcional).

    • Retorna: DatabaseReference.

  • refFromPath(fullPath)

    • (Avançado) Obtém DatabaseReference para um caminho absoluto.

    • Parâmetros: fullPath (String, deve começar com /).

    • Retorna: DatabaseReference.

  • on(eventName, callback)

    • Registra um callback para eventos públicos.

    • Parâmetros:

      • eventName ('state_changed' | 'disconnected' | 'error').

      • callback (Function): Recebe argumentos dependendo do evento (ver seção ).

    • Retorna: void.

  • off(eventName, callback)

    • Remove um callback específico registrado com on().

    • Parâmetros:

      • eventName ('state_changed' | 'disconnected' | 'error').

      • callback (Function): A função exata a ser removida.

    • Retorna: void.

Eventos Públicos