Objeto fireSyncClient
Objeto principal da biblioteca, geralmente acessado como window.fireSyncClient
.
Objeto fireSyncClient
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 aobasePath
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 Eventos Públicos).
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
.
Atualizado