app package

تطبيق Firebase

تعمل هذه الحزمة على تنسيق الاتصال بين مكونات Firebase المختلفة

الدوال

الوظيفة	الوصف
الوظيفة(التطبيق، ...)
deleteApp(app)	يؤدي إلى عرض هذا التطبيق غير قابل للاستخدام وتحرير موارد جميع الخدمات المرتبطة به.
دالة())
getApps()	مصفوفة (للقراءة فقط) تتضمّن جميع التطبيقات التي تم إعدادها
initializeApp()	إنشاء مثيل FirebaseApp وإعداده.
الوظيفة(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)	تسجل اسم المكتبة وإصدارها لأغراض تسجيل النظام الأساسي.
الدالة(logCallback, ...)
onLog(logCallback, options)	تعمل هذه السياسة على ضبط معالج السجلّ لجميع حِزم تطوير البرامج (SDK) لمنصة Firebase.
الوظيفة(logLevel, ...)
setLogLevel(logLevel)	لضبط مستوى السجلّ لجميع حِزم تطوير البرامج (SDK) لمنصّة Firebase.يتم تسجيل جميع أنواع السجلّات الأعلى من مستوى السجلّ الحالي (أي في حال ضبط مستوى السجلّ على info، سيتم تسجيل الأخطاء، ولكن لا يتم تسجيل الأخطاء في سجلّات debug وverbose).
الدالة(الاسم، ...)
getApp(name)	يسترد مثيل FirebaseApp.عند الاتصال بدون وسيطات، يتم عرض التطبيق التلقائي. عند توفير اسم تطبيق، يتم عرض التطبيق المتوافق مع هذا الاسم.يتم طرح استثناء إذا لم يتم إعداد التطبيق الذي يتم استرداده بعد.
الوظيفة(الخيارات، ...)
ConfigureizeApp(options, name)	لإنشاء مثيل FirebaseApp وإعداده.يمكنك الاطّلاع على إضافة Firebase إلى تطبيقك وإعداد مشاريع متعددة للحصول على المستندات التفصيلية.
preizeApp(options, config)	إنشاء مثيل FirebaseApp وإعداده.
preizeServerApp(options, config)	لإنشاء مثيل FirebaseServerApp وإعداده.يتشابه FirebaseServerApp مع FirebaseApp، ولكنّه مخصّص للتنفيذ في بيئات العرض من جهة الخادم فقط. ستتعذّر عملية الإعداد إذا تم استدعاؤها من بيئة متصفّح.يمكنك الاطّلاع على إضافة Firebase إلى تطبيقك وإعداد مشاريع متعددة للحصول على مستندات تفصيلية.

واجهات

الواجهة	الوصف
FirebaseApp	يحتفظ FirebaseApp بمعلومات الإعداد لمجموعة من الخدمات.يُرجى عدم استدعاء هذه الدالة الإنشائية مباشرةً. بدلاً من ذلك، يمكنك استخدام initializeApp() لإنشاء تطبيق.
FirebaseAppSettings	خيارات الضبط المحدَّدة لـ initializeApp()
FirebaseOptions	كائن إعداد Firebase. يحتوي على مجموعة من المَعلمات المطلوبة للخدمات من أجل الاتصال بنجاح بواجهات برمجة تطبيقات خوادم Firebase وربط بيانات العميل بمشروعك على Firebase وتطبيق Firebase. تتم تعبئة هذا العنصر عادةً عن طريق "وحدة تحكُّم Firebase" عند إعداد المشروع. راجِع أيضًا: التعرّف على عنصر ضبط Firebase
FirebaseServerApp	يحتفظ FirebaseServerApp بمعلومات إعداد مجموعة من الخدمات التي يتم تشغيلها في بيئات الخوادم.لا تستدعي هذه الدالة الإنشائية مباشرةً. بدلاً من ذلك، يمكنك استخدام PrepareizeServerApp() لإنشاء تطبيق.
FirebaseServerAppSettings	خيارات الإعداد الممنوحة لـ PrimaryizeServerApp()

المتغيرات

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

الدالة(app, ...)

deleteApp(app)

يؤدي إلى عرض هذا التطبيق غير قابل للاستخدام وتحرير موارد جميع الخدمات المرتبطة به.

Signature:

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

المَعلمات

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

المرتجعات:

Promise<void>

مثال

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

الدالة()

getApps()

مصفوفة (للقراءة فقط) تتضمّن جميع التطبيقات التي تم إعدادها

Signature:

export declare function getApps(): FirebaseApp[];

المرتجعات:

FirebaseApp[]

initializeApp()

إنشاء مثيل FirebaseApp وإعداده.

Signature:

export declare function initializeApp(): FirebaseApp;

المرتجعات:

FirebaseApp

