Objek CollectionReference dapat digunakan untuk menambahkan dokumen, mendapatkan referensi dokumen, dan membuat kueri untuk dokumen (menggunakan query()).
Tanda Tangan:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Memperluas: Query<AppModelType, DbModelType>
Properti
| Properti | Pengubah | Jenis | Deskripsi |
|---|---|---|---|
| id | string | ID koleksi. | |
| parent | DocumentReference<DocumentData, DocumentData> | null (kosong) | Referensi ke DocumentReference yang memuatnya jika ini adalah subkoleksi. Jika ini bukan subkoleksi, referensinya adalah null. |
|
| path | string | String yang mewakili jalur koleksi yang direferensikan (relatif terhadap root database). | |
| jenis | (tidak dinyatakan) | Jenis referensi Firestore ini. |
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| withConverter(pengonversi) | Menerapkan konverter data kustom ke CollectionReference ini, sehingga Anda dapat menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil addDoc() dengan instance CollectionReference yang ditampilkan, pengonversi yang disediakan akan mengonversi antara data Firestore jenis NewDbModelType dan jenis kustom Anda NewAppModelType. |
|
| withConverter(pengonversi) | Menghapus pengonversi saat ini. |
CollectionReference.id
ID koleksi.
Tanda Tangan:
get id(): string;
CollectionReference.parent
Referensi ke DocumentReference yang memuatnya jika ini adalah subkoleksi. Jika ini bukan subkoleksi, referensinya adalah null.
Tanda Tangan:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.path
String yang mewakili jalur koleksi yang direferensikan (relatif terhadap root database).
Tanda Tangan:
get path(): string;
CollectionReference.type
Jenis referensi Firestore ini.
Tanda Tangan:
readonly type = "collection";
CollectionReference.withConverter()
Menerapkan pengonversi data kustom ke CollectionReference ini, sehingga Anda dapat menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil addDoc() dengan instance CollectionReference yang ditampilkan, pengonversi yang disediakan akan mengonversi antara data Firestore jenis NewDbModelType dan jenis kustom Anda NewAppModelType.
Tanda Tangan:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| converter | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Mengonversi objek ke dan dari Firestore. |
Hasil:
CollectionReference<NewAppModelType, NewDbModelType>
CollectionReference yang menggunakan konverter yang disediakan.
CollectionReference.withConverter()
Menghapus pengonversi saat ini.
Tanda Tangan:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| converter | null | null menghapus pengonversi saat ini. |
Hasil:
CollectionReference<DocumentData, DocumentData>
CollectionReference<DocumentData, DocumentData> yang tidak menggunakan konverter.