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