DocumentReference class

एक DocumentReference फायरस्टोर डेटाबेस में एक दस्तावेज़ स्थान को संदर्भित करता है और इसका उपयोग स्थान को लिखने, पढ़ने या सुनने के लिए किया जा सकता है। संदर्भित स्थान पर दस्तावेज़ मौजूद हो भी सकता है और नहीं भी।

हस्ताक्षर:

export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

गुण

संपत्ति	संशोधक	प्रकार	विवरण
कनवर्टर		फायरस्टोरडेटा कनवर्टर <AppModelType, DbModelType> | व्यर्थ	यदि प्रदान किया गया है, तो FirestoreDataConverter इस उदाहरण से संबद्ध है।
इस firestore		इस firestore	दस्तावेज़ जिस फ़ायरस्टोर इंस्टेंस में है। उदाहरण के लिए, यह लेनदेन करने के लिए उपयोगी है।
पहचान		डोरी	इसके संग्रह में दस्तावेज़ का पहचानकर्ता.
माता-पिता		संग्रह संदर्भ <AppModelType, DbModelType>	यह DocumentReference जिस संग्रह से संबंधित है।
पथ		डोरी	संदर्भित दस्तावेज़ के पथ का प्रतिनिधित्व करने वाली एक स्ट्रिंग (डेटाबेस की जड़ के सापेक्ष)।
प्रकार		(अघोषित)	इस फायरस्टोर संदर्भ का प्रकार.

तरीकों

तरीका	संशोधक	विवरण
कनवर्टर के साथ(कन्वर्टर)		इस DocumentReference पर एक कस्टम डेटा कनवर्टर लागू करता है, जिससे आप फायरस्टोर के साथ अपने स्वयं के कस्टम मॉडल ऑब्जेक्ट का उपयोग कर सकते हैं। जब आप setDoc() को कॉल करते हैं , getDoc() , आदि लौटाए गए DocumentReference उदाहरण के साथ, प्रदान किया गया कनवर्टर NewDbModelType प्रकार के फायरस्टोर डेटा और आपके कस्टम प्रकार NewAppModelType के बीच परिवर्तित हो जाएगा।
कनवर्टर के साथ(कन्वर्टर)		वर्तमान कनवर्टर को हटा देता है.

दस्तावेज़ संदर्भ.परिवर्तक

यदि प्रदान किया गया है, तो FirestoreDataConverter इस उदाहरण से संबद्ध है।

हस्ताक्षर:

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

DocumentReference.firestore

दस्तावेज़ जिस फ़ायरस्टोर इंस्टेंस में है। उदाहरण के लिए, यह लेनदेन करने के लिए उपयोगी है।

हस्ताक्षर:

readonly firestore: Firestore;

DocumentReference.id

इसके संग्रह में दस्तावेज़ का पहचानकर्ता.

हस्ताक्षर:

get id(): string;

दस्तावेज़ संदर्भ.अभिभावक

यह DocumentReference जिस संग्रह से संबंधित है।

हस्ताक्षर:

get parent(): CollectionReference<AppModelType, DbModelType>;

दस्तावेज़संदर्भ.पथ

संदर्भित दस्तावेज़ के पथ का प्रतिनिधित्व करने वाली एक स्ट्रिंग (डेटाबेस की जड़ के सापेक्ष)।

हस्ताक्षर:

get path(): string;

दस्तावेज़संदर्भ.प्रकार

इस फायरस्टोर संदर्भ का प्रकार.

हस्ताक्षर:

readonly type = "document";

DocumentReference.withConverter()

इस DocumentReference में एक कस्टम डेटा कनवर्टर लागू करता है , आपको फायरस्टोर के साथ अपने स्वयं के कस्टम मॉडल ऑब्जेक्ट का उपयोग करने की अनुमति देता है। जब आप setDoc() को कॉल करते हैं , getDoc() , आदि लौटाए गए DocumentReference उदाहरण के साथ, प्रदान किया गया कनवर्टर NewDbModelType प्रकार के फायरस्टोर डेटा और आपके कस्टम प्रकार NewAppModelType के बीच परिवर्तित हो जाएगा .

हस्ताक्षर:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;

पैरामीटर

पैरामीटर	प्रकार	विवरण
कनवर्टर	फायरस्टोरडेटा कनवर्टर <NewAppModelType, NewDbModelType>	ऑब्जेक्ट को फायरस्टोर में और वहां से कनवर्ट करता है।

रिटर्न:

दस्तावेज़संदर्भ <NewAppModelType, NewDbModelType>

एक DocumentReference जो दिए गए कनवर्टर का उपयोग करता है।

DocumentReference.withConverter()

वर्तमान कनवर्टर को हटा देता है.

हस्ताक्षर:

withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;

पैरामीटर

पैरामीटर	प्रकार	विवरण
कनवर्टर	व्यर्थ	null वर्तमान कनवर्टर को हटा देता है।

रिटर्न:

दस्तावेज़संदर्भ < दस्तावेज़डेटा , दस्तावेज़ डेटा >

एक DocumentReference<DocumentData, DocumentData> जो कनवर्टर का उपयोग नहीं करता है।