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 se desconectam. Consulte Como ativar recursos off-line no JavaScript para mais informações.
Para evitar problemas quando uma conexão é descartada antes que as solicitações possam ser transferidas para o servidor do Database, essas funções devem ser chamadas antes de gravar qualquer dado.
As operações onDisconnect são acionadas somente 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.
Assinatura:
export declare class OnDisconnect
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| cancel() (link em inglês). | Cancela todos os eventos onDisconnect() definidos ou de atualização na fila anteriormente para este local e todos os filhos.Se uma gravação tiver sido colocada na fila para esse local por meio de set() ou update() em um local pai, a gravação neste local será cancelada, embora as gravações em locais irmãos ainda ocorram. |
|
| remove() (em inglês) | Garante que os dados no local sejam excluídos quando o cliente for desconectado (devido a fechamento do navegador, navegação para uma nova página ou problemas de rede). | |
| set(value) | Garante que os dados no local estejam definidos com o valor especificado quando o cliente estiver desconectado (devido a fechamento do navegador, navegação para uma nova página ou problemas de rede).O set() é especialmente útil para implementar a "presença" sistemas, em que um valor deve ser alterado ou apagado quando um usuário se desconecta para que ele apareça como "off-line". para outros usuários. Consulte Como ativar recursos off-line no JavaScript para mais informações.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 todas as vezes. |
|
| setWithPrioridade(valor, prioridade) | Garante que os dados neste local estejam definidos com o valor e a prioridade especificados quando o cliente estiver desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede). | |
| update(values) | Grava vários valores nesse local quando o cliente está desconectado (devido a fechamento do navegador, navegação para uma nova página ou problemas de rede).O argumento values contém vários pares de propriedade e 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 até 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. |
OnDesconectar.cancel()
Cancela todos os eventos definidos ou de atualização de onDisconnect() colocados na fila anteriormente para esse local e todos os filhos.
Se uma gravação tiver sido colocada na fila para esse local por meio de set() ou update() em um local pai, a gravação nesse local será cancelada, embora as gravações em locais irmãos ainda ocorram.
Assinatura:
cancel(): Promise<void>;
Retorna:
Promessa<void>
Resolve quando a sincronização com o servidor é concluída.
OnDesconectar.remove()
Garante que os dados no local sejam excluídos quando o cliente for desconectado (devido a fechamento do navegador, navegação para uma nova página ou problemas de rede).
Assinatura:
remove(): Promise<void>;
Retorna:
Promessa<void>
Resolve quando a sincronização com o servidor é concluída.
OnDesconectar.set()
Garante que os dados no local estejam definidos com o valor especificado quando o cliente estiver desconectado (devido a fechamento do navegador, navegação para uma nova página ou problemas de rede).
A set() é especialmente útil para implementar a "presença" sistemas, em que um valor deve ser alterado ou apagado quando um usuário se desconecta para que ele apareça como "off-line". para outros usuários. Consulte Como ativar recursos off-line no JavaScript para mais informações.
As operações onDisconnect são acionadas somente uma vez. Se você quiser que uma operação ocorra sempre que ocorrer uma desconexão, será necessário restabelecer as operações onDisconnect todas as vezes.
Assinatura:
set(value: unknown): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| valor | desconhecido | O valor a ser gravado nesse local após a desconexão (pode ser um objeto, uma matriz, uma string, um número, um booleano ou um nulo). |
Retorna:
Promessa<void>
Resolvida quando a sincronização com o banco de dados é concluída.
OnDesconectar.setWithPrioridade()
Garante que os dados neste local estejam definidos com o valor e a prioridade especificados quando o cliente estiver desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede).
Assinatura:
setWithPriority(value: unknown, priority: number | string | null): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| valor | desconhecido | O valor a ser gravado nesse local após a desconexão (pode ser um objeto, uma matriz, uma string, um número, um booleano ou um nulo). |
| priority | número | string | nulo | A prioridade a ser gravada (string, número ou nulo). |
Retorna:
Promessa<void>
Resolvida quando a sincronização com o banco de dados é concluída.
OnDesconectar.update()
Grava diversos valores neste local quando o cliente está desconectado (devido a fechamento do navegador, navegação para uma nova página ou problemas de rede).
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.
Assinatura:
update(values: object): Promise<void>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| values | objeto | Objeto que contém vários valores. |
Retorna:
Promessa<void>
Resolvida quando a sincronização com o banco de dados é concluída.