DocumentReference mengacu pada lokasi dokumen di database Firestore dan dapat digunakan untuk menulis, membaca, atau mendengarkan lokasi tersebut. Dokumen di lokasi yang direferensikan mungkin ada atau mungkin tidak ada.
Tanda tangan:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Properti
| Properti | Pengubah | Jenis | Keterangan |
|---|---|---|---|
| konverter | Konverter Data Firestore <AppModelType, DbModelType> | batal | Jika disediakan, FirestoreDataConverter terkait dengan instance ini. | |
| toko api | toko pemadam kebakaran | Contoh Firestore tempat dokumen tersebut berada. Ini berguna untuk melakukan transaksi, misalnya. | |
| pengenal | rangkaian | Pengidentifikasi dokumen dalam koleksinya. | |
| induk | KoleksiReferensi <AppModelType, DbModelType> | Koleksi milik DocumentReference ini. | |
| jalur | rangkaian | Sebuah string yang mewakili jalur dokumen yang direferensikan (relatif terhadap root database). | |
| jenis | (tidak diumumkan) | Jenis referensi Firestore ini. |
Metode
| metode | Pengubah | Keterangan |
|---|---|---|
| denganConverter(konverter) | Menerapkan konverter data khusus ke DocumentReference ini, memungkinkan Anda menggunakan objek model khusus Anda sendiri dengan Firestore. Saat Anda memanggil setDoc() , dapatkanDokter() , dll. dengan instance DocumentReference yang dikembalikan, konverter yang disediakan akan mengonversi antara data Firestore bertipe NewDbModelType dan tipe kustom Anda NewAppModelType . | |
| denganConverter(konverter) | Menghapus konverter saat ini. |
DocumentReference.converter
Jika disediakan, FirestoreDataConverter terkait dengan instance ini.
Tanda tangan:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
Contoh Firestore tempat dokumen tersebut berada. Ini berguna untuk melakukan transaksi, misalnya.
Tanda tangan:
readonly firestore: Firestore;
DokumenReferensi.id
Pengidentifikasi dokumen dalam koleksinya.
Tanda tangan:
get id(): string;
DocumentReference.parent
Koleksi milik DocumentReference ini.
Tanda tangan:
get parent(): CollectionReference<AppModelType, DbModelType>;
Referensi Dokumen.jalur
Sebuah string yang mewakili jalur dokumen yang direferensikan (relatif terhadap root database).
Tanda tangan:
get path(): string;
Referensi Dokumen.type
Jenis referensi Firestore ini.
Tanda tangan:
readonly type = "document";
Referensi Dokumen.denganConverter()
Menerapkan konverter data khusus ke DocumentReference ini , memungkinkan Anda menggunakan objek model kustom Anda sendiri dengan Firestore. Saat Anda memanggil setDoc() , dapatkanDokter() , dll. dengan instance DocumentReference yang dikembalikan, konverter yang disediakan akan mengonversi antara data Firestore bertipe NewDbModelType dan tipe kustom Anda NewAppModelType .
Tanda tangan:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| konverter | Konverter Data Firestore <JenisAppModelBaru,JenisDbModelBaru> | Mengonversi objek ke dan dari Firestore. |
Pengembalian:
Referensi Dokumen <JenisAppModelBaru,JenisDbModelBaru>
DocumentReference yang menggunakan konverter yang disediakan.
Referensi Dokumen.denganConverter()
Menghapus konverter saat ini.
Tanda tangan:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| konverter | batal | null menghapus konverter saat ini. |
Pengembalian:
Referensi Dokumen < Data Dokumen , Data Dokumen >
DocumentReference<DocumentData, DocumentData> yang tidak menggunakan konverter.