OnDisconnect class

La clase onDisconnect le permite escribir o borrar datos cuando su cliente se desconecta del servidor de la base de datos. Estas actualizaciones ocurren independientemente de que su cliente se desconecte limpiamente o no, por lo que puede confiar en ellas para limpiar los datos incluso si se interrumpe una conexión o un cliente falla.

La clase onDisconnect se usa más comúnmente para administrar la presencia en aplicaciones donde es útil detectar cuántos clientes están conectados y cuándo otros clientes se desconectan. Consulte Habilitación de capacidades sin conexión en JavaScript para obtener más información.

Para evitar problemas cuando se interrumpe una conexión antes de que las solicitudes puedan transferirse al servidor de la base de datos, se deben llamar estas funciones antes de escribir cualquier dato.

Tenga en cuenta que las operaciones onDisconnect solo se activan una vez. Si desea que se realice una operación cada vez que se produce una desconexión, deberá restablecer las operaciones onDisconnect cada vez que se vuelva a conectar.

Firma:

export declare class OnDisconnect 

Métodos

OnDisconnect.cancelar()

Cancela todos los eventos de configuración o actualización onDisconnect() previamente en cola para esta ubicación y todos los niños.

Si se ha puesto en cola una escritura para esta ubicación a través de set() o update() en una ubicación principal, la escritura en esta ubicación se cancelará, aunque aún se producirán escrituras en ubicaciones hermanas.

Firma:

cancel(): Promise<void>;

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la sincronización con el servidor.

OnDisconnect.remove()

Garantiza que los datos en esta ubicación se eliminen cuando el cliente se desconecta (debido a cerrar el navegador, navegar a una nueva página o problemas de red).

Firma:

remove(): Promise<void>;

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la sincronización con el servidor.

OnDisconnect.set()

Garantiza que los datos en esta ubicación estén configurados en el valor especificado cuando el cliente se desconecta (debido al cierre del navegador, la navegación a una nueva página o problemas de red).

set() es especialmente útil para implementar sistemas de "presencia", donde un valor debe cambiarse o borrarse cuando un usuario se desconecta para que aparezca "fuera de línea" para otros usuarios. Consulte Habilitación de capacidades sin conexión en JavaScript para obtener más información.

Tenga en cuenta que las operaciones onDisconnect solo se activan una vez. Si desea que se realice una operación cada vez que se produce una desconexión, deberá restablecer las operaciones onDisconnect cada vez.

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la sincronización con la base de datos.

OnDisconnect.setWithPriority()

Garantiza que los datos en esta ubicación estén configurados con el valor y la prioridad especificados cuando el cliente se desconecta (debido al cierre del navegador, la navegación a una nueva página o problemas de red).

Firma:

setWithPriority(value: unknown, priority: number | string | null): Promise<void>;

Parámetros

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la sincronización con la base de datos.

OnDisconnect.actualización()

Escribe varios valores en esta ubicación cuando el cliente está desconectado (debido al cierre del navegador, la navegación a una nueva página o problemas de red).

El argumento values contiene varios pares de 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/primero") desde la ubicación actual hasta los datos que se van a actualizar.

A diferencia del método set() , update() se puede utilizar para actualizar selectivamente 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

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la sincronización con la base de datos.