app package

אפליקציית Firebase

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

פונקציות

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

ממשקים

מִמְשָׁק תיאור
FirebaseApp FirebaseApp מחזיק את פרטי האתחול עבור אוסף שירותים. אל תתקשר ישירות לבנאי זה. במקום זאת, השתמש ב-initializeApp() כדי ליצור אפליקציה.
FirebaseAppSettings אפשרויות תצורה שניתנו ל- initiizeApp()
FirebaseOptions אובייקט תצורה של Firebase. מכיל קבוצה של פרמטרים הנדרשים לשירותים כדי לתקשר בהצלחה עם ממשקי API של שרת Firebase ולשייך נתוני לקוח לפרויקט Firebase וליישום Firebase שלך. בדרך כלל אובייקט זה מאוכלס על ידי מסוף Firebase בעת הגדרת הפרויקט. ראה גם: למד על אובייקט התצורה של Firebase .

משתנים

מִשְׁתַנֶה תיאור
SDK_VERSION גרסת ה-SDK הנוכחית.

פונקציה (אפליקציה,...)

deleteApp(אפליקציה)

הופך את האפליקציה הזו ללא שמישה ומשחרר את המשאבים של כל השירותים הקשורים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה FirebaseApp

החזרות:

הבטחה<void>

דוגמא

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

פוּנקצִיָה()

getApps()

מערך (לקריאה בלבד) של כל האפליקציות המאתחלות.

חֲתִימָה:

export declare function getApps(): FirebaseApp[];

החזרות:

FirebaseApp []

initializeApp()

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

חֲתִימָה:

export declare function initializeApp(): FirebaseApp;

החזרות:

FirebaseApp

function(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

רושם שם וגרסה של ספרייה למטרות רישום פלטפורמה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
libraryKeyOrName חוּט
גִרְסָה חוּט הגרסה הנוכחית של הספרייה.
גִרְסָה אַחֶרֶת חוּט וריאנט צרור, למשל, צומת, rn וכו'.

החזרות:

בָּטֵל

function(logCallback, ...)

onLog(logCallback, אפשרויות)

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

חֲתִימָה:

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

פרמטרים

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

החזרות:

בָּטֵל

function(logLevel, ...)

setLogLevel(logLevel)

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

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

חֲתִימָה:

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

פרמטרים

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

החזרות:

בָּטֵל

פונקציה (שם,...)

getApp(שם)

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

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

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

חֲתִימָה:

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

פונקציה (אפשרויות,...)

initializeApp(אפשרויות, שם)

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

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

חֲתִימָה:

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

initializeApp (אפשרויות, תצורה)

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

חֲתִימָה:

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

פרמטרים

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

החזרות:

FirebaseApp

SDK_VERSION

גרסת ה-SDK הנוכחית.

חֲתִימָה:

SDK_VERSION: string