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 NodeJS
  4. Referência da API

Objeto fireSyncClient

Objeto fireSyncClient

  • initialize({ jwt, origin }) (Novo/Obrigatório)

    • Inicializa e configura o cliente. Deve ser chamado antes de connect().

    • Parâmetros:

      • config (Object): Objeto de configuração.

        • jwt (String): Token JWT para autenticação.

        • origin (String): Valor do cabeçalho Origin a ser enviado (deve ser permitido pelo servidor).

    • Retorna: void. Lança erro se já conectado/conectando ou se a config for inválida.

  • connect()

    • Inicia conexão e autenticação.

    • Retorna: Promise<void>.

  • disconnect()

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

    • Retorna: void.

  • goOffline() (Novo)

    • Fecha conexão manualmente, mas permite reconexão via goOnline() e mantém listeners para reativação. Previne reconexão automática.

    • Retorna: void.

  • goOnline() (Novo)

    • Tenta conectar manualmente se estiver disconnected ou error. Permite reconexão automática futura.

    • Retorna: Promise<void>.

  • getConnectionState()

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

  • isAuthenticated()

    • Retorna: boolean.

  • ref(pathString = '')

    • Obtém DatabaseReference para caminho relativo.

    • Retorna: DatabaseReference.

  • refFromPath(fullPath)

    • Obtém DatabaseReference para caminho absoluto.

    • Retorna: DatabaseReference.

  • on(eventName, callback) (Atualizado)

    • Registra callback para eventos públicos.

    • Eventos: 'state_changed', 'connecting', 'connected', 'authenticated', 'reconnecting', 'disconnected', 'error'.

    • Retorna: void.

  • off(eventName, callback) (Atualizado)

    • Remove callback registrado com on().

    • Retorna: void.

AnteriorReferência da APIPróximoClasse DatabaseReference

Atualizado há 1 mês