firebase-admin.app package

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

फ़ंक्शन

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

इंटरफ़ेस

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

वैरिएबल

वैरिएबल	ब्यौरा
SDK_VERSION

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

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

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 सेवाओं के लिए एडमिन ऐक्सेस देता है. इस क्रेडेंशियल का इस्तेमाल, InitializeApp() को कॉल करने में किया जा सकता है.

ज़्यादा जानकारी के लिए, SDK टूल शुरू करना देखें.

हस्ताक्षर:

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

पैरामीटर

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

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

क्रेडेंशियल

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

पहला उदाहरण

// 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"
});

दूसरा उदाहरण

// 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[];

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

ऐप्लिकेशन[]

EarlyizeApp(options, appName)

हस्ताक्षर:

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

पैरामीटर

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

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

ऐप्लिकेशन

रीफ़्रेशToken(refreshTokenPathOrObject, httpAgent)

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

ज़्यादा जानकारी के लिए, SDK टूल शुरू करना देखें.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
रीफ़्रेशTokenPathOrObject	स्ट्रिंग | ऑब्जेक्ट	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