La classe onDisconnect vous permet d'écrire ou d'effacer des données lorsque votre client se déconnecte du serveur de base de données. Ces mises à jour se produisent que votre client se déconnecte proprement ou non, vous pouvez donc compter sur elles pour nettoyer les données même si une connexion est interrompue ou si un client plante.
La classe onDisconnect est le plus souvent utilisée pour gérer la présence dans les applications où il est utile de détecter le nombre de clients connectés et le moment où d'autres clients se déconnectent. Voir Activation des fonctionnalités hors ligne dans JavaScript pour plus d'informations.
Pour éviter les problèmes lorsqu'une connexion est interrompue avant que les requêtes puissent être transférées au serveur de base de données, ces fonctions doivent être appelées avant d'écrire des données.
Notez que les opérations onDisconnect ne sont déclenchées qu’une seule fois. Si vous souhaitez qu'une opération se produise à chaque fois qu'une déconnexion se produit, vous devrez rétablir les opérations onDisconnect à chaque fois que vous vous reconnecterez.
Signature:
export declare class OnDisconnect
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| Annuler() | Annule tous les événements de définition ou de mise à jour onDisconnect() précédemment mis en file d'attente pour cet emplacement et tous les enfants. Si une écriture a été mise en file d'attente pour cet emplacement via un set() ou update() à un emplacement parent, l'écriture à cet emplacement sera annulée, bien que les écritures vers des emplacements frères se produiront toujours. | |
| retirer() | Garantit que les données à cet emplacement sont supprimées lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau). | |
| définir (valeur) | Garantit que les données à cet emplacement sont définies sur la valeur spécifiée lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau). set() est particulièrement utile pour implémenter des systèmes de « présence », dans lesquels une valeur doit être modifiée ou effacée lorsqu'un utilisateur se déconnecte afin qu'il apparaisse « hors ligne » pour les autres utilisateurs. Voir Activation des fonctionnalités hors ligne dans JavaScript pour plus d'informations. Notez que les opérations onDisconnect ne sont déclenchées qu’une seule fois. Si vous souhaitez qu'une opération se produise à chaque fois qu'une déconnexion se produit, vous devrez rétablir les opérations onDisconnect à chaque fois. | |
| setWithPriority (valeur, priorité) | Garantit que les données à cet emplacement sont définies sur la valeur et la priorité spécifiées lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau). | |
| mise à jour (valeurs) | Écrit plusieurs valeurs à cet emplacement lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau). L’argument values contient plusieurs paires propriété-valeur qui seront écrites ensemble dans la base de données. Chaque propriété enfant peut être une propriété simple (par exemple, « nom ») ou un chemin relatif (par exemple, « nom/prénom ») depuis l'emplacement actuel vers les données à mettre à jour. Contrairement à la méthode set() , update() peut être utilisée pour mettre à jour de manière sélective uniquement les propriétés référencées à l'emplacement actuel (au lieu de remplacer toutes les propriétés enfants à l'emplacement actuel). |
OnDisconnect.cancel()
Annule tous les événements de définition ou de mise à jour onDisconnect() précédemment mis en file d'attente pour cet emplacement et tous les enfants.
Si une écriture a été mise en file d'attente pour cet emplacement via un set() ou update() à un emplacement parent, l'écriture à cet emplacement sera annulée, bien que les écritures vers des emplacements frères se produiront toujours.
Signature:
cancel(): Promise<void>;
Retour:
Promesse<vide>
Résout lorsque la synchronisation avec le serveur est terminée.
OnDisconnect.remove()
Garantit que les données à cet emplacement sont supprimées lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau).
Signature:
remove(): Promise<void>;
Retour:
Promesse<vide>
Résout lorsque la synchronisation avec le serveur est terminée.
OnDisconnect.set()
Garantit que les données à cet emplacement sont définies sur la valeur spécifiée lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau).
set() est particulièrement utile pour implémenter des systèmes de « présence », dans lesquels une valeur doit être modifiée ou effacée lorsqu'un utilisateur se déconnecte afin qu'il apparaisse « hors ligne » pour les autres utilisateurs. Voir Activation des fonctionnalités hors ligne dans JavaScript pour plus d'informations.
Notez que les opérations onDisconnect ne sont déclenchées qu’une seule fois. Si vous souhaitez qu'une opération se produise à chaque fois qu'une déconnexion se produit, vous devrez rétablir les opérations onDisconnect à chaque fois.
Signature:
set(value: unknown): Promise<void>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| valeur | inconnu | La valeur à écrire à cet emplacement lors de la déconnexion (peut être un objet, un tableau, une chaîne, un nombre, un booléen ou une valeur nulle). |
Retour:
Promesse<vide>
Résout lorsque la synchronisation avec la base de données est terminée.
OnDisconnect.setWithPriority()
Garantit que les données à cet emplacement sont définies sur la valeur et la priorité spécifiées lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau).
Signature:
setWithPriority(value: unknown, priority: number | string | null): Promise<void>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| valeur | inconnu | La valeur à écrire à cet emplacement lors de la déconnexion (peut être un objet, un tableau, une chaîne, un nombre, un booléen ou une valeur nulle). |
| priorité | numéro | chaîne | nul | La priorité à écrire (chaîne, nombre ou null). |
Retour:
Promesse<vide>
Résout lorsque la synchronisation avec la base de données est terminée.
OnDisconnect.update()
Écrit plusieurs valeurs à cet emplacement lorsque le client est déconnecté (en raison de la fermeture du navigateur, de la navigation vers une nouvelle page ou de problèmes de réseau).
L’argument values contient plusieurs paires propriété-valeur qui seront écrites ensemble dans la base de données. Chaque propriété enfant peut être soit une propriété simple (par exemple, « nom »), soit un chemin relatif (par exemple, « nom/prénom ») depuis l'emplacement actuel vers les données à mettre à jour.
Contrairement à la méthode set() , update() peut être utilisée pour mettre à jour de manière sélective uniquement les propriétés référencées à l'emplacement actuel (au lieu de remplacer toutes les propriétés enfants à l'emplacement actuel).
Signature:
update(values: object): Promise<void>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| valeurs | objet | Objet contenant plusieurs valeurs. |
Retour:
Promesse<vide>
Résout lorsque la synchronisation avec la base de données est terminée.