firestore namespace

Functions

Fungsi	Deskripsi
onDocumentCreated(dokumen, pengendali)	Pengendali peristiwa yang terpicu saat dokumen dibuat di Firestore.
onDocumentCreated(opt, handler)	Pengendali peristiwa yang terpicu saat dokumen dibuat di Firestore.
onDocumentDeleted(dokumen, pengendali)	Pengendali peristiwa yang terpicu saat dokumen dihapus di Firestore.
onDocumentDeleted(memilih, pengendali)	Pengendali peristiwa yang terpicu saat dokumen dihapus di Firestore.
onDocumentUpdated(dokumen, pengendali)	Pengendali peristiwa yang terpicu saat dokumen diperbarui di Firestore.
onDocumentUpdated(opt, pengendali)	Pengendali peristiwa yang terpicu saat dokumen diperbarui di Firestore.
onDocumentWritten(dokumen, pengendali)	Pengendali peristiwa yang terpicu saat dokumen dibuat, diperbarui, atau dihapus di Firestore.
onDocumentWritten(opsi, pengendali)	Pengendali peristiwa yang terpicu saat dokumen dibuat, diperbarui, atau dihapus di Firestore.

Kelas

Class	Deskripsi
Ubah	Antarmuka Cloud Functions untuk peristiwa yang mengubah status, seperti peristiwa onWrite dan onUpdate Realtime Database atau Cloud Firestore.Untuk mengetahui informasi selengkapnya tentang format yang digunakan untuk membuat objek Change, lihat di bawah.

Antarmuka

Antarmuka	Deskripsi
DocumentOptions	DocumentOptions memperluas EventHandlerOptions dengan dokumen yang disediakan serta database dan namespace opsional.
AcaraFirestore	CloudEvent yang berisi DocumentSnapshot atau Perubahan

Ketik Alias

Ketik Alias	Deskripsi
DocumentSnapshot	DocumentSnapshot Firestore
QueryDocumentSnapshot	QueryDocumentSnapshot Firestore

firestore.onDocumentCreated()

Pengendali peristiwa yang terpicu saat dokumen dibuat di Firestore.

Tanda Tangan:

export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
dokumen	Dokumen	Jalur dokumen Firestore yang akan dipicu.
handler	(peristiwa: FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali pembuatan Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>>

firestore.onDocumentCreated()

Pengendali peristiwa yang terpicu saat dokumen dibuat di Firestore.

Tanda Tangan:

export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
memilih	DocumentOptions<Dokumen>	Opsi yang dapat ditetapkan pada fungsi penanganan peristiwa individual.
handler	(peristiwa: FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali pembuatan Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>>

firestore.onDocumentDeleted()

Pengendali peristiwa yang terpicu saat dokumen dihapus di Firestore.

Tanda Tangan:

export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
dokumen	Dokumen	Jalur dokumen Firestore yang akan dipicu.
handler	(peristiwa: FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali penghapusan Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>>

firestore.onDocumentDeleted()

Pengendali peristiwa yang terpicu saat dokumen dihapus di Firestore.

Tanda Tangan:

export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
memilih	DocumentOptions<Dokumen>	Opsi yang dapat ditetapkan pada fungsi penanganan peristiwa individual.
handler	(peristiwa: FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali penghapusan Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | belum ditentukan, ParamsOf<Document>>>

firestore.onDocumentUpdated()

Pengendali peristiwa yang terpicu saat dokumen diperbarui di Firestore.

Tanda Tangan:

export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
dokumen	Dokumen	Jalur dokumen Firestore yang akan dipicu.
handler	(peristiwa: FirestoreEvent<Change<QueryDocumentSnapshot> | tidak ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali update Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<Ubah<QueryDocumentSnapshot> | tidak ditentukan, ParamsOf<Document>>>

firestore.onDocumentUpdated()

Pengendali peristiwa yang terpicu saat dokumen diperbarui di Firestore.

Tanda Tangan:

export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
memilih	DocumentOptions<Dokumen>	Opsi yang dapat ditetapkan pada fungsi penanganan peristiwa individual.
handler	(peristiwa: FirestoreEvent<Change<QueryDocumentSnapshot> | tidak ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali update Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<Ubah<QueryDocumentSnapshot> | tidak ditentukan, ParamsOf<Document>>>

firestore.onDocumentWritten()

Pengendali peristiwa yang terpicu saat dokumen dibuat, diperbarui, atau dihapus di Firestore.

Tanda Tangan:

export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
dokumen	Dokumen	Jalur dokumen Firestore yang akan dipicu.
handler	(peristiwa: FirestoreEvent<Change<DocumentSnapshot> | belum ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali pembuatan, pembaruan, atau penghapusan Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<Ubah<DocumentSnapshot> | tidak ditentukan, ParamsOf<Document>>>

firestore.onDocumentWritten()

Pengendali peristiwa yang terpicu saat dokumen dibuat, diperbarui, atau dihapus di Firestore.

Tanda Tangan:

export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

Parameter

Parameter	Jenis	Deskripsi
memilih	DocumentOptions<Dokumen>	Opsi yang dapat ditetapkan pada fungsi penanganan peristiwa individual.
handler	(peristiwa: FirestoreEvent<Change<DocumentSnapshot> | belum ditentukan, ParamsOf<Document>>) => semua | Janjikan<any>	Pengendali peristiwa yang dijalankan setiap kali pembuatan, pembaruan, atau penghapusan Firestore terjadi.

Hasil:

CloudFunction<FirestoreEvent<Ubah<DocumentSnapshot> | tidak ditentukan, ParamsOf<Document>>>

firestore.DocumentSnapshot

DocumentSnapshot Firestore

Tanda Tangan:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

QueryDocumentSnapshot Firestore

Tanda Tangan:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;