firebase-admin.app package

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

الدوال

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

صفوف

الفئة الوصف
AppErrorCodes رموز الخطأ في عميل التطبيقات ورسائلها التلقائية
خطأ FirebaseAppError بنية رمز خطأ التطبيق في Firebase. يؤدي ذلك إلى تمديد PrefixedFirebaseError.

واجهات

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

المتغيرات

متغير الوصف
SDK_VERSION

applicationDefault(httpAgent)

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

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

راجِع إعداد حزمة تطوير البرامج (SDK) للحصول على مزيد من التفاصيل.

Signature:

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

المَعلمات

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

المرتجعات:

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

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

مثال

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

cert(serviceAccountPathOrObject, httpAgent)

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

راجِع إعداد حزمة تطوير البرامج (SDK) للحصول على مزيد من التفاصيل.

Signature:

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

المَعلمات

المعلمة النوع الوصف
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>;

المَعلمات

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

المرتجعات:

وعود <باطلة>

مثال

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;

المَعلمات

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

المرتجعات:

التطبيق

getApps()

Signature:

export declare function getApps(): App[];

المرتجعات:

التطبيق[]

startizeApp(options, appName)

Signature:

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

المَعلمات

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

المرتجعات:

التطبيق

refreshToken(refreshTokenPathOrObject, httpAgent)

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

راجِع إعداد حزمة تطوير البرامج (SDK) للحصول على مزيد من التفاصيل.

Signature:

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

المَعلمات

المعلمة النوع الوصف
UpdateTokenPathOrObject سلسلة | كائن المسار إلى ملف JSON للرمز المميز لتحديث Google OAuth2 أو كائن يمثل الرمز المميز لتحديث 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