Objek CollectionReference dapat digunakan untuk menambahkan dokumen, mendapatkan referensi dokumen, dan menanyakan dokumen (menggunakan query() ).
Tanda tangan:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Perluasan: Kueri <AppModelType, DbModelType>
Properti
| Properti | Pengubah | Jenis | Keterangan |
|---|---|---|---|
| pengenal | rangkaian | Pengidentifikasi koleksi. | |
| induk | Referensi Dokumen < Data Dokumen , Data Dokumen > | batal | Referensi ke DocumentReference yang berisi jika ini adalah subkoleksi. Jika ini bukan subkoleksi, referensinya adalah null. | |
| jalur | rangkaian | Sebuah string yang mewakili jalur koleksi yang direferensikan (relatif terhadap root database). | |
| jenis | (tidak diumumkan) | Jenis referensi Firestore ini. |
Metode
| metode | Pengubah | Keterangan |
|---|---|---|
| denganConverter(konverter) | Menerapkan konverter data khusus ke CollectionReference ini, memungkinkan Anda menggunakan objek model khusus Anda sendiri dengan Firestore. Saat Anda memanggil addDoc() dengan instance CollectionReference yang dikembalikan, konverter yang disediakan akan mengonversi antara data Firestore bertipe NewDbModelType dan tipe kustom Anda NewAppModelType . | |
| denganConverter(konverter) | Menghapus konverter saat ini. |
KoleksiReferensi.id
Pengidentifikasi koleksi.
Tanda tangan:
get id(): string;
CollectionReference.parent
Referensi ke DocumentReference yang berisi jika ini adalah subkoleksi. Jika ini bukan subkoleksi, referensinya adalah null.
Tanda tangan:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.path
Sebuah string yang mewakili jalur koleksi yang direferensikan (relatif terhadap root database).
Tanda tangan:
get path(): string;
KoleksiReferensi.type
Jenis referensi Firestore ini.
Tanda tangan:
readonly type = "collection";
KoleksiReferensi.denganConverter()
Menerapkan konverter data khusus ke CollectionReference ini , memungkinkan Anda menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil addDoc() dengan instance CollectionReference yang dikembalikan, konverter yang disediakan akan mengonversi antara data Firestore bertipe NewDbModelType dan tipe kustom NewAppModelType Anda .
Tanda tangan:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| konverter | Konverter Data Firestore <JenisAppModelBaru,JenisDbModelBaru> | Mengonversi objek ke dan dari Firestore. |
Pengembalian:
KoleksiReferensi <JenisAppModelBaru,JenisDbModelBaru>
CollectionReference yang menggunakan konverter yang disediakan.
KoleksiReferensi.denganConverter()
Menghapus konverter saat ini.
Tanda tangan:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| konverter | batal | null menghapus konverter saat ini. |
Pengembalian:
KoleksiReferensi < Data Dokumen , Data Dokumen >
CollectionReference<DocumentData, DocumentData> yang tidak menggunakan konverter.