OnDisconnect class

Kelas onDisconnect memungkinkan Anda untuk menulis atau menghapus data ketika klien Anda terputus dari server Database. Pembaruan ini terjadi baik koneksi klien Anda terputus dengan baik atau tidak, sehingga Anda dapat mengandalkan pembaruan ini untuk membersihkan data bahkan jika koneksi terputus atau klien mengalami crash.

Kelas onDisconnect paling sering digunakan untuk mengelola kehadiran dalam aplikasi yang berguna untuk mendeteksi berapa banyak klien yang terhubung dan kapan klien lain terputus. Lihat Mengaktifkan Kemampuan Offline di JavaScript untuk informasi lebih lanjut.

Untuk menghindari masalah ketika koneksi terputus sebelum permintaan dapat ditransfer ke server Database, fungsi-fungsi ini harus dipanggil sebelum menulis data apa pun.

Perhatikan bahwa operasi onDisconnect hanya dipicu satu kali. Jika Anda ingin operasi terjadi setiap kali terjadi pemutusan sambungan, Anda harus menjalankan kembali operasi onDisconnect setiap kali Anda menyambung kembali.

Tanda tangan:

export declare class OnDisconnect 

Metode

Saat Terputus.batalkan()

Membatalkan semua peristiwa set atau pembaruan onDisconnect() yang diantrekan sebelumnya untuk lokasi ini dan semua turunannya.

Jika penulisan telah dimasukkan dalam antrean untuk lokasi ini melalui set() atau update() di lokasi induk, penulisan di lokasi ini akan dibatalkan, meskipun penulisan ke lokasi saudara akan tetap terjadi.

Tanda tangan:

cancel(): Promise<void>;

Pengembalian:

Janji<batal>

Terselesaikan ketika sinkronisasi ke server selesai.

Saat Putus.hapus()

Memastikan data di lokasi ini dihapus ketika klien terputus (karena penutupan browser, navigasi ke halaman baru, atau masalah jaringan).

Tanda tangan:

remove(): Promise<void>;

Pengembalian:

Janji<batal>

Terselesaikan ketika sinkronisasi ke server selesai.

Saat Terputus.set()

Memastikan data di lokasi ini disetel ke nilai yang ditentukan saat klien terputus (karena penutupan browser, navigasi ke halaman baru, atau masalah jaringan).

set() sangat berguna untuk menerapkan sistem "kehadiran", yang mana suatu nilai harus diubah atau dihapus ketika pengguna terputus sehingga terlihat "offline" oleh pengguna lain. Lihat Mengaktifkan Kemampuan Offline di JavaScript untuk informasi lebih lanjut.

Perhatikan bahwa operasi onDisconnect hanya dipicu satu kali. Jika Anda ingin operasi terjadi setiap kali terjadi pemutusan sambungan, Anda harus menjalankan kembali operasi onDisconnect setiap kali terjadi.

Tanda tangan:

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

Parameter

Pengembalian:

Janji<batal>

Terselesaikan ketika sinkronisasi ke Database selesai.

PadaDisconnect.setWithPriority()

Memastikan data di lokasi ini disetel ke nilai dan prioritas yang ditentukan saat klien terputus (karena penutupan browser, navigasi ke halaman baru, atau masalah jaringan).

Tanda tangan:

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

Parameter

Pengembalian:

Janji<batal>

Terselesaikan ketika sinkronisasi ke Database selesai.

Saat Terputus.perbarui()

Menulis beberapa nilai di lokasi ini ketika klien terputus (karena penutupan browser, navigasi ke halaman baru, atau masalah jaringan).

Argumen values berisi beberapa pasangan nilai properti yang akan ditulis ke Database bersama-sama. Setiap properti turunan dapat berupa properti sederhana (misalnya, "nama") atau jalur relatif (misalnya, "nama/depan") dari lokasi saat ini ke data yang akan diperbarui.

Berbeda dengan metode set() , update() dapat digunakan untuk memperbarui secara selektif hanya properti yang direferensikan di lokasi saat ini (alih-alih mengganti semua properti anak di lokasi saat ini).

Tanda tangan:

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

Parameter

Pengembalian:

Janji<batal>

Terselesaikan ketika sinkronisasi ke Database selesai.