DocumentReference, Firestore डेटाबेस में दस्तावेज़ की जगह को दिखाता है. इसका इस्तेमाल जगह की जानकारी लिखने, पढ़ने या सुनने के लिए किया जा सकता है. ऐसा हो सकता है कि बताए गए जगह पर मौजूद दस्तावेज़ मौजूद हो या नहीं.
हस्ताक्षर:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
प्रॉपर्टी
| प्रॉपर्टी | मॉडिफ़ायर | टाइप | ब्यौरा |
|---|---|---|---|
| ग्राहक में बदलने वाला | FirestoreDataConverter<AppModelType, DbModelType> | शून्य | अगर दिया गया FirestoreDataConverter, इस इंस्टेंस से जुड़ा है. |
|
| फ़ायरस्टोर | फ़ायरस्टोर | Firestore इंस्टेंस, जिसमें दस्तावेज़ मौजूद है. उदाहरण के लिए, यह लेन-देन करने के लिए मददगार होता है. | |
| id | स्ट्रिंग | कलेक्शन में मौजूद दस्तावेज़ का आइडेंटिफ़ायर. | |
| माता-पिता | CollectionReference<AppModelType, DbModelType> | वह संग्रह जिससे यह DocumentReference जुड़ा है. |
|
| पाथ | स्ट्रिंग | रेफ़रंस के लिए दिए गए दस्तावेज़ का पाथ दिखाने वाली स्ट्रिंग (डेटाबेस के रूट से जुड़ी होती है). | |
| टाइप | (घोषित नहीं किया गया) | इस Firestore रेफ़रंस का टाइप. |
तरीके
| तरीका | मॉडिफ़ायर | ब्यौरा |
|---|---|---|
| के साथ कन्वर्टर(कन्वर्टर) | इस DocumentReference में एक कस्टम डेटा कन्वर्टर लागू करता है, जिससे आपको Firestore के साथ अपने कस्टम मॉडल ऑब्जेक्ट का इस्तेमाल करने की अनुमति मिलती है. जब मिले DocumentReference इंस्टेंस के साथ setDoc(), getDoc() वगैरह को कॉल किया जाता है, तब दिया गया कन्वर्टर, NewDbModelType टाइप के डेटा वाले डेटा और आपकी पसंद के मुताबिक NewAppModelType के बीच कन्वर्टर होगा. |
|
| के साथ कन्वर्टर(कन्वर्टर) | मौजूदा कन्वर्टर को हटाता है. |
DocumentReference.converter
अगर दिया गया FirestoreDataConverter, इस इंस्टेंस से जुड़ा है.
हस्ताक्षर:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
Firestore इंस्टेंस, जिसमें दस्तावेज़ मौजूद है. उदाहरण के लिए, यह लेन-देन करने के लिए मददगार होता है.
हस्ताक्षर:
readonly firestore: Firestore;
DocumentReference.id
कलेक्शन में मौजूद दस्तावेज़ का आइडेंटिफ़ायर.
हस्ताक्षर:
get id(): string;
दस्तावेज़ रेफ़रंस.पैरंट
वह संग्रह जिससे यह DocumentReference जुड़ा है.
हस्ताक्षर:
get parent(): CollectionReference<AppModelType, DbModelType>;
दस्तावेज़ रेफ़रंस.पाथ
रेफ़रंस के लिए दिए गए दस्तावेज़ का पाथ दिखाने वाली स्ट्रिंग (डेटाबेस के रूट से जुड़ी होती है).
हस्ताक्षर:
get path(): string;
DocumentReference.type
इस Firestore रेफ़रंस का टाइप.
हस्ताक्षर:
readonly type = "document";
DocumentReference.withConverter()
इस DocumentReference में एक कस्टम डेटा कन्वर्टर लागू करता है, जिससे आपको Firestore के साथ अपनी पसंद के मॉडल ऑब्जेक्ट इस्तेमाल करने की अनुमति मिलती है. जब लौटाए गए DocumentReference इंस्टेंस के साथ setDoc(), getDoc() वगैरह को कॉल किया जाता है, तब दिया गया कन्वर्टर, NewDbModelType टाइप के डेटा वाले डेटा और आपकी पसंद के मुताबिक तय किए गए टाइप NewAppModelType के बीच कन्वर्टर हो जाएगा.
हस्ताक्षर:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| ग्राहक के तौर पर बदलने वाला | FirestoreDataConverter<NewAppModelType, NewDbModelType> | यह ऑब्जेक्ट को Firestore में बदल देता है. साथ ही, इससे ऑब्जेक्ट को भी बदल देता है. |
लौटाए जाने वाले प्रॉडक्ट:
DocumentReference<NewAppModelType, NewDbModelType>
DocumentReference जो दिए गए कन्वर्टर का इस्तेमाल करता है.
DocumentReference.withConverter()
मौजूदा कन्वर्टर को हटाता है.
हस्ताक्षर:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| ग्राहक के तौर पर बदलने वाला | शून्य | null, मौजूदा कन्वर्टर को हटा देता है. |
लौटाए जाने वाले प्रॉडक्ट:
DocumentReference<DocumentData, DocumentData>
ऐसा DocumentReference<DocumentData, DocumentData> जो कन्वर्टर का इस्तेमाल नहीं करता.