Obiektu CollectionReference można używać do dodawania dokumentów, pobierania odwołań do dokumentów i wysyłania zapytań o dokumenty (przy użyciu funkcji query()).
Podpis:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Rozszerza: Zapytanie<AppModelType, DbModelType>
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| id | ciąg znaków | Identyfikator kolekcji. | |
| element nadrzędny | DocumentReference<DocumentData, DocumentData> | wartość null | Jeśli jest to kolekcja podrzędna, atrybut DocumentReference zawiera odwołanie. Jeśli to nie jest kolekcja podrzędna, odwołanie ma wartość null. |
|
| ścieżka | ciąg znaków | Ciąg znaków reprezentujący ścieżkę do wskazywanego zbioru (względna wobec poziomu głównego bazy danych). | |
| type | (nie zadeklarowano) | Typ tego odwołania Firestore. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| withConverter(konwerter) | Stosuje do tego obiektu CollectionReference niestandardowy konwerter danych, dzięki czemu możesz używać w Firestore własnych obiektów modelu niestandardowego. Gdy wywołasz funkcję addDoc() przy użyciu zwróconej instancji CollectionReference, podany konwerter przekonwertuje dane Firestore typu NewDbModelType na niestandardowy typ NewAppModelType. |
|
| withConverter(konwerter) | Usuwa bieżący konwerter. |
IdentyfikatorOdniesienie kolekcji.id
Identyfikator kolekcji.
Podpis:
get id(): string;
Odniesienie do kolekcji.parent
Jeśli jest to kolekcja podrzędna, atrybut DocumentReference zawiera odwołanie. Jeśli to nie jest kolekcja podrzędna, odwołanie ma wartość null.
Podpis:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
Ścieżka referencji.kolekcji
Ciąg znaków reprezentujący ścieżkę do wskazywanego zbioru (względna wobec poziomu głównego bazy danych).
Podpis:
get path(): string;
Odniesienie do Kolekcji.type
Typ tego odwołania Firestore.
Podpis:
readonly type = "collection";
CollectionReference.withConverter()
Stosuje niestandardowy konwerter danych do tego zasobu (CollectionReference), co pozwala używać w Firestore własnych obiektów modelu niestandardowego. Gdy wywołasz funkcję addDoc() przy użyciu zwróconej instancji CollectionReference, podany konwerter przekonwertuje dane Firestore typu NewDbModelType na niestandardowy typ NewAppModelType.
Podpis:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownik dokonujący konwersji | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Konwertuje obiekty do i z Firestore. |
Zwroty:
CollectionReference<NewAppModelType, NewDbModelType>
Pole CollectionReference, które korzysta z podanego konwertera.
CollectionReference.withConverter()
Usuwa bieżący konwerter.
Podpis:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownik dokonujący konwersji | null | Funkcja null usuwa aktualny konwerter. |
Zwroty:
CollectionReference<DocumentData, DocumentData>
Identyfikator CollectionReference<DocumentData, DocumentData>, który nie korzysta z konwertera.