La clase onDisconnect te permite escribir o borrar datos cuando el cliente se desconecta del servidor de la base de datos. Estas actualizaciones ocurren sin importar si tu cliente se desconecta de manera limpia o no, de modo que puedes confiar en ellas y limpiar los datos, incluso si se pierde la conexión o un cliente falla.
La clase onDisconnect se usa con mayor frecuencia para administrar la presencia en aplicaciones en las que es útil detectar cuántos clientes están conectados y cuándo se desconectan otros clientes. Consulta Habilita capacidades sin conexión en JavaScript para obtener más información.
Para evitar problemas cuando se pierde una conexión antes de que las solicitudes se puedan transferir al servidor de la base de datos, se debe llamar a estas funciones antes de escribir datos.
Ten en cuenta que las operaciones onDisconnect solo se activan una vez. Si quieres que se ejecute una operación cada vez que se produzca una desconexión, deberás restablecer las operaciones de onDisconnect cada vez que te vuelvas a conectar.
Firma:
export declare class OnDisconnect
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| cancel(). | Cancela todos los eventos configurados o de actualización de onDisconnect() que estaban en cola anteriormente para esta ubicación y todos los elementos secundarios.Si una operación de escritura se puso en cola para esta ubicación a través de set() o update() en una ubicación principal, la operación de escritura en esta ubicación se cancelará, aunque se seguirán realizando escrituras en ubicaciones del mismo nivel. |
|
| remove() | Garantiza que se borren los datos de esta ubicación cuando se desconecte el cliente (debido a que se cierra el navegador, navega a una página nueva o hay problemas de red). | |
| set(valor) | Garantiza que los datos de esta ubicación se establezcan en el valor especificado cuando se desconecta el cliente (debido a que se cierra el navegador, navega a una página nueva o hay problemas con la red). set() es especialmente útil para implementar la "presencia". sistemas, en los que se debe cambiar o borrar un valor cuando un usuario se desconecta para que aparezca como "sin conexión" a otros usuarios. Consulta Habilita capacidades sin conexión en JavaScript para obtener más información.Ten en cuenta que las operaciones onDisconnect solo se activan una vez. Si deseas que se produzca una operación cada vez que se produzca una desconexión, deberás restablecer las operaciones de onDisconnect cada vez. |
|
| setWithPriority(valor, prioridad) | Garantiza que los datos de esta ubicación se establezcan en el valor y la prioridad especificados cuando el cliente se desconecta (debido a que se cierra el navegador, navega a una página nueva o hay problemas de red). | |
| update(valores) | Escribe varios valores en esta ubicación cuando el cliente se desconecta (debido a que se cierra el navegador, navega a una página nueva o hay problemas de red).El argumento values contiene varios pares propiedad-valor que se escribirán juntos en la base de datos. Cada propiedad secundaria puede ser una propiedad simple (por ejemplo, "nombre") o una ruta relativa (por ejemplo, "nombre/nombre") de la ubicación actual a los datos que se actualizarán.A diferencia del método set(), se puede usar update() para actualizar de manera selectiva solo las propiedades a las que se hace referencia en la ubicación actual (en lugar de reemplazar todas las propiedades secundarias en la ubicación actual). |
OnDisconnect.cancel()
Cancela todos los eventos configurados o de actualización de onDisconnect() que estaban en cola anteriormente para esta ubicación y todos los elementos secundarios.
Si una operación de escritura se puso en cola para esta ubicación a través de set() o update() en una ubicación superior, la operación de escritura en esta ubicación se cancelará, aunque se seguirán realizando escrituras en ubicaciones del mismo nivel.
Firma:
cancel(): Promise<void>;
Muestra:
Promesa<void>
Se resuelve cuando finaliza la sincronización con el servidor.
OnDisconnect.remove()
Garantiza que se borren los datos de esta ubicación cuando se desconecte el cliente (debido a que se cierra el navegador, navega a una página nueva o hay problemas de red).
Firma:
remove(): Promise<void>;
Muestra:
Promesa<void>
Se resuelve cuando finaliza la sincronización con el servidor.
OnDisconnect.set()
Garantiza que los datos de esta ubicación se establezcan en el valor especificado cuando se desconecta el cliente (debido a que se cierra el navegador, se navega a una página nueva o se producen problemas de red).
set() es especialmente útil para implementar la “presencia” sistemas, en los que se debe cambiar o borrar un valor cuando un usuario se desconecta para que aparezca como "sin conexión" a otros usuarios. Consulta Habilita capacidades sin conexión en JavaScript para obtener más información.
Ten en cuenta que las operaciones onDisconnect solo se activan una vez. Si deseas que se produzca una operación cada vez que se produzca una desconexión, deberás restablecer las operaciones de onDisconnect cada vez.
Firma:
set(value: unknown): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| valor | desconocido | El valor que se escribirá en esta ubicación durante la desconexión (puede ser un objeto, un array, una cadena, un número, un valor booleano o un valor nulo). |
Muestra:
Promesa<void>
Se resuelve cuando se completa la sincronización con la base de datos.
OnDisconnect.setWithPriority()
Garantiza que los datos de esta ubicación se establezcan en el valor y la prioridad especificados cuando el cliente se desconecta (debido a que se cierra el navegador, navega a una página nueva o hay problemas de red).
Firma:
setWithPriority(value: unknown, priority: number | string | null): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| valor | desconocido | El valor que se escribirá en esta ubicación durante la desconexión (puede ser un objeto, un array, una cadena, un número, un valor booleano o un valor nulo). |
| priority | número | cadena | nulo | La prioridad que se escribirá (cadena, número o nulo). |
Muestra:
Promesa<void>
Se resuelve cuando se completa la sincronización con la base de datos.
OnDisconnect.update()
Escribe varios valores en esta ubicación cuando el cliente se desconecta (debido a cerrar el navegador, navegar a una página nueva o problemas de red).
El argumento values contiene varios pares propiedad-valor que se escribirán juntos en la base de datos. Cada propiedad secundaria puede ser una propiedad simple (por ejemplo, "nombre") o una ruta de acceso relativa (por ejemplo, "nombre/primera") desde la ubicación actual hasta los datos que se actualizarán.
A diferencia del método set(), se puede usar update() para actualizar de forma selectiva solo las propiedades a las que se hace referencia en la ubicación actual (en lugar de reemplazar todas las propiedades secundarias en la ubicación actual).
Firma:
update(values: object): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| valores | objeto | Objeto que contiene varios valores |
Muestra:
Promesa<void>
Se resuelve cuando se completa la sincronización con la base de datos.