Un oggetto CollectionReference può essere utilizzato per aggiungere documenti, ottenere riferimenti a documenti ed eseguire query su documenti (utilizzando query() ).
Firma:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Estende: interrogazione <AppModelType, DbModelType>
Proprietà
| Proprietà | Modificatori | Tipo | Descrizione |
|---|---|---|---|
| id | corda | L'identificatore della raccolta. | |
| genitore | Riferimento documento < Dati documento , Dati documento > | nullo | Un riferimento al DocumentReference che lo contiene se si tratta di una sottoraccolta. Se non si tratta di una sottoraccolta, il riferimento è null. | |
| sentiero | corda | Una stringa che rappresenta il percorso della raccolta di riferimento (relativa alla radice del database). | |
| tipo | (non dichiarato) | Il tipo di questo riferimento Firestore. |
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| conConvertitore(convertitore) | Applica un convertitore di dati personalizzato a questo CollectionReference , consentendoti di utilizzare i tuoi oggetti del modello personalizzato con Firestore. Quando chiami addDoc() con l'istanza CollectionReference restituita, il convertitore fornito eseguirà la conversione tra i dati Firestore di tipo NewDbModelType e il tipo personalizzato NewAppModelType . | |
| conConvertitore(convertitore) | Rimuove il convertitore corrente. |
CollectionReference.id
L'identificatore della raccolta.
Firma:
get id(): string;
CollectionReference.parent
Un riferimento al DocumentReference che lo contiene se si tratta di una sottoraccolta. Se non si tratta di una sottoraccolta, il riferimento è null.
Firma:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.percorso
Una stringa che rappresenta il percorso della raccolta di riferimento (relativa alla radice del database).
Firma:
get path(): string;
CollectionReference.type
Il tipo di questo riferimento Firestore.
Firma:
readonly type = "collection";
CollectionReference.withConverter()
Applica un convertitore di dati personalizzato a questo CollectionReference , consentendoti di utilizzare i tuoi oggetti modello personalizzati con Firestore. Quando chiami addDoc() con l'istanza CollectionReference restituita, il convertitore fornito convertirà tra i dati Firestore di tipo NewDbModelType e il tipo personalizzato NewAppModelType .
Firma:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| convertitore | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Converte oggetti da e verso Firestore. |
Ritorna:
CollezioneRiferimento <NewAppModelType, NewDbModelType>
Oggetto CollectionReference che utilizza il convertitore fornito.
CollectionReference.withConverter()
Rimuove il convertitore corrente.
Firma:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| convertitore | nullo | null rimuove il convertitore corrente. |
Ritorna:
CollezioneRiferimento < Dati documento , Dati documento >
Oggetto CollectionReference<DocumentData, DocumentData> che non utilizza un convertitore.