Firebase ऐप्लिकेशन
यह पैकेज, Firebase के अलग-अलग कॉम्पोनेंट के बीच कम्यूनिकेशन को सिंक करता है
फ़ंक्शन
फ़ंक्शन | ब्यौरा |
---|---|
फ़ंक्शन(ऐप्लिकेशन, ...) | |
deleteApp(ऐप्लिकेशन) | इस ऐप्लिकेशन को इस्तेमाल नहीं किया जा सकता और इससे जुड़ी सभी सेवाओं के संसाधन खाली हो जाते हैं. |
फ़ंक्शन() | |
getApps() | शुरू किए गए सभी ऐप्लिकेशन की (रीड-ओनली ऐक्सेस) कलेक्शन. |
initializeApp() | FirebaseApp इंस्टेंस बनाता है और शुरू करता है. |
फ़ंक्शन(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, version, variant) | प्लैटफ़ॉर्म लॉग इन करने के लिए, लाइब्रेरी का नाम और वर्शन रजिस्टर करता है. |
फ़ंक्शन(logCallback, ...) | |
onLog(logCallback, options) | सभी Firebase SDK टूल के लिए, लॉग हैंडलर सेट करता है. |
फ़ंक्शन(loglevel, ...) | |
setLogLevel(logLevel) | सभी Firebase SDK टूल के लिए लॉग लेवल सेट करता है.मौजूदा लॉग लेवल के ऊपर के सभी लॉग टाइप कैप्चर किए जाते हैं.उदाहरण के लिए, अगर लॉग लेवल को info पर सेट किया जाता है, तो गड़बड़ियां लॉग की जाती हैं. हालांकि, debug और verbose लॉग नहीं. |
फ़ंक्शन(नाम, ...) | |
getApp(नाम) | FirebaseApp इंस्टेंस को फिर से हासिल करता है.बिना किसी तर्क के कॉल करने पर, डिफ़ॉल्ट ऐप्लिकेशन वापस आ जाता है. जब किसी ऐप्लिकेशन का नाम दिया जाता है, तो उस नाम से जुड़ा ऐप्लिकेशन दिखाया जाता है.अगर ऐप्लिकेशन वापस पाने के लिए इस्तेमाल शुरू नहीं किया गया है, तो अपवाद दिखता है. |
फ़ंक्शन(विकल्प, ...) | |
इनीशियलाइज़ऐप(विकल्प, नाम) | FirebaseApp इंस्टेंस बनाता और शुरू करता है.ज़्यादा जानकारी वाले दस्तावेज़ के लिए, अपने ऐप्लिकेशन में Firebase जोड़ना और एक से ज़्यादा प्रोजेक्ट शुरू करना देखें. |
इनीशियलाइज़ऐप(विकल्प, कॉन्फ़िगरेशन) | FirebaseApp इंस्टेंस बनाता है और शुरू करता है. |
इनीशियलाइज़ सर्वर ऐप(विकल्प, कॉन्फ़िगरेशन) | FirebaseServerApp इंस्टेंस बनाता और शुरू करता है.FirebaseServerApp , FirebaseApp की तरह ही है, लेकिन इसे सिर्फ़ सर्वर साइड रेंडरिंग एनवायरमेंट में चलाने के लिए बनाया गया है. किसी ब्राउज़र एनवायरमेंट से शुरू करने पर, प्रोसेस शुरू नहीं हो पाएगी.ज़्यादा जानकारी वाले दस्तावेज़ों के लिए, अपने ऐप्लिकेशन में Firebase जोड़ना और कई प्रोजेक्ट शुरू करना देखें. |
इंटरफ़ेस
इंटरफ़ेस | ब्यौरा |
---|---|
FirebaseApp | FirebaseApp में सेवाओं के कलेक्शन के लिए शुरू करने की जानकारी होती है.इस कंस्ट्रक्टर को सीधे कॉल न करें. इसके बजाय, ऐप्लिकेशन बनाने के लिए initializeApp() का इस्तेमाल करें. |
FirebaseAppSettings | initializeApp() के लिए दिए गए कॉन्फ़िगरेशन के विकल्प |
FirebaseOptions | Firebase कॉन्फ़िगरेशन ऑब्जेक्ट. इसमें सेवाओं के लिए ज़रूरी पैरामीटर का एक सेट होता है, जो Firebase सर्वर एपीआई के साथ संपर्क करने और क्लाइंट डेटा को आपके Firebase प्रोजेक्ट और Firebase ऐप्लिकेशन से जोड़ने के लिए ज़रूरी है. आम तौर पर, प्रोजेक्ट सेटअप के दौरान Firebase कंसोल इस ऑब्जेक्ट में जानकारी अपने-आप भरता है. यह भी देखें: Firebase कॉन्फ़िगरेशन ऑब्जेक्ट के बारे में जानें. |
FirebaseServerApp | FirebaseServerApp में, सर्वर एनवायरमेंट में चल रही सेवाओं के कलेक्शन के लिए, शुरू करने की जानकारी होती है.इस कंस्ट्रक्टर को सीधे कॉल न करें. इसके बजाय, ऐप्लिकेशन बनाने के लिए InitializeServerApp() का इस्तेमाल करें. |
FirebaseServerAppSettings | InstantizeServerApp() के लिए दिए गए कॉन्फ़िगरेशन के विकल्प |
वैरिएबल
वैरिएबल | ब्यौरा |
---|---|
SDK_VERSION | SDK टूल का मौजूदा वर्शन. |
फ़ंक्शन(ऐप्लिकेशन, ...)
deleteApp(ऐप्लिकेशन)
इस ऐप्लिकेशन को इस्तेमाल नहीं किया जा सकता और इससे जुड़ी सभी सेवाओं के संसाधन खाली हो जाते हैं.
हस्ताक्षर:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
ऐप्लिकेशन | FirebaseApp |
लौटाए जाने वाले प्रॉडक्ट:
Promise<void>
उदाहरण
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
फ़ंक्शन()
getApps()
शुरू किए गए सभी ऐप्लिकेशन की (रीड-ओनली ऐक्सेस) कलेक्शन.
हस्ताक्षर:
export declare function getApps(): FirebaseApp[];
लौटाए जाने वाले प्रॉडक्ट:
initializeApp()
FirebaseApp इंस्टेंस बनाता है और शुरू करता है.
हस्ताक्षर:
export declare function initializeApp(): FirebaseApp;
लौटाए जाने वाले प्रॉडक्ट:
फ़ंक्शन(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)
प्लैटफ़ॉर्म लॉग इन करने के लिए, लाइब्रेरी का नाम और वर्शन रजिस्टर करता है.
हस्ताक्षर:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
libraryKeyOrName | स्ट्रिंग | |
वर्शन | स्ट्रिंग | उस लाइब्रेरी का मौजूदा वर्शन. |
वैरिएंट | स्ट्रिंग | बंडल का वैरिएंट, जैसे कि नोड, rn वगैरह. |
लौटाए जाने वाले प्रॉडक्ट:
void
फ़ंक्शन(logCallback, ...)
onLog(logCallback, विकल्प)
सभी Firebase SDK टूल के लिए, लॉग हैंडलर सेट करता है.
हस्ताक्षर:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
logCallback | लॉग कॉलबैक | शून्य | एक वैकल्पिक कस्टम लॉग हैंडलर, जो Firebase SDK टूल के लॉग करने पर होने वाले कॉल के दौरान, उपयोगकर्ता कोड को एक्ज़ीक्यूट करता है. |
विकल्प | LogOptions |
लौटाए जाने वाले प्रॉडक्ट:
void
फ़ंक्शन(loglevel, ...)
setLogLevel(logLevel)
सभी Firebase SDK टूल के लिए लॉग लेवल सेट करता है.
मौजूदा लॉग लेवल के ऊपर के सभी लॉग टाइप कैप्चर कर लिए जाते हैं.इसका मतलब है कि अगर लॉग लेवल को info
पर सेट किया जाता है, तो गड़बड़ियां लॉग की जाती हैं. हालांकि, debug
और verbose
लॉग नहीं रिकॉर्ड होते.
हस्ताक्षर:
export declare function setLogLevel(logLevel: LogLevelString): void;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
logLevel | LogLevelString |
लौटाए जाने वाले प्रॉडक्ट:
void
फ़ंक्शन(नाम, ...)
getApp(नाम)
FirebaseApp इंस्टेंस की जानकारी देता है.
बिना किसी आर्ग्युमेंट के कॉल करने पर, डिफ़ॉल्ट ऐप्लिकेशन वापस आ जाता है. जब किसी ऐप्लिकेशन का नाम दिया जाता है, तो उस नाम से जुड़ा ऐप्लिकेशन वापस आ जाता है.
अगर वापस लाया जा रहा ऐप्लिकेशन अभी तक शुरू नहीं किया गया है, तो अपवाद होता है.
हस्ताक्षर:
export declare function getApp(name?: string): FirebaseApp;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
नाम | स्ट्रिंग | लौटाए जाने वाले ऐप्लिकेशन का वैकल्पिक नाम. अगर कोई नाम नहीं दिया जाता है, तो डिफ़ॉल्ट वैल्यू "[DEFAULT]" होती है. |
लौटाए जाने वाले प्रॉडक्ट:
दिए गए ऐप्लिकेशन के नाम से जुड़ा ऐप्लिकेशन. अगर ऐप्लिकेशन का कोई नाम नहीं दिया गया है, तो डिफ़ॉल्ट ऐप्लिकेशन वापस आ जाता है.
पहला उदाहरण
// Return the default app
const app = getApp();
दूसरा उदाहरण
// Return a named app
const otherApp = getApp("otherApp");
फ़ंक्शन(विकल्प, ...)
EarlyizeApp(options, name) के साथ-साथ
FirebaseApp इंस्टेंस बनाता और शुरू करता है.
ज़्यादा जानकारी वाले दस्तावेज़ों के लिए, अपने ऐप्लिकेशन में Firebase जोड़ना और एक से ज़्यादा प्रोजेक्ट शुरू करना देखें.
हस्ताक्षर:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
विकल्प | FirebaseOptions | ऐप्लिकेशन की सेवाओं को कॉन्फ़िगर करने के विकल्प. |
नाम | स्ट्रिंग | शुरू करने के लिए, ऐप्लिकेशन का वैकल्पिक नाम. अगर कोई नाम नहीं दिया जाता है, तो डिफ़ॉल्ट वैल्यू "[DEFAULT]" होती है. |
लौटाए जाने वाले प्रॉडक्ट:
शुरू किया गया ऐप्लिकेशन.
पहला उदाहरण
// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
});
दूसरा उदाहरण
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
beforeizeApp(options, config)
FirebaseApp इंस्टेंस बनाता है और शुरू करता है.
हस्ताक्षर:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
विकल्प | FirebaseOptions | ऐप्लिकेशन की सेवाओं को कॉन्फ़िगर करने के विकल्प. |
कॉन्फ़िगरेशन | FirebaseAppSettings | FirebaseApp कॉन्फ़िगरेशन |
लौटाए जाने वाले प्रॉडक्ट:
EarlyizeServerApp(options, config) की मदद से
FirebaseServerApp इंस्टेंस बनाता और शुरू करता है.
FirebaseServerApp
, FirebaseApp
की तरह है, लेकिन इसे सिर्फ़ सर्वर साइड रेंडरिंग एनवायरमेंट में इस्तेमाल करने के लिए बनाया गया है. अगर किसी ब्राउज़र एनवायरमेंट से इस्तेमाल किया गया हो, तो प्रोसेस शुरू नहीं की जा सकेगी.
ज़्यादा जानकारी वाले दस्तावेज़ों के लिए, अपने ऐप्लिकेशन में Firebase जोड़ना और एक से ज़्यादा प्रोजेक्ट शुरू करना देखें.
हस्ताक्षर:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
विकल्प | FirebaseOptions | FirebaseApp | ऐप्लिकेशन की सेवाओं को कॉन्फ़िगर करने के लिए Firebase.AppOptions या एक FirebaseApp इंस्टेंस जिसमें AppOptions शामिल है. |
कॉन्फ़िगरेशन | FirebaseServerAppSettings | FirebaseServerApp कॉन्फ़िगरेशन. |
लौटाए जाने वाले प्रॉडक्ट:
शुरू किया गया FirebaseServerApp
.
उदाहरण
// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
},
{
authIdToken: "Your Auth ID Token"
});
SDK_VERSION
SDK टूल का मौजूदा वर्शन.
हस्ताक्षर:
SDK_VERSION: string