Obiekt CollectionReference może być używany do dodawania dokumentów, uzyskiwania odniesień do dokumentów i wykonywania 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>
Nieruchomości
| Nieruchomość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| ID | strunowy | Identyfikator kolekcji. | |
| rodzic | Odnośnik do dokumentu < Dane dokumentu , Dane dokumentu > | zero | Odwołanie do zawierającego DocumentReference , jeśli jest to podkolekcja. Jeśli nie jest to podkolekcja, odwołanie ma wartość null. | |
| ścieżka | strunowy | Ciąg reprezentujący ścieżkę kolekcji, do której się odwołuje (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 CollectionReference , umożliwiając używanie własnych niestandardowych obiektów modelu w Firestore. Gdy wywołasz metodę addDoc() ze zwróconą instancją CollectionReference , dostarczony konwerter dokona konwersji pomiędzy danymi Firestore typu NewDbModelType i Twoim niestandardowym typem NewAppModelType . | |
| z konwerterem (konwerterem) | Usuwa konwerter prądu. |
KolekcjaReference.id
Identyfikator kolekcji.
Podpis:
get id(): string;
KolekcjaReference.parent
Odwołanie do zawierającego DocumentReference , jeśli jest to podkolekcja. Jeśli nie jest to podkolekcja, odwołanie ma wartość null.
Podpis:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
KolekcjaReference.path
Ciąg reprezentujący ścieżkę kolekcji, do której się odwołuje (względem katalogu głównego bazy danych).
Podpis:
get path(): string;
KolekcjaReference.type
Typ tego odniesienia do Firestore.
Podpis:
readonly type = "collection";
KolekcjaReferencja.withConverter()
Stosuje niestandardowy konwerter danych do tego CollectionReference , umożliwiając korzystanie z własnych, niestandardowych obiektów modelu w Firestore. Gdy wywołasz metodę addDoc() ze zwróconą instancją CollectionReference , dostarczony konwerter dokona konwersji pomiędzy danymi Firestore typu NewDbModelType i Twoim niestandardowym typem NewAppModelType .
Podpis:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| przetwornik | Konwerter danych Firestore <Typ NewAppModel, Typ NewDbModel> | Konwertuje obiekty do i z Firestore. |
Zwroty:
KolekcjaReferencja <Typ NewAppModel, Typ NewDbModel>
CollectionReference , który używa dostarczonego konwertera.
KolekcjaReferencja.withConverter()
Usuwa konwerter prądu.
Podpis:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| przetwornik | zero | null usuwa bieżący konwerter. |
Zwroty:
KolekcjaReferencja < Dane dokumentu , Dane dokumentu >
CollectionReference<DocumentData, DocumentData> , który nie używa konwertera.