firebase-admin package

واجهة برمجة تطبيقات Firebase ذات مساحة الاسم (قديمة).

المهام

وظيفة وصف
اسم التطبيق)
التحقق من التطبيق (التطبيق) الحصول على خدمة AppCheck للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.appCheck() بدون أي وسيطات للوصول إلى خدمة AppCheck الخاصة بالتطبيق الافتراضي أو باسم admin.appCheck(app) للوصول إلى خدمة AppCheck المرتبطة بتطبيق معين.
مصادقة (التطبيق) يحصل على خدمة المصادقة للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.auth() بدون وسائط للوصول إلى خدمة المصادقة الخاصة بالتطبيق الافتراضي أو كـ admin.auth(app) للوصول إلى خدمة المصادقة المرتبطة بتطبيق معين.
قاعدة البيانات (التطبيق) يحصل على خدمة قاعدة البيانات للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.database() بدون وسائط للوصول إلى خدمة Database التطبيق الافتراضي أو باسم admin.database(app) للوصول إلى خدمة Database المرتبطة بتطبيق معين. تعد admin.database أيضًا مساحة اسم يمكن استخدامها للوصول إلى الثوابت والأساليب العامة المرتبطة بخدمة Database .
متجر النار (التطبيق)
تهيئة التطبيق (الخيارات، الاسم)
التثبيتات (التطبيق) يحصل على خدمة التثبيتات للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.installations() بدون وسائط للوصول إلى خدمة التثبيتات الخاصة بالتطبيق الافتراضي أو باسم admin.installations(app) للوصول إلى خدمة التثبيتات المرتبطة بتطبيق معين.
معرف المثيل (التطبيق) الحصول على خدمة InstanceId للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.instanceId() بدون وسائط للوصول إلى خدمة InstanceId للتطبيق الافتراضي أو ك admin.instanceId(app) للوصول إلى خدمة InstanceId المرتبطة بتطبيق معين.
التعلم الآلي (التطبيق) الحصول على خدمة MachineLearning للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.machineLearning() بدون وسائط للوصول إلى خدمة MachineLearning الخاصة بالتطبيق الافتراضي أو ك admin.machineLearning(app) للوصول إلى خدمة MachineLearning المرتبطة بتطبيق معين.
المراسلة (التطبيق) يحصل على خدمة المراسلة للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.messaging() بدون وسائط للوصول إلى خدمة Messaging الخاصة بالتطبيق الافتراضي أو ك admin.messaging(app) للوصول إلى خدمة Messaging المرتبطة بتطبيق معين.
إدارة المشاريع (التطبيق) الحصول على خدمة ProjectManagement للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.projectManagement() بدون أي وسيطات للوصول إلى خدمة ProjectManagement الخاصة بالتطبيق الافتراضي، أو باسم admin.projectManagement(app) للوصول إلى خدمة ProjectManagement المرتبطة بتطبيق معين.
التكوين عن بعد (التطبيق) يحصل على خدمة RemoteConfig للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.remoteConfig() بدون وسائط للوصول إلى خدمة RemoteConfig الخاصة بالتطبيق الافتراضي أو باسم admin.remoteConfig(app) للوصول إلى خدمة RemoteConfig المرتبطة بتطبيق معين.
قواعد الأمان (التطبيق) يحصل على خدمة SecurityRules للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.securityRules() بدون وسائط للوصول إلى خدمة SecurityRules للتطبيق الافتراضي، أو ك admin.securityRules(app) للوصول إلى خدمة SecurityRules المرتبطة بتطبيق معين.
التخزين (التطبيق) يحصل على خدمة التخزين للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.storage() بدون وسائط للوصول إلى خدمة Storage الخاصة بالتطبيق الافتراضي أو كـ admin.storage(app) للوصول إلى خدمة Storage المرتبطة بتطبيق معين.

واجهات

واجهه المستخدم وصف
خيارات التطبيق الخيارات المتاحة لتمريرها إلى تهيئةApp () .
FirebaseArrayIndexError النوع المركب الذي يتضمن كائن FirebaseError وفهرسًا يمكن استخدامه للحصول على العنصر الذي به خطأ.
خطأ فيريباسي FirebaseError هو فئة فرعية من كائن JavaScript Error القياسي. بالإضافة إلى سلسلة الرسائل وتتبع المكدس، فهو يحتوي على رمز سلسلة.
GoogleOAuthAccessToken واجهة لرموز الوصول الخاصة بـ Google OAuth 2.0.
حساب الخدمة

