Pozycja DocumentReference odnosi się do lokalizacji dokumentu w bazie danych Firestore i może być używana do zapisywania, odczytywania i nasłuchiwania lokalizacji. Dokument we wskazanej lokalizacji może lub nie istnieje.
Podpis:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| konwerter | FirestoreDataConverter<AppModelType, DbModelType> | wartość null | Jeśli podano, FirestoreDataConverter powiązane z tą instancją. |
|
| firestore | Firestore | Instancja Firestore, w której znajduje się dokument. Jest to przydatne np. podczas przeprowadzania transakcji. | |
| id | ciąg znaków | Identyfikator dokumentu w kolekcji. | |
| element nadrzędny | CollectionReference<AppModelType, DbModelType> | Kolekcja DocumentReference, do której należy. |
|
| ścieżka | ciąg znaków | Ciąg znaków reprezentujący ścieżkę do wskazanego dokumentu (względny do poziomu głównego bazy danych). | |
| type | (nie zadeklarowano) | Typ tego odwołania Firestore. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| withConverter(konwerter) | Stosuje do tego obiektu DocumentReference niestandardowy konwerter danych, dzięki czemu możesz używać w Firestore własnych obiektów modelu niestandardowego. Gdy wywołasz funkcję setDoc(), getDoc() itp. przy użyciu zwróconej instancji DocumentReference, podany konwerter przekonwertuje dane Firestore typu NewDbModelType na niestandardowy typ NewAppModelType. |
|
| withConverter(konwerter) | Usuwa bieżący konwerter. |
DocumentReference.converter
Jeśli podano, FirestoreDataConverter powiązane z tą instancją.
Podpis:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
Instancja Firestore, w której znajduje się dokument. Jest to przydatne np. podczas przeprowadzania transakcji.
Podpis:
readonly firestore: Firestore;
Identyfikator dokumentu
Identyfikator dokumentu w kolekcji.
Podpis:
get id(): string;
DocumentReference.parent
Kolekcja DocumentReference, do której należy.
Podpis:
get parent(): CollectionReference<AppModelType, DbModelType>;
DocumentReference.path
Ciąg znaków reprezentujący ścieżkę do wskazanego dokumentu (względny do poziomu głównego bazy danych).
Podpis:
get path(): string;
DocumentReference.type
Typ tego odwołania Firestore.
Podpis:
readonly type = "document";
DocumentReference.withConverter()
Stosuje niestandardowy konwerter danych do tego zasobu (DocumentReference), co pozwala używać w Firestore własnych obiektów modelu niestandardowego. Gdy wywołasz funkcję setDoc(), getDoc() itp. przy użyciu zwróconej instancji DocumentReference, podany konwerter przekonwertuje dane Firestore typu NewDbModelType na niestandardowy typ NewAppModelType.
Podpis:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownik dokonujący konwersji | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Konwertuje obiekty do i z Firestore. |
Zwroty:
DocumentReference<NewAppModelType, NewDbModelType>
Pole DocumentReference, które korzysta z podanego konwertera.
DocumentReference.withConverter()
Usuwa bieżący konwerter.
Podpis:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownik dokonujący konwersji | null | Funkcja null usuwa aktualny konwerter. |
Zwroty:
DocumentReference<DocumentData, DocumentData>
Identyfikator DocumentReference<DocumentData, DocumentData>, który nie korzysta z konwertera.