firestore namespace

Fungsi

Fungsi Keterangan
onDocumentCreated(dokumen, penangan) Pengendali peristiwa yang terpicu saat dokumen dibuat di Firestore.
onDocumentCreated(memilih, penangan) Pengendali peristiwa yang terpicu saat dokumen dibuat di Firestore.
onDocumentDeleted(dokumen, penangan) Pengendali peristiwa yang terpicu ketika dokumen dihapus di Firestore.
onDocumentDeleted(memilih, menangani) Pengendali peristiwa yang terpicu ketika dokumen dihapus di Firestore.
onDocumentUpdated(dokumen, penangan) Pengendali peristiwa yang terpicu ketika dokumen diperbarui di Firestore.
onDocumentUpdated(memilih, menangani) Pengendali peristiwa yang terpicu ketika dokumen diperbarui di Firestore.
onDocumentWritten(dokumen, penangan) Pengendali peristiwa yang terpicu ketika dokumen dibuat, diperbarui, atau dihapus di Firestore.
onDocumentWritten(memilih, penangan) Pengendali peristiwa yang terpicu ketika dokumen dibuat, diperbarui, atau dihapus di Firestore.

Kelas

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

Antarmuka

Antarmuka Keterangan
Opsi Dokumen DocumentOptions memperluas EventHandlerOptions dengan dokumen yang disediakan serta database dan namespace opsional.
Acara Firestore CloudEvent yang berisi DocumentSnapshot atau Perubahan

Ketik Alias

Ketik Alias Keterangan
Cuplikan Dokumen Cuplikan Dokumen Firestore
Cuplikan Dokumen Kueri Cuplikan Dokumen Kueri 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 Keterangan
dokumen Dokumen Jalur dokumen Firestore yang akan dipicu.
penangan (acara: FirestoreEvent < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali pembuatan Firestore terjadi.

Pengembalian:

Fungsi Cloud < Acara Firestore < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>>

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 Keterangan
memilih Opsi Dokumen <Dokumen> Opsi yang dapat diatur pada fungsi penanganan peristiwa individual.
penangan (acara: FirestoreEvent < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali pembuatan Firestore terjadi.

Pengembalian:

Fungsi Cloud < Acara Firestore < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>>

firestore.onDocumentDeleted()

Pengendali peristiwa yang terpicu ketika 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 Keterangan
dokumen Dokumen Jalur dokumen Firestore yang akan dipicu.
penangan (acara: FirestoreEvent < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali terjadi penghapusan Firestore.

Pengembalian:

Fungsi Cloud < Acara Firestore < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>>

firestore.onDocumentDeleted()

Pengendali peristiwa yang terpicu ketika 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 Keterangan
memilih Opsi Dokumen <Dokumen> Opsi yang dapat diatur pada fungsi penanganan peristiwa individual.
penangan (acara: FirestoreEvent < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali terjadi penghapusan Firestore.

Pengembalian:

Fungsi Cloud < Acara Firestore < Cuplikan Dokumen Kueri | tidak terdefinisi, ParamsOf <Dokumen>>>

firestore.onDocumentUpdated()

Pengendali peristiwa yang terpicu ketika 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 Keterangan
dokumen Dokumen Jalur dokumen Firestore yang akan dipicu.
penangan (acara: FirestoreEvent < Ubah < QueryDocumentSnapshot > | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali pembaruan Firestore terjadi.

Pengembalian:

Fungsi Cloud < Acara Firestore < Ubah < QueryDocumentSnapshot > | tidak terdefinisi, ParamsOf <Dokumen>>>

firestore.onDocumentUpdated()

Pengendali peristiwa yang terpicu ketika 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 Keterangan
memilih Opsi Dokumen <Dokumen> Opsi yang dapat diatur pada fungsi penanganan peristiwa individual.
penangan (acara: FirestoreEvent < Ubah < QueryDocumentSnapshot > | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali pembaruan Firestore terjadi.

Pengembalian:

Fungsi Cloud < Acara Firestore < Ubah < QueryDocumentSnapshot > | tidak terdefinisi, ParamsOf <Dokumen>>>

firestore.onDocumentWritten()

Pengendali peristiwa yang terpicu ketika 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 Keterangan
dokumen Dokumen Jalur dokumen Firestore yang akan dipicu.
penangan (acara: FirestoreEvent < Ubah < Cuplikan Dokumen > | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali pembuatan, pembaruan, atau penghapusan Firestore terjadi.

Pengembalian:

Fungsi Cloud < Acara Firestore < Ubah < Cuplikan Dokumen > | tidak terdefinisi, ParamsOf <Dokumen>>>

firestore.onDocumentWritten()

Pengendali peristiwa yang terpicu ketika 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 Keterangan
memilih Opsi Dokumen <Dokumen> Opsi yang dapat diatur pada fungsi penanganan peristiwa individual.
penangan (acara: FirestoreEvent < Ubah < Cuplikan Dokumen > | tidak terdefinisi, ParamsOf <Dokumen>>) => apa saja | Janji<apa saja> Pengendali peristiwa yang dijalankan setiap kali pembuatan, pembaruan, atau penghapusan Firestore terjadi.

Pengembalian:

Fungsi Cloud < Acara Firestore < Ubah < Cuplikan Dokumen > | tidak terdefinisi, ParamsOf <Dokumen>>>

firestore.DocumentSnapshot

Cuplikan Dokumen Firestore

Tanda tangan:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Cuplikan Dokumen Kueri Firestore

Tanda tangan:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;