Un DocumentReference fa riferimento alla posizione di un documento in un database Firestore e può essere utilizzato per scrivere, leggere o ascoltare la posizione. Il documento nella posizione di riferimento può esistere o meno.
Firma:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Proprietà
| Proprietà | Modificatori | Tipo | Descrizione |
|---|---|---|---|
| convertitore | FirestoreDataConverter <AppModelType, DbModelType> | nullo | Se fornito, FirestoreDataConverter è associato a questa istanza. | |
| fuoco | Firestore | L'istanza di Firestore in cui si trova il documento. Ciò è utile, ad esempio, per eseguire transazioni. | |
| id | corda | L'identificatore del documento all'interno della sua raccolta. | |
| genitore | CollezioneRiferimento <AppModelType, DbModelType> | La raccolta a cui appartiene questo DocumentReference . | |
| sentiero | corda | Una stringa che rappresenta il percorso del documento di riferimento (relativo 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 DocumentReference , consentendoti di utilizzare i tuoi oggetti del modello personalizzato con Firestore. Quando chiami setDoc() , getDoc() , ecc. con l'istanza DocumentReference 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. |
DocumentReference.converter
Se fornito, FirestoreDataConverter è associato a questa istanza.
Firma:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
L'istanza di Firestore in cui si trova il documento. Ciò è utile, ad esempio, per eseguire transazioni.
Firma:
readonly firestore: Firestore;
DocumentReference.id
L'identificatore del documento all'interno della sua raccolta.
Firma:
get id(): string;
DocumentReference.parent
La raccolta a cui appartiene questo DocumentReference .
Firma:
get parent(): CollectionReference<AppModelType, DbModelType>;
DocumentReference.percorso
Una stringa che rappresenta il percorso del documento di riferimento (relativo alla radice del database).
Firma:
get path(): string;
DocumentReference.tipo
Il tipo di questo riferimento Firestore.
Firma:
readonly type = "document";
DocumentReference.withConverter()
Applica un convertitore di dati personalizzato a questo DocumentReference , consentendoti di utilizzare i tuoi oggetti modello personalizzati con Firestore. Quando chiami setDoc() , getDoc() , ecc. con l'istanza DocumentReference restituita, il convertitore fornito eseguirà la conversione tra i dati Firestore di tipo NewDbModelType e il tipo personalizzato NewAppModelType .
Firma:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| convertitore | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Converte oggetti da e verso Firestore. |
Ritorna:
Riferimento documento <NewAppModelType, NewDbModelType>
Un DocumentReference che utilizza il convertitore fornito.
DocumentReference.withConverter()
Rimuove il convertitore corrente.
Firma:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| convertitore | nullo | null rimuove il convertitore corrente. |
Ritorna:
Riferimento documento < Dati documento , Dati documento >
Oggetto DocumentReference<DocumentData, DocumentData> che non utilizza un convertitore.