firebase-admin package

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

الوظائف

الوظيفة الوصف
app(name)
appCheck(app) يمكن الحصول على خدمة AppCheck للتطبيق التلقائي أو لتطبيق معيّن.يمكن استدعاء admin.appCheck() بدون وسيطات للوصول إلى خدمة AppCheck للتطبيق التلقائي أو طلبه كـ admin.appCheck(app) للوصول إلى خدمة AppCheck المرتبطة بتطبيق معيّن.
auth(app) يتم الحصول على خدمة Auth للتطبيق التلقائي أو لتطبيق محدَّد.يمكن استدعاء admin.auth() بدون وسيطات للوصول إلى خدمة Auth في التطبيق التلقائي، أو كـ admin.auth(app) للوصول إلى خدمة Auth المرتبطة بتطبيق معيّن.
database(app) يمكن الحصول على خدمة Database للتطبيق التلقائي أو لتطبيق معيّن.يمكن استدعاء admin.database() بدون وسيطات للوصول إلى خدمة Database للتطبيق التلقائي أو طلب admin.database(app) للوصول إلى خدمة Database المرتبطة بتطبيق معيّن.admin.database هي أيضًا مساحة اسم يمكن استخدامها للوصول إلى الثوابت العامة والطرق المرتبطة بخدمة Database.
firestore(app)
ConfigureizeApp(options, name)
عمليات التثبيت(التطبيقات) تتيح هذه السياسة الحصول على خدمة عمليات التثبيت للتطبيق التلقائي أو لتطبيق محدَّد.يمكن استدعاء admin.installations() بدون وسيطات للوصول إلى خدمة عمليات التثبيت التلقائية، أو طلب admin.installations(app) للوصول إلى خدمة عمليات التثبيت المرتبطة بتطبيق معيّن.
instanceId(app) يمكن الحصول على خدمة InstanceId للتطبيق التلقائي أو لتطبيق معيّن.يمكن طلب admin.instanceId() بدون وسيطات للوصول إلى خدمة InstanceId في التطبيق التلقائي أو طلب admin.instanceId(app) للوصول إلى خدمة InstanceId المرتبطة بتطبيق معيّن.
machineLearning(app) يمكن الحصول على خدمة MachineLearning للتطبيق التلقائي أو لتطبيق معيَّن.يمكن استدعاء admin.machineLearning() بدون وسيطات للوصول إلى خدمة MachineLearning للتطبيق التلقائي أو طلبه كـ admin.machineLearning(app) للوصول إلى خدمة MachineLearning المرتبطة بتطبيقٍ معيّن.
Messenger(app) يمكن الحصول على خدمة المراسلة للتطبيق التلقائي أو لتطبيق معيّن.يمكن استدعاء 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 المرتبطة بتطبيق معيّن.
securityقاعد(التطبيق) يمكنك الحصول على خدمة SecurityRules للتطبيق التلقائي أو لتطبيق معيّن.يمكن طلب admin.securityRules() بدون وسيطات للوصول إلى خدمة SecurityRules في التطبيق التلقائي، أو كـ admin.securityRules(app) للوصول إلى خدمة SecurityRules المرتبطة بتطبيق معيّن.
storage(app) يمكن الحصول على خدمة مساحة التخزين للتطبيق التلقائي أو لتطبيق معيّن.ويمكن استدعاء admin.storage() بدون وسيطات للوصول إلى خدمة Storage في التطبيق التلقائي، أو طلب admin.storage(app) للوصول إلى خدمة Storage المرتبطة بتطبيق معيّن.

الواجهات

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

مساحات الاسم

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

المتغيرات

متغير الوصف
التطبيقات
الإصدار_الإصدار_من حزمة تطوير البرامج (SDK)

app(name)

Signature:

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

المَعلمات

المَعلمة Type الوصف
الاسم سلسلة

المرتجعات:

app.App

appCheck(app)

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

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

Signature:

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

المَعلمات

المَعلمة Type الوصف
التطبيق التطبيق التطبيق الاختياري الذي يتم عرض خدمة 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;

المَعلمات

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

المرتجعات:

المصادقة

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

admin.database هي أيضًا مساحة اسم يمكن استخدامها للوصول إلى الثوابت العامة والطرق المرتبطة بخدمة Database.

Signature:

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

المَعلمات

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

المرتجعات:

قاعدة البيانات.قاعدة البيانات

خدمة 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;

المَعلمات

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

المرتجعات:

_firestore.Firestore

originizeApp(options, name)

Signature:

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

المَعلمات

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

المرتجعات:

app.App

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

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

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

Signature:

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

المَعلمات

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

exampleId(app)

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

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

Signature:

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

المَعلمات

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

المَعلمات

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

المَعلمات

المَعلمة Type الوصف
التطبيق التطبيق التطبيق الاختياري الذي سيتم إرجاع خدمة Messaging إليه. وفي حال عدم توفيرها، سيتم عرض خدمة Messaging التلقائية.

المرتجعات:

Messenger

خدمة 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;

المَعلمات

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

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

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

Signature:

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

المَعلمات

المَعلمة Type الوصف
التطبيق التطبيق التطبيق الاختياري الذي يتم عرض خدمة 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;

المَعلمات

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

المَعلمات

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

المرتجعات:

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