firebase-admin package

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

الدوال

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

واجهات

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

مساحات الاسم

مساحة الاسم	الوصف
التطبيق
التحقّق من التطبيقات
المصادقة
بيانات الاعتماد
قاعدة بيانات
مخزن إطفاء
عمليات التثبيت
instanceId
تعلُّم الآلة
المراسلة
projectManagement
remoteConfig
securityRules
مساحة التخزين

المتغيرات

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

app(name)

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
الاسم	السلسلة

المرتجعات:

app.App

appCheck(app)

يحصل على خدمة AppCheck للتطبيق التلقائي أو تطبيق معيَّن.

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

Signature:

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);

auth(app)

الحصول على خدمة المصادقة للتطبيق التلقائي أو تطبيق معيَّن

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

Signature:

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.

Signature:

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

المَعلمات

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

المرتجعات:

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);

firestore(app)

Signature:

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

المَعلمات

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

المرتجعات:

_firestore.Firestore

startizeApp(options, name)

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
خيارات	خيارات AppOptions
الاسم	السلسلة

المرتجعات:

app.App

عمليات التثبيت(تطبيق)

يحصل على خدمة عمليات التثبيت للتطبيق التلقائي أو تطبيق معيَّن.

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

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
التطبيق	التطبيق	تطبيق اختياري مطلوب إرجاع خدمة Installations إليه. وفي حال عدم توفّره، سيتم عرض خدمة "Installations" التلقائية.

المرتجعات:

installations.installs (عمليات التثبيت)

خدمة 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 المرتبطة بتطبيق معيّن.

Signature:

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);

التعلم الآلي(app)

يمكن الحصول على خدمة MachineLearning للتطبيق التلقائي أو تطبيق معيَّن.

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

Signature:

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 المرتبطة بتطبيق معيّن.

Signature:

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

المَعلمات

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

يحصل على خدمة ProjectManagement للتطبيق التلقائي أو لتطبيق معيَّن.

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

Signature:

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

المَعلمات

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

عن بُعد(app)

تتيح هذه السياسة الحصول على خدمة RemoteConfig للتطبيق التلقائي أو تطبيق معيّن.

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

Signature:

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(app)

يحصل على خدمة SecurityRules للتطبيق التلقائي أو تطبيق معيَّن.

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

Signature:

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 المرتبطة بتطبيق معيّن.

Signature:

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

المَعلمات

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

المرتجعات:

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);

التطبيقات

Signature:

apps: (app.App | null)[]

إصدار SDK_VERSION

Signature:

SDK_VERSION: string