firebase-admin.app package

إعداد حزمة تطوير البرامج (SDK) وتطبيق Firebase.

الوظائف

الوظيفة الوصف
ApplicationDefault(httpAgent) لعرض بيانات اعتماد تم إنشاؤها من بيانات الاعتماد التلقائية لتطبيقات Google والتي تمنح إذن وصول إداري إلى خدمات Firebase. يمكن استخدام بيانات الاعتماد هذه في استدعاء الدالة ConfigureizeApp().تتوفّر بيانات الاعتماد التلقائية لتطبيق Google على أي بنية أساسية من Google، مثل Google App Engine وGoogle Compute Engine.يمكنك الاطّلاع على إعداد SDK للحصول على مزيد من التفاصيل.
cert(serviceAccountPathOrObject, httpAgent) لعرض بيانات اعتماد تم إنشاؤها من حساب الخدمة المقدَّم الذي يمنح إمكانية وصول إداري إلى خدمات Firebase. ويمكن استخدام بيانات الاعتماد هذه في الإجراء previousizeApp().يمكنك الاطّلاع على إعداد حزمة SDK لمزيد من التفاصيل.
deleteApp(app) يؤدي إلى عرض هذا العنصر App غير قابل للاستخدام وتحرير موارد جميع الخدمات المرتبطة به (مع أنه *لا* يؤدي إلى تنظيف أي موارد خلفية). عند تشغيل حزمة SDK محليًا، يجب طلب هذه الطريقة لضمان الإنهاء السلس للعملية.
getApp(appName)
getApps()
preizeApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) تعرض بيانات اعتماد تم إنشاؤها من الرمز المميّز لإعادة التحميل المقدَّم الذي يمنح إمكانية وصول إداري إلى خدمات Firebase. ويمكن استخدام بيانات الاعتماد هذه في الإجراء previousizeApp().يمكنك الاطّلاع على إعداد حزمة SDK لمزيد من التفاصيل.

الواجهات

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

المتغيرات

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

appDefault(httpAgent)

لعرض بيانات اعتماد تم إنشاؤها من بيانات الاعتماد التلقائية لتطبيقات Google والتي تمنح إذن وصول إداري إلى خدمات Firebase. يمكن استخدام بيانات الاعتماد هذه في الطلب إلى previousizeApp().

تتوفر بيانات الاعتماد التلقائية لتطبيق Google على أي بنية أساسية من Google، مثل Google App Engine وGoogle Compute Engine.

راجع إعداد حزمة SDK لمزيد من التفاصيل.

Signature:

export declare function applicationDefault(httpAgent?: Agent): Credential;

المَعلمات

المَعلمة Type الوصف
httpAgent الوكيل وكيل HTTP اختياري لاستخدامه عند استرداد رموز الدخول من خوادم رموز Google المميزة.

المرتجعات:

بيانات الاعتماد

هذه هي بيانات اعتماد تمت مصادقتها عبر بيانات الاعتماد التلقائية لتطبيق Google والتي يمكن استخدامها لإعداد أحد التطبيقات.

مثال

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert(serviceAccountPathOrObject, httpAgent)

لعرض بيانات اعتماد تم إنشاؤها من حساب الخدمة المقدَّم الذي يمنح إمكانية وصول إداري إلى خدمات Firebase. يمكن استخدام بيانات الاعتماد هذه في الطلب إلى previousizeApp().

راجع إعداد حزمة SDK لمزيد من التفاصيل.

Signature:

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

المَعلمات

المَعلمة Type الوصف
serviceAccountPathOrObject سلسلة | ServiceAccount المسار إلى ملف JSON لمفتاح حساب الخدمة أو عنصر يمثّل مفتاح حساب الخدمة.
httpAgent الوكيل وكيل HTTP اختياري لاستخدامه عند استرداد رموز الدخول من خوادم رموز Google المميزة.

المرتجعات:

بيانات الاعتماد

هي بيانات اعتماد تمت مصادقتها من خلال حساب الخدمة المقدَّم ويمكن استخدامها لإعداد تطبيق.

مثال 1

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

مثال 2

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

يؤدي إلى عرض هذا العنصر App غير قابل للاستخدام وتحرير موارد جميع الخدمات المرتبطة به (مع أنه *لا* يؤدي إلى تنظيف أي موارد خلفية). عند تشغيل حزمة SDK محليًا، يجب طلب هذه الطريقة لضمان الإنهاء السلس للعملية.

Signature:

export declare function deleteApp(app: App): Promise<void>;

المَعلمات

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

المرتجعات:

وعد: < لِتَنْفِيذْ ذَلِكْ

مثال

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp(appName)

Signature:

export declare function getApp(appName?: string): App;

المَعلمات

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

المرتجعات:

حملات التطبيقات

getApps()

Signature:

export declare function getApps(): App[];

المرتجعات:

التطبيق[]

originizeApp(options, appName)

Signature:

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

المَعلمات

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

المرتجعات:

حملات التطبيقات

renameToken(refreshTokenPathOrObject, httpAgent)

تعرض بيانات اعتماد تم إنشاؤها من الرمز المميّز لإعادة التحميل المقدَّم الذي يمنح إمكانية وصول إداري إلى خدمات Firebase. يمكن استخدام بيانات الاعتماد هذه في الطلب إلى previousizeApp().

راجع إعداد حزمة SDK لمزيد من التفاصيل.

Signature:

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

المَعلمات

المَعلمة Type الوصف
renameTokenPathOrObject سلسلة | كائن المسار إلى ملف JSON لرمز إعادة تحميل OAuth2 من Google، أو كائن يمثّل الرمز المميّز لإعادة تحميل Google OAuth2.
httpAgent الوكيل وكيل HTTP اختياري لاستخدامه عند استرداد رموز الدخول من خوادم رموز 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

Signature:

SDK_VERSION: string