firebase-admin.app package

Firebase ऐप्लिकेशन और SDK टूल शुरू करना.

फ़ंक्शन

फ़ंक्शन	ब्यौरा
applicationDefault(httpAgent)	Google ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल से बनाया गया क्रेडेंशियल दिखाता है, जो Firebase सेवाओं का एडमिन ऐक्सेस देता है. इस क्रेडेंशियल का इस्तेमाल, initializeApp() के लिए किया जा सकता है.Google ऐप्लिकेशन डिफ़ॉल्ट क्रेडेंशियल, Google App Engine और Google Compute Engine जैसे Google के किसी भी इंफ़्रास्ट्रक्चर पर उपलब्ध हैं.ज़्यादा जानकारी के लिए, SDK टूल को शुरू करना देखें.
certification(serviceAccountPathOrObject, httpAgent)	दिए गए सेवा खाते से बनाया गया क्रेडेंशियल दिखाता है, जो Firebase सेवाओं का एडमिन ऐक्सेस देता है. इस क्रेडेंशियल का इस्तेमाल, initializeApp() के लिए किया जा सकता है.ज़्यादा जानकारी के लिए, SDK टूल को शुरू करना देखें.
deleteApp(ऐप्लिकेशन)	दिए गए App को इस्तेमाल करने लायक नहीं बनाता है और इससे जुड़ी सभी सेवाओं के संसाधनों को खाली करता है. हालांकि, इससे कोई भी बैकएंड संसाधन *नहीं* होता है. SDK टूल को स्थानीय तौर पर इस्तेमाल करते समय, इस तरीके को ज़रूर इस्तेमाल करें. इससे, प्रोसेस को अच्छी तरह से खत्म किया जा सकेगा.
getApp(appName)
getApps()
initializeApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent)	दिए गए रीफ़्रेश टोकन से बनाया गया क्रेडेंशियल दिखाता है, जो Firebase सेवाओं का एडमिन ऐक्सेस देता है. इस क्रेडेंशियल का इस्तेमाल, initializeApp() के लिए किया जा सकता है.ज़्यादा जानकारी के लिए, SDK टूल को शुरू करना देखें.

क्लास

क्लास	ब्यौरा
AppErrorCodes	ऐप्लिकेशन क्लाइंट के गड़बड़ी के कोड और उनके डिफ़ॉल्ट मैसेज.
FirebaseAppError	Firebase ऐप्लिकेशन का गड़बड़ी कोड स्ट्रक्चर. इससे PrefixedFirebaseError को भी बढ़ा दिया जाता है.

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
ऐप्लिकेशन	Firebase ऐप्लिकेशन में, कई तरह की सेवाओं के शुरू होने की जानकारी सेव होती है.
ऐप्लिकेशन के विकल्प	initializeApp() को पास करने के लिए उपलब्ध विकल्प.
क्रेडेंशियल	ऐसा इंटरफ़ेस जो Firebase सेवाओं से पुष्टि करने के लिए इस्तेमाल किए जाने वाले Google OAuth2 ऐक्सेस टोकन देता है.ज़्यादातर मामलों में, आपको इसे खुद लागू करने की ज़रूरत नहीं होगी. इसके बजाय, आप firebase-admin/app मॉड्यूल से मिलने वाले डिफ़ॉल्ट तरीके का इस्तेमाल कर सकते हैं.
FirebaseArrayIndexError	कंपोज़िट टाइप, जिसमें FirebaseError ऑब्जेक्ट और इंडेक्स, दोनों शामिल होते हैं. इसका इस्तेमाल, गड़बड़ी वाले आइटम को पाने के लिए किया जा सकता है.
Firebase से जुड़ी गड़बड़ी	FirebaseError, स्टैंडर्ड JavaScript Error ऑब्जेक्ट की सब-क्लास है. मैसेज स्ट्रिंग और स्टैक ट्रेस के अलावा, एक स्ट्रिंग कोड भी मौजूद होता है.
GoogleOAuthAccessToken	Google OAuth 2.0 ऐक्सेस टोकन के लिए इंटरफ़ेस.
ServiceAccount

वैरिएबल

वैरिएबल	ब्यौरा
SDK टूल का वर्शन

ऐप्लिकेशन डिफ़ॉल्ट(httpAgent)

Google ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल से बनाया गया क्रेडेंशियल दिखाता है, जो Firebase सेवाओं का एडमिन ऐक्सेस देता है. इस क्रेडेंशियल का इस्तेमाल, beginizeApp() को कॉल करने के लिए किया जा सकता है.

Google ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल, Google App Engine और Google Compute Engine जैसे Google के किसी भी इंफ़्रास्ट्रक्चर पर उपलब्ध हैं.

ज़्यादा जानकारी के लिए, SDK टूल को इस्तेमाल करने की प्रोसेस शुरू करना देखें.

