app package

تطبيق Firebase

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

الدوال

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

واجهات

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

المتغيرات

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

function(app, ...)

deleteApp(app)

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

مثال

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[];

المرتجعات:

تطبيق Firebase[]

تهيئة التطبيق()

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

Signature:

export declare function initializeApp(): FirebaseApp;

المرتجعات:

تطبيق Firebase

function(libraryKeyOrName, ...)

recordVersion(libraryKeyOrName, version, Variant)

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

Signature:

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

المَعلمات

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

المرتجعات:

فراغ

function(logCallback, ...)

onLog(logCallback, options)

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

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
تسجيل معاودة الاتصال	LogCallback | فارغ	هو معالج سجلّ مخصَّص اختياري ينفِّذ رمز المستخدم عندما تُجري حزمة تطوير البرامج (SDK) لمنصّة Firebase طلب تسجيل.
خيارات	خيارات التسجيل

المرتجعات:

فراغ

function(logLevel, ...)

setLogLevel(logLevel)

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

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

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
مستوى السجلّ	LogLevelString

المرتجعات:

فراغ

function(name, ...)

getApp(name)

يسترد FirebaseApp.

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

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

Signature:

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

المَعلمات

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

المرتجعات:

تطبيق Firebase

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

مثال 1

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

مثال 2

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

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

startizeApp(options, name)

تُنشئ هذه السياسة مثيل FirebaseApp وتضبطه.

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

Signature:

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

المَعلمات

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

المرتجعات:

تطبيق Firebase

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

مثال 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");

startizeApp(options, config)

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

Signature:

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

المَعلمات

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

المرتجعات:

تطبيق Firebase

startizeServerApp(options, config)

تُنشئ هذه السياسة مثيل FirebaseServerApp وتضبطه.

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

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

Signature:

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

المَعلمات

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