function(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

تسجل اسم المكتبة وإصدارها لأغراض تسجيل النظام الأساسي.

Signature:

export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;

المَعلمات

المَعلمة	النوع	الوصف
libraryKeyOrName	سلسلة
إصدار	سلسلة	الإصدار الحالي من تلك المكتبة.
خيار المنتج	سلسلة	صيغة الحزمة، على سبيل المثال، العقدة، n، إلخ.

المرتجعات:

void

الدالة(logCallback, ...)

onLog(logCallback, options)

تعمل هذه السياسة على ضبط معالج السجلّ لجميع حِزم تطوير البرامج (SDK) لمنصة Firebase.

Signature:

export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;

المَعلمات

المَعلمة	النوع	الوصف
logCallback	معاودة الاتصال بالسجلّ | قيمة فارغة	يشير ذلك المصطلح إلى معالِج سجلّات مخصَّص اختياري ينفِّذ رمز المستخدِم عندما تُجري حزمة تطوير البرامج (SDK) لمنصّة Firebase طلب تسجيل.
الخيارات	LogOptions

المرتجعات:

void

الدالة(logLevel, ...)

setLogLevel(logLevel)

لضبط مستوى السجلّ لجميع حِزم تطوير البرامج (SDK) لمنصّة Firebase

يتم تسجيل جميع أنواع السجلّات الأعلى من مستوى السجلّ الحالي (أي في حال ضبط مستوى السجلّ على info، سيتم تسجيل الأخطاء، ولكن لا يتم تسجيل الأخطاء في سجلّات debug وverbose).

Signature:

export declare function setLogLevel(logLevel: LogLevelString): void;

المَعلمات

المَعلمة	النوع	الوصف
logLevel	LogLevelString

المرتجعات:

void

الدالة(الاسم، ...)

getApp(name)

يسترد مثيل FirebaseApp.

عند طلب البيانات بدون وسيطات، يتم عرض التطبيق التلقائي. عند توفير اسم تطبيق، يتم عرض التطبيق المتوافق مع هذا الاسم.

يتم طرح استثناء إذا لم يتم بعد إعداد التطبيق الذي يتم استرداده.

Signature:

export declare function getApp(name?: string): FirebaseApp;

المَعلمات

المَعلمة	النوع	الوصف
اسم	سلسلة	اسم اختياري للتطبيق المراد إرجاعه. إذا لم يتم تقديم أي اسم، ستكون القيمة التلقائية "[DEFAULT]".

المرتجعات:

FirebaseApp

التطبيق المتوافق مع اسم التطبيق المقدَّم. إذا لم يتم إدخال اسم تطبيق، يتم عرض التطبيق التلقائي.

مثال 1

// Return the default app
const app = getApp();

مثال 2

// Return a named app
const otherApp = getApp("otherApp");

الدالة(الخيارات، ...)

originizeApp(options, name)

إنشاء مثيل FirebaseApp وإعداده.

راجِع مقالة إضافة Firebase إلى تطبيقك وإعداد مشاريع متعددة للحصول على مستندات تفصيلية.

Signature:

export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;

المَعلمات

المَعلمة	النوع	الوصف
الخيارات	FirebaseOptions	خيارات ضبط خدمات التطبيق.
اسم	سلسلة	الاسم الاختياري للتطبيق المطلوب إعداده. إذا لم يتم تقديم أي اسم، ستكون القيمة التلقائية "[DEFAULT]".

المرتجعات:

FirebaseApp

التطبيق الذي تم إعداده.

مثال 1

// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
  apiKey: "AIza....",                             // Auth / General Use
  authDomain: "YOUR_APP.firebaseapp.com",         // Auth with popup/redirect
  databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
  storageBucket: "YOUR_APP.appspot.com",          // Storage
  messagingSenderId: "123456789"                  // Cloud Messaging
});

مثال 2

// Initialize another app
const otherApp = initializeApp({
  databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
  storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");

originizeApp(options, config)

إنشاء مثيل FirebaseApp وإعداده.

Signature:

export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;

المَعلمات

المَعلمة	النوع	الوصف
الخيارات	FirebaseOptions	خيارات ضبط خدمات التطبيق.
config	FirebaseAppSettings	إعداد تطبيق Firebase

المرتجعات:

FirebaseApp

originizeServerApp(options, config)

إنشاء مثيل FirebaseServerApp وإعداده.

تشبه السمة FirebaseServerApp FirebaseApp، ولكنها مصمّمة للتنفيذ في بيئات العرض من جهة الخادم فقط. ستفشل عملية الإعداد في حال استدعائها من بيئة متصفّح.

راجِع مقالة إضافة Firebase إلى تطبيقك وإعداد مشاريع متعددة للحصول على مستندات تفصيلية.

Signature:

export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;

المَعلمات

المَعلمة	النوع	الوصف
الخيارات	FirebaseOptions | FirebaseApp	Firebase.AppOptions لضبط خدمات التطبيق، أو مثيل FirebaseApp الذي يحتوي على AppOptions بداخله.
config	FirebaseServerAppSettings	إعداد FirebaseServerApp.

المرتجعات:

FirebaseServerApp

تم إعداد FirebaseServerApp.

مثال

// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
    apiKey: "AIza....",                             // Auth / General Use
    authDomain: "YOUR_APP.firebaseapp.com",         // Auth with popup/redirect
    databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
    storageBucket: "YOUR_APP.appspot.com",          // Storage
    messagingSenderId: "123456789"                  // Cloud Messaging
  },
  {
   authIdToken: "Your Auth ID Token"
  });

SDK_VERSION

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

Signature:

SDK_VERSION: string