firestore namespace

कार्य

समारोह विवरण
onDocumentCreated(दस्तावेज़, हैंडलर) इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ बनाते समय ट्रिगर होता है।
onDocumentCreated(opts, हैंडलर) इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ बनाते समय ट्रिगर होता है।
onDocumentDeleted(दस्तावेज़, हैंडलर) इवेंट हैंडलर जो फायरस्टोर में किसी दस्तावेज़ को हटाए जाने पर ट्रिगर होता है।
onDocumentDeleted(ऑप्ट्स, हैंडलर) इवेंट हैंडलर जो फायरस्टोर में किसी दस्तावेज़ को हटाए जाने पर ट्रिगर होता है।
onDocumentUpdated(दस्तावेज़, हैंडलर) इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ अपडेट होने पर ट्रिगर होता है।
onDocumentUpdated(opts, हैंडलर) इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ अपडेट होने पर ट्रिगर होता है।
onDocumentWritten(दस्तावेज़, हैंडलर) इवेंट हैंडलर जो फ़ायरस्टोर में दस्तावेज़ बनाने, अद्यतन करने या हटाए जाने पर ट्रिगर होता है।
onDocumentWritten(opts, हैंडलर) इवेंट हैंडलर जो फ़ायरस्टोर में दस्तावेज़ बनाने, अद्यतन करने या हटाए जाने पर ट्रिगर होता है।

कक्षाओं

कक्षा विवरण
परिवर्तन स्थिति बदलने वाली घटनाओं के लिए क्लाउड फ़ंक्शंस इंटरफ़ेस, जैसे रीयलटाइम डेटाबेस या क्लाउड फायरस्टोर onWrite और onUpdate इवेंट। Change ऑब्जेक्ट के निर्माण के लिए उपयोग किए जाने वाले प्रारूप के बारे में अधिक जानकारी के लिए, नीचे देखें।

इंटरफेस

इंटरफेस विवरण
दस्तावेज़विकल्प DocumentOptions प्रदान किए गए दस्तावेज़ और वैकल्पिक डेटाबेस और नेमस्पेस के साथ इवेंटहैंडलरऑप्शन का विस्तार करता है।
फायरस्टोरइवेंट एक CloudEvent जिसमें एक DocumentSnapshot या एक परिवर्तन शामिल है

उपनाम टाइप करें

उपनाम टाइप करें विवरण
दस्तावेज़ स्नैपशॉट एक फायरस्टोर दस्तावेज़ स्नैपशॉट
क्वेरी दस्तावेज़ स्नैपशॉट एक फायरस्टोर क्वेरी दस्तावेज़ स्नैपशॉट

firestore.onDocumentCreated()

इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ बनाते समय ट्रिगर होता है।

हस्ताक्षर:

export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
दस्तावेज़ दस्तावेज़ ट्रिगर करने के लिए फायरस्टोर दस्तावेज़ पथ।
हैंडलर (घटना: फायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर निर्माण होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

firestore.onDocumentCreated()

इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ बनाते समय ट्रिगर होता है।

हस्ताक्षर:

export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
चुनता है दस्तावेज़विकल्प <दस्तावेज़> विकल्प जिन्हें व्यक्तिगत ईवेंट-हैंडलिंग फ़ंक्शन पर सेट किया जा सकता है।
हैंडलर (घटना: फायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर निर्माण होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

firestore.onDocumentDeleted()

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

हस्ताक्षर:

export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
दस्तावेज़ दस्तावेज़ ट्रिगर करने के लिए फायरस्टोर दस्तावेज़ पथ।
हैंडलर (घटना: फायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर डिलीट होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

firestore.onDocumentDeleted()

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

हस्ताक्षर:

export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
चुनता है दस्तावेज़विकल्प <दस्तावेज़> विकल्प जिन्हें व्यक्तिगत ईवेंट-हैंडलिंग फ़ंक्शन पर सेट किया जा सकता है।
हैंडलर (घटना: फायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर डिलीट होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < क्वेरीडॉक्यूमेंटस्नैपशॉट | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

firestore.onDocumentUpdated()

इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ अपडेट होने पर ट्रिगर होता है।

हस्ताक्षर:

export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
दस्तावेज़ दस्तावेज़ ट्रिगर करने के लिए फायरस्टोर दस्तावेज़ पथ।
हैंडलर (घटना: फायरस्टोरइवेंट < परिवर्तन < क्वेरीडॉक्यूमेंटस्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर अपडेट होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < परिवर्तन < क्वेरीडॉक्यूमेंटस्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

firestore.onDocumentUpdated()

इवेंट हैंडलर जो फायरस्टोर में दस्तावेज़ अपडेट होने पर ट्रिगर होता है।

हस्ताक्षर:

export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
चुनता है दस्तावेज़विकल्प <दस्तावेज़> विकल्प जिन्हें व्यक्तिगत ईवेंट-हैंडलिंग फ़ंक्शन पर सेट किया जा सकता है।
हैंडलर (घटना: फायरस्टोरइवेंट < परिवर्तन < क्वेरीडॉक्यूमेंटस्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर अपडेट होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < परिवर्तन < क्वेरीडॉक्यूमेंटस्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

firestore.onDocumentWritten()

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

हस्ताक्षर:

export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
दस्तावेज़ दस्तावेज़ ट्रिगर करने के लिए फायरस्टोर दस्तावेज़ पथ।
हैंडलर (घटना: फायरस्टोरइवेंट < परिवर्तन < दस्तावेज़ स्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर के निर्माण, अपडेट या डिलीट होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < परिवर्तन < दस्तावेज़ स्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

firestore.onDocumentWritten()

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

हस्ताक्षर:

export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

पैरामीटर

पैरामीटर प्रकार विवरण
चुनता है दस्तावेज़विकल्प <दस्तावेज़> विकल्प जिन्हें व्यक्तिगत ईवेंट-हैंडलिंग फ़ंक्शन पर सेट किया जा सकता है।
हैंडलर (घटना: फायरस्टोरइवेंट < परिवर्तन < दस्तावेज़ स्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>) => कोई भी | वादा<कोई> इवेंट हैंडलर जो हर बार फायरस्टोर के निर्माण, अपडेट या डिलीट होने पर चलाया जाता है।

रिटर्न:

क्लाउडफ़ंक्शन < फ़ायरस्टोरइवेंट < परिवर्तन < दस्तावेज़ स्नैपशॉट > | अपरिभाषित, पैराम्सऑफ़ <दस्तावेज़>>>

फायरस्टोर.डॉक्यूमेंटस्नैपशॉट

एक फायरस्टोर दस्तावेज़ स्नैपशॉट

हस्ताक्षर:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

एक फायरस्टोर क्वेरी दस्तावेज़ स्नैपशॉट

हस्ताक्षर:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;