DocumentReference odnosi się do lokalizacji dokumentu w bazie danych Firestore i może być używane do zapisywania, czytania lub słuchania lokalizacji. Dokument we wskazanej lokalizacji może istnieć lub nie.
Podpis:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Nieruchomości
| Nieruchomość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| przetwornik | Konwerter danych Firestore <AppModelType, DbModelType> | zero | Jeśli podano, FirestoreDataConverter powiązany z tą instancją. | |
| sklep z ogniem | Sklep z ogniem | Instancja Firestore , w której znajduje się dokument. Jest to przydatne na przykład do wykonywania transakcji. | |
| ID | strunowy | Identyfikator dokumentu w jego kolekcji. | |
| rodzic | KolekcjaReferencja <AppModelType, DbModelType> | Kolekcja, do której należy to DocumentReference . | |
| ścieżka | strunowy | Ciąg reprezentujący ścieżkę dokumentu odniesienia (względem katalogu głównego bazy danych). | |
| typ | (nie Deklarowana) | Typ tego odniesienia do Firestore. |
Metody
| metoda | Modyfikatory | Opis |
|---|---|---|
| z konwerterem (konwerterem) | Stosuje niestandardowy konwerter danych do tego DocumentReference , umożliwiając używanie własnych niestandardowych obiektów modelu w Firestore. Kiedy wywołujesz setDoc() , pobierzDoc() itp. ze zwróconą instancją DocumentReference , dostarczony konwerter dokona konwersji pomiędzy danymi Firestore typu NewDbModelType i niestandardowym typem NewAppModelType . | |
| z konwerterem (konwerterem) | Usuwa konwerter prądu. |
Konwerter dokumentów referencyjnych
Jeśli podano, FirestoreDataConverter powiązany z tą instancją.
Podpis:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DokumentReferencja.firestore
Instancja Firestore , w której znajduje się dokument. Jest to przydatne na przykład do wykonywania transakcji.
Podpis:
readonly firestore: Firestore;
DokumentReference.id
Identyfikator dokumentu w jego kolekcji.
Podpis:
get id(): string;
Odniesienie do dokumentu.nadrzędny
Kolekcja, do której należy to DocumentReference .
Podpis:
get parent(): CollectionReference<AppModelType, DbModelType>;
DokumentReferencja.ścieżka
Ciąg reprezentujący ścieżkę dokumentu odniesienia (względem katalogu głównego bazy danych).
Podpis:
get path(): string;
Typ_odniesienia dokumentu
Typ tego odniesienia do Firestore.
Podpis:
readonly type = "document";
DokumentReferencja.z konwerterem()
Stosuje niestandardowy konwerter danych do tego DocumentReference , umożliwiając korzystanie z własnych, niestandardowych obiektów modelu w Firestore. Kiedy wywołujesz setDoc() , pobierzDoc() itp. ze zwróconą instancją DocumentReference , dostarczony konwerter dokona konwersji pomiędzy danymi Firestore typu NewDbModelType i niestandardowym typem NewAppModelType .
Podpis:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| przetwornik | Konwerter danych Firestore <Typ NewAppModel, Typ NewDbModel> | Konwertuje obiekty do i z Firestore. |
Zwroty:
Odnośnik do dokumentu <Typ NewAppModel, Typ NewDbModel>
DocumentReference , który używa dostarczonego konwertera.
DokumentReferencja.z konwerterem()
Usuwa konwerter prądu.
Podpis:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| przetwornik | zero | null usuwa bieżący konwerter. |
Zwroty:
Odnośnik do dokumentu < Dane dokumentu , Dane dokumentu >
DocumentReference<DocumentData, DocumentData> , który nie używa konwertera.