app package

אפליקציית Firebase

החבילה הזו מרכזת את התקשורת בין הרכיבים השונים של Firebase

פונקציות

פעולה	תיאור
function(app, ...)
deleteApp(app)	רינדור האפליקציה הזו ללא שימוש ומשחרר את המשאבים של כל השירותים המשויכים.
function()
getApps()	מערך (לקריאה בלבד) של כל האפליקציות שאותחלו.
initializeApp()	יצירה והפעלה של מופע FirebaseApp.
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)	רישום השם והגרסה של הספרייה למטרות רישום ביומן של הפלטפורמה.
function(logCallback, ...)
onLog(logCallback, options)	הגדרת handler של יומן לכל ערכות ה-SDK של Firebase.
function(logLevel, ...)
setLogLevel(logLevel)	מגדירה את רמת היומן לכל ערכות ה-SDK של Firebase.כל סוגי היומנים שמעל לרמת היומן הנוכחית מתועדים (כלומר, אם מגדירים את רמת היומן ל-info, השגיאות מתועדות, אבל היומנים debug ו-verbose לא מתועדים).
function(name, ...)
getApp(name)	מאחזרת מופע של FirebaseApp.כשהקריאה לא מופעלת ללא ארגומנטים, האפליקציה המוגדרת כברירת מחדל מוחזרת. כשמספקים שם לאפליקציה, מוחזרת האפליקציה עם השם הזה.המערכת שולחת הודעת חריג אם האפליקציה לא אוחזרה עדיין.
function(options, ...)
firstizeApp(options, name)	יצירה והפעלה של מופע FirebaseApp.לתיעוד מפורט, אפשר לעיין בהוספת Firebase לאפליקציה והפעלה של מספר פרויקטים.
firstizeApp(options, config)	יצירה והפעלה של מופע FirebaseApp.
firstizeServerApp(options, config)	יצירה והפעלה של מופע FirebaseServerApp.ה-FirebaseServerApp דומה ל-FirebaseApp, אבל מיועד להפעלה בסביבות רינדור בצד השרת בלבד. אם תפעילו את האתחול מסביבת דפדפן, האתחול ייכשל.להנחיות מפורטות, ניתן לעיין במאמר הוספת Firebase לאפליקציה והפעלה של מספר פרויקטים.

ממשקים

ממשק	תיאור
FirebaseApp	FirebaseApp מכילה את פרטי האתחול של אוסף שירותים.אין לקרוא למבנה הזה ישירות. במקום זאת, צריך להשתמש ב-initializeApp() כדי ליצור אפליקציה.
FirebaseAppSettings	אפשרויות ההגדרה שניתנו ל-initializeApp()
FirebaseOptions	אובייקט הגדרת Firebase. התוסף מכיל קבוצת פרמטרים שנדרשים לשירותים כדי לתקשר עם ממשקי ה-API של שרת Firebase ולשייך את נתוני הלקוחות לפרויקט Firebase ולאפליקציית Firebase. בדרך כלל האובייקט הזה מאוכלס במסוף Firebase בזמן הגדרת הפרויקט. למידע נוסף: מידע על אובייקט התצורה של Firebase.
FirebaseServerApp	FirebaseServerApp מכיל את פרטי האתחול של אוסף שירותים שפועלים בסביבות שרתים.אין לקרוא ל-builder הזה באופן ישיר. במקום זאת, צריך להשתמש ב-InitializeServerApp() כדי ליצור אפליקציה.
FirebaseServerAppSettings	אפשרויות ההגדרה שניתנו ל-InitializeServerApp()

משתנים

משתנה	תיאור
SDK_VERSION	גרסת ה-SDK הנוכחית.

function(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);
  });

function()

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	מחרוזת
גרסה	מחרוזת	הגרסה הנוכחית של הספרייה הזו.
variant	מחרוזת	הווריאנט של החבילה, למשל: צומת, rn וכו'.

החזרות:

void

function(logCallback, ...)

onLog(logCallback, options)

הגדרת handler של יומן לכל ערכות ה-SDK של Firebase.

Signature:

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

פרמטרים

פרמטר	סוג	תיאור
logCallback	LogCallback | null	handler אופציונלי של יומן רישום, שמפעיל קוד משתמש בכל פעם שה-SDK של Firebase מבצע קריאה לרישום ביומן.
אפשרויות	LogOptions

החזרות:

void

function(logLevel, ...)

setLogLevel(logLevel)

מגדירה את רמת היומן לכל ערכות ה-SDK של Firebase.

כל סוגי היומנים שמעל לרמת היומן הנוכחית מתועדים (כלומר, אם הגדרתם את רמת היומן כ-info, השגיאות מתועדות, אבל היומנים debug ו-verbose לא מתועדים).

Signature:

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

פרמטרים

פרמטר	סוג	תיאור
logLevel	LogLevelString

החזרות:

void

function(name, ...)

getApp(name)

מאחזרת מופע של FirebaseApp.

כשמתבצעת קריאה ללא ארגומנטים, המערכת מחזירה את אפליקציית ברירת המחדל. כשמספקים שם אפליקציה, מוחזרת האפליקציה עם השם הזה.

מתקבלת הודעה חריגה אם האפליקציה שמאוחזרת עדיין לא הופעלה.

Signature:

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

פרמטרים

פרמטר	סוג	תיאור
name	מחרוזת	השם האופציונלי של האפליקציה להחזרה. אם לא תזינו שם, ברירת המחדל תהיה "[DEFAULT]".

החזרות:

FirebaseApp

האפליקציה שתואמת לשם האפליקציה שצוין. אם לא מזינים שם לאפליקציה, תוחזר אפליקציית ברירת המחדל.

דוגמה 1

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

דוגמה 2

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

function(options, ...)

startizeApp(options, name)

יצירה והפעלה של מופע FirebaseApp.

לקבלת מידע מפורט, אפשר לעיין במאמרים הוספת Firebase לאפליקציה והפעלה של מספר פרויקטים.

Signature:

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

פרמטרים

פרמטר	סוג	תיאור
אפשרויות	FirebaseOptions	אפשרויות להגדרת השירותים של האפליקציה.
name	מחרוזת	שם אופציונלי של האפליקציה שרוצים להפעיל. אם לא תזינו שם, ברירת המחדל תהיה "[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");

startizeApp(options, config)

יצירה והפעלה של מופע FirebaseApp.

Signature:

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

פרמטרים

פרמטר	סוג	תיאור
אפשרויות	FirebaseOptions	אפשרויות להגדרת השירותים של האפליקציה.
config	FirebaseAppSettings	הגדרת FirebaseApp

החזרות:

FirebaseApp

startizeServerApp(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