firebase-admin package

फायरबेस नेमस्पेस्ड एपीआई (विरासत)।

कार्य

समारोह विवरण
एप्लिकेशन का नाम)
ऐपचेक(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए ऐपचेक सेवा प्राप्त करता है। डिफ़ॉल्ट ऐप की AppCheck सेवा तक पहुंचने के लिए admin.appCheck() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी AppCheck सेवा तक पहुंचने के लिए admin.appCheck(app) के रूप में कॉल किया जा सकता है।
प्राधिकरण(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए प्रामाणिक सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की प्रामाणिक सेवा तक पहुंचने के लिए admin.auth() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी प्रामाणिक सेवा तक पहुंचने के लिए admin.auth(app) के रूप में कॉल किया जा सकता है।
डेटाबेस(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए डेटाबेस सेवा प्राप्त करता है। डिफ़ॉल्ट ऐप की Database सेवा तक पहुंचने के लिए admin.database() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी Database सेवा तक पहुंचने के लिए admin.database(app) के रूप में कॉल किया जा सकता है। admin.database भी एक नामस्थान है जिसका उपयोग Database सेवा से जुड़े वैश्विक स्थिरांक और तरीकों तक पहुँचने के लिए किया जा सकता है।
फायरस्टोर(ऐप)
इनिशियलाइज़ ऐप (विकल्प, नाम)
इंस्टॉलेशन(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए इंस्टॉलेशन सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की इंस्टॉलेशन सेवा तक पहुंचने के लिए admin.installations() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी इंस्टॉलेशन सेवा तक पहुंचने के लिए admin.installations(app) के रूप में कॉल किया जा सकता है।
इंस्टेंसआईडी(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए InstanceId सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की InstanceId सेवा तक पहुंचने के लिए admin.instanceId() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी InstanceId सेवा तक पहुंचने के लिए admin.instanceId(app) के रूप में कॉल किया जा सकता है।
मशीन लर्निंग(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए मशीन लर्निंग सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की MachineLearning सेवा तक पहुंचने के लिए admin.machineLearning() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी MachineLearning सेवा तक पहुंचने के लिए admin.machineLearning(app) के रूप में कॉल किया जा सकता है।
मैसेजिंग(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए मैसेजिंग सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की Messaging सेवा तक पहुंचने के लिए admin.messaging() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी Messaging सेवा तक पहुंचने के लिए admin.messaging(app) के रूप में कॉल किया जा सकता है।
परियोजना प्रबंधन(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए ProjectManagement सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की ProjectManagement सेवा तक पहुंचने के लिए admin.projectManagement() बिना किसी तर्क के कॉल किया जा सकता है, या किसी विशिष्ट ऐप से जुड़ी ProjectManagement सेवा तक पहुंचने के लिए admin.projectManagement(app) के रूप में कॉल किया जा सकता है।
रिमोट कॉन्फिग(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए रिमोटकॉन्फिग सेवा प्राप्त करता है। डिफ़ॉल्ट ऐप की RemoteConfig सेवा तक पहुंचने के लिए admin.remoteConfig() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी RemoteConfig सेवा तक पहुंचने के लिए admin.remoteConfig(app) के रूप में कॉल किया जा सकता है।
सुरक्षा नियम(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए SecurityRules सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की SecurityRules सेवा तक पहुंचने के लिए admin.securityRules() बिना किसी तर्क के कॉल किया जा सकता है, या किसी विशिष्ट ऐप से जुड़ी SecurityRules सेवा तक पहुंचने के लिए admin.securityRules(app) के रूप में कॉल किया जा सकता है।
भंडारण(ऐप) डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए स्टोरेज सेवा प्राप्त होती है। डिफ़ॉल्ट ऐप की Storage सेवा तक पहुंचने के लिए admin.storage() बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी Storage सेवा तक पहुंचने के लिए admin.storage(app) के रूप में कॉल किया जा सकता है।

इंटरफेस

इंटरफेस विवरण
ऐप विकल्प इनिशियलाइज़एप() को पास करने के लिए उपलब्ध विकल्प .
FirebaseArrayIndexत्रुटि समग्र प्रकार जिसमें FirebaseError ऑब्जेक्ट और एक इंडेक्स दोनों शामिल हैं जिनका उपयोग त्रुटिपूर्ण आइटम प्राप्त करने के लिए किया जा सकता है।
फायरबेसत्रुटि FirebaseError मानक जावास्क्रिप्ट Error ऑब्जेक्ट का एक उपवर्ग है। संदेश स्ट्रिंग और स्टैक ट्रेस के अलावा, इसमें एक स्ट्रिंग कोड होता है।
GoogleOAuthAccessToken Google OAuth 2.0 एक्सेस टोकन के लिए इंटरफ़ेस।
सेवा खाता

नेमस्पेस

नाम स्थान विवरण
अनुप्रयोग
ऐपचेक
प्रमाणन
क्रेडेंशियल
डेटाबेस
इस firestore
अधिष्ठापन
उदाहरण आईडी
यंत्र अधिगम
मैसेजिंग
परियोजना प्रबंधन
रिमोट कॉन्फिग
सुरक्षा नियम
भंडारण

चर

चर विवरण
ऐप्स
SDK_संस्करण

अनुप्रयोग()

हस्ताक्षर:

export declare function app(name?: string): app.App;

पैरामीटर

पैरामीटर प्रकार विवरण
नाम डोरी

रिटर्न:

ऐप.ऐप

ऐपचेक()

डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए ऐपचेक सेवा प्राप्त करता है।

डिफ़ॉल्ट ऐप की AppCheck सेवा तक पहुंचने के लिए admin.appCheck() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी AppCheck सेवा तक पहुंचने के लिए admin.appCheck(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function appCheck(app?: App): appCheck.AppCheck;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग AppCheck सेवा लौटाने के लिए वैकल्पिक ऐप। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट AppCheck सेवा लौटा दी जाती है।

रिटर्न:

ऐपचेक.ऐपचेक

यदि कोई ऐप उपलब्ध नहीं कराया गया है तो डिफ़ॉल्ट AppCheck सेवा, या दिए गए ऐप से जुड़ी AppCheck सेवा।

उदाहरण 1

// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();

उदाहरण 2

// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);

प्रमाणीकरण()

डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए प्रामाणिक सेवा प्राप्त होती है।

डिफ़ॉल्ट ऐप की प्रामाणिक सेवा तक पहुंचने के लिए admin.auth() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी प्रामाणिक सेवा तक पहुंचने के लिए admin.auth(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function auth(app?: App): auth.Auth;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग

रिटर्न:

auth.Auth

उदाहरण 1

// Get the Auth service for the default app
var defaultAuth = admin.auth();

उदाहरण 2

// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);

डेटाबेस()

डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए डेटाबेस सेवा प्राप्त करता है।

डिफ़ॉल्ट ऐप की Database सेवा तक पहुंचने के लिए admin.database() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी Database सेवा तक पहुंचने के लिए admin.database(app) के रूप में कॉल किया जा सकता है।

admin.database भी एक नामस्थान है जिसका उपयोग Database सेवा से जुड़े वैश्विक स्थिरांक और तरीकों तक पहुँचने के लिए किया जा सकता है।

हस्ताक्षर:

export declare function database(app?: App): database.Database;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग

रिटर्न:

डेटाबेस.डेटाबेस

यदि कोई ऐप प्रदान नहीं किया गया है तो डिफ़ॉल्ट Database सेवा या प्रदान किए गए ऐप से जुड़ी Database सेवा।

उदाहरण 1

// Get the Database service for the default app
var defaultDatabase = admin.database();

उदाहरण 2

// Get the Database service for a specific app
var otherDatabase = admin.database(app);

फायरस्टोर()

हस्ताक्षर:

export declare function firestore(app?: App): _firestore.Firestore;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग

रिटर्न:

_फायरस्टोर.फायरस्टोर

इनिशियलाइज़ऐप()

हस्ताक्षर:

export declare function initializeApp(options?: AppOptions, name?: string): app.App;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्प ऐप विकल्प
नाम डोरी

रिटर्न:

ऐप.ऐप

स्थापना()

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

डिफ़ॉल्ट ऐप की इंस्टॉलेशन सेवा तक पहुंचने के लिए admin.installations() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी इंस्टॉलेशन सेवा तक पहुंचने के लिए admin.installations(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function installations(app?: App): installations.Installations;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग वैकल्पिक ऐप जिसकी Installations सेवा वापस आनी है। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट Installations सेवा वापस कर दी जाती है।

रिटर्न:

संस्थापन.स्थापना

यदि कोई ऐप उपलब्ध नहीं कराया गया है तो डिफ़ॉल्ट Installations सेवा या दिए गए ऐप से जुड़ी Installations सेवा।

उदाहरण 1

// Get the Installations service for the default app
var defaultInstallations = admin.installations();

उदाहरण 2

// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);

इंस्टेंसआईडी()

डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए InstanceId सेवा प्राप्त होती है।

डिफ़ॉल्ट ऐप की InstanceId सेवा तक पहुंचने के लिए admin.instanceId() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी InstanceId सेवा तक पहुंचने के लिए admin.instanceId(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function instanceId(app?: App): instanceId.InstanceId;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग वैकल्पिक ऐप जिसकी InstanceId सेवा वापस आनी है। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट InstanceId सेवा वापस कर दी जाएगी।

रिटर्न:

InstanceId.InstanceId

यदि कोई ऐप प्रदान नहीं किया गया है तो डिफ़ॉल्ट InstanceId सेवा या प्रदान किए गए ऐप से जुड़ी InstanceId सेवा।

उदाहरण 1

// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();

उदाहरण 2

// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);

यंत्र अधिगम()

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

डिफ़ॉल्ट ऐप की MachineLearning सेवा तक पहुंचने के लिए admin.machineLearning() को बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी MachineLearning सेवा तक पहुंचने के लिए admin.machineLearning(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function machineLearning(app?: App): machineLearning.MachineLearning;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग वैकल्पिक ऐप जिसकी MachineLearning सेवा वापस आनी है। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट MachineLearning सेवा वापस कर दी जाएगी।

रिटर्न:

मशीन लर्निंग.मशीन लर्निंग

यदि कोई ऐप उपलब्ध नहीं कराया गया है तो डिफ़ॉल्ट MachineLearning सेवा या दिए गए ऐप से जुड़ी MachineLearning सेवा।

उदाहरण 1

// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();

उदाहरण 2

// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);

संदेश()

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

डिफ़ॉल्ट ऐप की Messaging सेवा तक पहुंचने के लिए admin.messaging() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी Messaging सेवा तक पहुंचने के लिए admin.messaging(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function messaging(app?: App): messaging.Messaging;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग वैकल्पिक ऐप जिसकी Messaging सेवा लौटानी है। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट Messaging सेवा वापस कर दी जाएगी।

रिटर्न:

मैसेजिंग.मैसेजिंग

यदि कोई ऐप उपलब्ध नहीं कराया गया है तो डिफ़ॉल्ट Messaging सेवा या दिए गए ऐप से जुड़ी Messaging सेवा।

उदाहरण 1

// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();

उदाहरण 2

// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);

परियोजना प्रबंधन()

डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए ProjectManagement सेवा प्राप्त होती है।

डिफ़ॉल्ट ऐप की ProjectManagement सेवा तक पहुंचने के लिए admin.projectManagement() बिना किसी तर्क के कॉल किया जा सकता है, या किसी विशिष्ट ऐप से जुड़ी ProjectManagement सेवा तक पहुंचने के लिए admin.projectManagement(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function projectManagement(app?: App): projectManagement.ProjectManagement;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग वैकल्पिक ऐप जिसकी ProjectManagement सेवा वापस आनी है। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट ProjectManagement सेवा वापस कर दी जाएगी। *

रिटर्न:

प्रोजेक्टमैनेजमेंट.प्रोजेक्टमैनेजमेंट

यदि कोई ऐप उपलब्ध नहीं कराया गया है तो डिफ़ॉल्ट ProjectManagement सेवा या दिए गए ऐप से जुड़ी ProjectManagement सेवा।

उदाहरण 1

// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();

उदाहरण 2

// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);

रिमोट कॉन्फिग()

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

डिफ़ॉल्ट ऐप की RemoteConfig सेवा तक पहुंचने के लिए admin.remoteConfig() बिना किसी तर्क के कॉल किया जा सकता है या किसी विशिष्ट ऐप से जुड़ी RemoteConfig सेवा तक पहुंचने के लिए admin.remoteConfig(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग RemoteConfig सेवा लौटाने के लिए वैकल्पिक ऐप। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट RemoteConfig सेवा वापस कर दी जाती है।

रिटर्न:

रिमोटकॉन्फिग.रिमोटकॉन्फिग

यदि कोई ऐप उपलब्ध नहीं कराया गया है तो डिफ़ॉल्ट RemoteConfig सेवा, या दिए गए ऐप से जुड़ी RemoteConfig सेवा।

उदाहरण 1

// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();

उदाहरण 2

// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);

सुरक्षा नियम()

डिफ़ॉल्ट ऐप या किसी दिए गए ऐप के लिए SecurityRules सेवा प्राप्त होती है।

डिफ़ॉल्ट ऐप की SecurityRules सेवा तक पहुंचने के लिए admin.securityRules() बिना किसी तर्क के कॉल किया जा सकता है, या किसी विशिष्ट ऐप से जुड़ी SecurityRules सेवा तक पहुंचने के लिए admin.securityRules(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function securityRules(app?: App): securityRules.SecurityRules;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग SecurityRules सेवा वापस करने के लिए वैकल्पिक ऐप। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट SecurityRules सेवा वापस कर दी जाती है।

रिटर्न:

सुरक्षानियम.सुरक्षानियम

यदि कोई ऐप उपलब्ध नहीं कराया गया है तो डिफ़ॉल्ट SecurityRules सेवा, या दिए गए ऐप से जुड़ी SecurityRules सेवा।

उदाहरण 1

// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();

उदाहरण 2

// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);

भंडारण()

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

डिफ़ॉल्ट ऐप की Storage सेवा तक पहुंचने के लिए admin.storage() बिना किसी तर्क के या किसी विशिष्ट ऐप से जुड़ी Storage सेवा तक पहुंचने के लिए admin.storage(app) के रूप में कॉल किया जा सकता है।

हस्ताक्षर:

export declare function storage(app?: App): storage.Storage;

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग अनुप्रयोग

रिटर्न:

भंडारण.भंडारण

उदाहरण 1

// Get the Storage service for the default app
var defaultStorage = admin.storage();

उदाहरण 2

// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);

ऐप्स

हस्ताक्षर:

apps: (app.App | null)[]

SDK_संस्करण

हस्ताक्षर:

SDK_VERSION: string