OnDisconnect class

A classe onDisconnect permite gravar ou limpar dados quando seu cliente se desconecta do servidor de banco de dados. Essas atualizações ocorrem independentemente de seu cliente se desconectar corretamente ou não, portanto, você pode contar com elas para limpar os dados mesmo que uma conexão seja interrompida ou um cliente falhe.

A classe onDisconnect é mais comumente usada para gerenciar a presença em aplicativos em que é útil detectar quantos clientes estão conectados e quando outros clientes se desconectam. Consulte Habilitando recursos offline em JavaScript para obter mais informações.

Para evitar problemas quando uma conexão é interrompida antes que as solicitações possam ser transferidas para o servidor de banco de dados, essas funções devem ser chamadas antes de gravar qualquer dado.

Observe que as operações onDisconnect são acionadas apenas uma vez. Se desejar que uma operação ocorra sempre que ocorrer uma desconexão, você precisará restabelecer as operações onDisconnect sempre que se reconectar.

Assinatura:

export declare class OnDisconnect 

Métodos

Método	Modificadores	Descrição
cancelar()		Cancela todos os eventos de configuração ou atualização onDisconnect() enfileirados anteriormente para este local e todos os filhos. Se uma gravação foi enfileirada para este local por meio de um set() ou update() em um local pai, a gravação nesse local será cancelada, embora as gravações em locais irmãos ainda ocorram.
remover()		Garante que os dados neste local sejam excluídos quando o cliente for desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede).
set(valor)		Garante que os dados neste local sejam definidos para o valor especificado quando o cliente for desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede). set() é especialmente útil para implementar sistemas de "presença", onde um valor deve ser alterado ou apagado quando um usuário se desconecta para que eles apareçam "offline" para outros usuários. Consulte Habilitando recursos offline em JavaScript para obter mais informações. Observe que 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 a cada vez.
setWithPriority(valor, prioridade)		Garante que os dados neste local sejam definidos com o valor e a prioridade especificados quando o cliente for desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede).
atualização (valores)		Grava vários valores neste local quando o cliente é desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede). O argumento de values contém vários pares de valor de propriedade 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/primeiro") do local atual para 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).

OnDisconnect.cancel()

Cancela todos os eventos de configuração ou atualização onDisconnect() enfileirados anteriormente para este local e todos os filhos.

Se uma gravação foi enfileirada para este local por meio de um 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>;

Devoluções:

Promessa<void>

Resolve quando a sincronização com o servidor é concluída.

OnDisconnect.remove()

Garante que os dados neste local sejam excluídos quando o cliente for desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede).

Assinatura:

remove(): Promise<void>;

Devoluções:

Promessa<void>

Resolve quando a sincronização com o servidor é concluída.

OnDisconnect.set()

Garante que os dados neste local sejam definidos para o valor especificado quando o cliente for desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede).

set() é especialmente útil para implementar sistemas de "presença", onde um valor deve ser alterado ou apagado quando um usuário se desconecta para que eles apareçam "offline" para outros usuários. Consulte Habilitando recursos offline em JavaScript para obter mais informações.

Observe que 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 a cada vez.

Assinatura:

set(value: unknown): Promise<void>;

Parâmetros

Parâmetro	Modelo	Descrição
valor	desconhecido	O valor a ser gravado neste local na desconexão (pode ser um objeto, matriz, string, número, booleano ou nulo).

Devoluções:

Promessa<void>

Resolve quando a sincronização com o banco de dados é concluída.

OnDisconnect.setWithPriority()

Garante que os dados neste local sejam definidos com o valor e a prioridade especificados quando o cliente for 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	Modelo	Descrição
valor	desconhecido	O valor a ser gravado neste local na desconexão (pode ser um objeto, matriz, string, número, booleano ou nulo).
prioridade	número | seqüência | nulo	A prioridade a ser gravada (string, número ou nulo).

Devoluções:

Promessa<void>

Resolve quando a sincronização com o banco de dados é concluída.

OnDisconnect.update()

Grava vários valores neste local quando o cliente é desconectado (devido ao fechamento do navegador, navegação para uma nova página ou problemas de rede).

O argumento de values contém vários pares de valor de propriedade 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/primeiro") do local atual para 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).

Assinatura:

update(values: object): Promise<void>;

Parâmetros

Parâmetro	Modelo	Descrição
valores	objeto	Objeto que contém vários valores.

Devoluções:

Promessa<void>

Resolve quando a sincronização com o banco de dados é concluída.