مساحات الأسماء

مساحة الاسم وصف
برنامج
appCheck
مصادقة
الاعتماد
قاعدة البيانات
firestore
المنشآت
معرف المثيل
التعلم الالي
المراسلة
ادارة مشروع
RemoteConfig
SecurityRules
تخزين

المتغيرات

عامل وصف
تطبيقات
SDK_VERSION

برنامج()

إمضاء:

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

حدود

معامل يكتب وصف
اسم خيط

عائدات:

app.App

فحص التطبيق ()

الحصول على خدمة AppCheck للتطبيق الافتراضي أو تطبيق معين.

يمكن استدعاء admin.appCheck() بدون أي وسيطات للوصول إلى خدمة AppCheck الخاصة بالتطبيق الافتراضي أو باسم admin.appCheck(app) للوصول إلى خدمة AppCheck المرتبطة بتطبيق معين.

إمضاء:

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

حدود

معامل يكتب وصف
برنامج برنامج تطبيق اختياري لإرجاع خدمة 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;

حدود

معامل يكتب وصف
برنامج برنامج

عائدات:

مصادقة

مثال 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);

قاعدة البيانات()

يحصل على خدمة قاعدة البيانات للتطبيق الافتراضي أو تطبيق معين.

يمكن استدعاء admin.database() بدون وسائط للوصول إلى خدمة Database التطبيق الافتراضي أو باسم admin.database(app) للوصول إلى خدمة Database المرتبطة بتطبيق معين.

تعد 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;

حدود

معامل يكتب وصف
برنامج برنامج

عائدات:

_firestore.Firestore

تهيئة التطبيق ()

إمضاء:

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

حدود

معامل يكتب وصف
خيارات خيارات التطبيق
اسم خيط

عائدات:

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 للتطبيق الافتراضي أو تطبيق معين.

يمكن استدعاء admin.instanceId() بدون وسائط للوصول إلى خدمة InstanceId للتطبيق الافتراضي أو ك admin.instanceId(app) للوصول إلى خدمة InstanceId المرتبطة بتطبيق معين.

إمضاء:

export declare function instanceId(app?: App): 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) للوصول إلى خدمة MachineLearning المرتبطة بتطبيق معين.

إمضاء:

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

حدود

معامل يكتب وصف
برنامج برنامج تطبيق اختياري ستعود خدمة 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);

المراسلة ()

يحصل على خدمة المراسلة للتطبيق الافتراضي أو تطبيق معين.

يمكن استدعاء admin.messaging() بدون وسائط للوصول إلى خدمة Messaging الخاصة بالتطبيق الافتراضي أو ك admin.messaging(app) للوصول إلى خدمة Messaging المرتبطة بتطبيق معين.

إمضاء:

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 للتطبيق الافتراضي أو تطبيق معين.

يمكن استدعاء admin.projectManagement() بدون أي وسيطات للوصول إلى خدمة ProjectManagement الخاصة بالتطبيق الافتراضي، أو باسم admin.projectManagement(app) للوصول إلى خدمة ProjectManagement المرتبطة بتطبيق معين.

إمضاء:

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) للوصول إلى خدمة RemoteConfig المرتبطة بتطبيق معين.

إمضاء:

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

حدود

معامل يكتب وصف
برنامج برنامج التطبيق الاختياري الذي يمكن من خلاله إرجاع خدمة 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 للتطبيق الافتراضي أو تطبيق معين.

يمكن استدعاء admin.securityRules() بدون وسائط للوصول إلى خدمة SecurityRules للتطبيق الافتراضي، أو ك admin.securityRules(app) للوصول إلى خدمة SecurityRules المرتبطة بتطبيق معين.

إمضاء:

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

حدود

معامل يكتب وصف
برنامج برنامج تطبيق اختياري لإرجاع خدمة 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);

تخزين()

يحصل على خدمة التخزين للتطبيق الافتراضي أو تطبيق معين.

يمكن استدعاء admin.storage() بدون وسائط للوصول إلى خدمة Storage الخاصة بالتطبيق الافتراضي أو كـ admin.storage(app) للوصول إلى خدمة Storage المرتبطة بتطبيق معين.

إمضاء:

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_VERSION

إمضاء:

SDK_VERSION: string