हस्ताक्षर:

export declare function applicationDefault(httpAgent?: Agent): Credential;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
httpAgent	एजेंट	Google टोकन सर्वर से ऐक्सेस टोकन फिर से पाने के लिए, एचटीटीपी एजेंट का इस्तेमाल करें. हालांकि, यह तरीका ज़रूरी नहीं है.

लौटाए जाने वाले प्रॉडक्ट:

क्रेडेंशियल

Google ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल की मदद से पुष्टि किया गया क्रेडेंशियल. इसका इस्तेमाल किसी ऐप्लिकेशन को शुरू करने के लिए किया जा सकता है.

उदाहरण

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

प्रमाणपत्र(serviceAccountPathOrObject, httpAgent)

दिए गए सेवा खाते से बनाया गया क्रेडेंशियल दिखाता है, जो Firebase सेवाओं का एडमिन ऐक्सेस देता है. इस क्रेडेंशियल का इस्तेमाल, beginizeApp() को कॉल करने के लिए किया जा सकता है.

ज़्यादा जानकारी के लिए, SDK टूल को इस्तेमाल करने की प्रोसेस शुरू करना देखें.

हस्ताक्षर:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
serviceAccountPathOrObject	स्ट्रिंग | ServiceAccount	सेवा खाते की कुंजी JSON फ़ाइल का पाथ या सेवा खाता कुंजी दिखाने वाले ऑब्जेक्ट का पाथ.
httpAgent	एजेंट	Google टोकन सर्वर से ऐक्सेस टोकन फिर से पाने के लिए, एचटीटीपी एजेंट का इस्तेमाल करें. हालांकि, यह तरीका ज़रूरी नहीं है.

लौटाए जाने वाले प्रॉडक्ट:

क्रेडेंशियल

दिए गए सेवा खाते से पुष्टि किया गया क्रेडेंशियल. इसका इस्तेमाल किसी ऐप्लिकेशन को शुरू करने के लिए किया जा सकता है.

उदाहरण 1

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

उदाहरण 2

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

deleteApp(ऐप्लिकेशन)

दिए गए App को बिना इस्तेमाल किए रेंडर करता है और इससे जुड़ी सभी सेवाओं के संसाधनों को खाली करता है. हालांकि, इससे कोई भी बैकएंड संसाधन *नहीं* होता है. SDK टूल को स्थानीय तौर पर इस्तेमाल करते समय, इस तरीके को ज़रूर इस्तेमाल करें. इससे, प्रोसेस को अच्छी तरह से खत्म किया जा सकेगा.

हस्ताक्षर:

export declare function deleteApp(app: App): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	ऐप्लिकेशन

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<void>

उदाहरण

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp(appName)

हस्ताक्षर:

export declare function getApp(appName?: string): App;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन का नाम	स्ट्रिंग

लौटाए जाने वाले प्रॉडक्ट:

ऐप्लिकेशन

getApps()

हस्ताक्षर:

export declare function getApps(): App[];

लौटाए जाने वाले प्रॉडक्ट:

ऐप्लिकेशन[]

शुरू करने के लिए ऐप्लिकेशन(विकल्प, ऐप्लिकेशन का नाम)

हस्ताक्षर:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प	ऐप्लिकेशन के विकल्प
ऐप्लिकेशन का नाम	स्ट्रिंग

लौटाए जाने वाले प्रॉडक्ट:

ऐप्लिकेशन

FreshToken(refreshTokenPathOrObject, httpAgent)

दिए गए रीफ़्रेश टोकन से बनाया गया क्रेडेंशियल दिखाता है, जो Firebase सेवाओं का एडमिन ऐक्सेस देता है. इस क्रेडेंशियल का इस्तेमाल, beginizeApp() को कॉल करने के लिए किया जा सकता है.

ज़्यादा जानकारी के लिए, SDK टूल को इस्तेमाल करने की प्रोसेस शुरू करना देखें.

हस्ताक्षर:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
RefreshTokenPathOrObject	स्ट्रिंग | ऑब्जेक्ट	Google OAuth2 रीफ़्रेश टोकन JSON फ़ाइल का पाथ या Google OAuth2 रीफ़्रेश टोकन को दिखाने वाला ऑब्जेक्ट.
httpAgent	एजेंट	Google टोकन सर्वर से ऐक्सेस टोकन फिर से पाने के लिए, एचटीटीपी एजेंट का इस्तेमाल करें. हालांकि, यह तरीका ज़रूरी नहीं है.

लौटाए जाने वाले प्रॉडक्ट:

क्रेडेंशियल

दिए गए सेवा खाते से पुष्टि किया गया क्रेडेंशियल. इसका इस्तेमाल किसी ऐप्लिकेशन को शुरू करने के लिए किया जा सकता है.

उदाहरण

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK_VERSION

हस्ताक्षर:

SDK_VERSION: string