firebase-admin.app package

אתחול אפליקציית Firebase ו-SDK.

פונקציות

פוּנקצִיָה תיאור
applicationDefault(httpAgent) מחזיר אישורים שנוצרו מאישורי ברירת המחדל של Google Application המעניקים גישת מנהל לשירותי Firebase. ניתן להשתמש באישור זה בקריאה לאתחול App() . אישורי ברירת המחדל של Google Application זמינים בכל תשתית של Google, כגון Google App Engine ו-Google Compute Engine. ראה אתחול ה-SDK לפרטים נוספים.
cert(serviceAccountPathOrObject, httpAgent) מחזיר אישור שנוצר מחשבון השירות המסופק ומעניק גישת מנהל לשירותי Firebase. ניתן להשתמש באישור זה בקריאה לאתחול App() . ראה אתחול ה-SDK לפרטים נוספים.
deleteApp(אפליקציה) הופך את App הנתונה הזו לבלתי שמישה ומשחררת את המשאבים של כל השירותים המשויכים (אם כי היא *לא* מנקה משאבים עורפיים כלשהם). בעת הפעלת ה-SDK באופן מקומי, יש לקרוא לשיטה זו כדי להבטיח סיום חינני של התהליך.
getApp(שם אפליקציה)
getApps()
אתחול אפליקציה (אפשרויות, שם אפליקציה)
refreshToken(refreshTokenPathOrObject, httpAgent) מחזיר אישור שנוצר מאסימון הרענון שסופק המעניק גישת מנהל לשירותי Firebase. ניתן להשתמש באישור זה בקריאה לאתחול App() . ראה אתחול ה-SDK לפרטים נוספים.

ממשקים

מִמְשָׁק תיאור
אפליקציה אפליקציית Firebase מחזיקה את פרטי האתחול עבור אוסף שירותים.
AppOptions אפשרויות זמינות להעביר ל- initiizeApp() .
תְעוּדָה ממשק המספק אסימוני גישה של Google OAuth2 המשמשים לאימות עם שירותי Firebase. ברוב המקרים, לא תצטרך ליישם זאת בעצמך ובמקום זאת תוכל להשתמש ביישומי ברירת המחדל שסופקו על ידי מודול firebase-admin/app .
FirebaseArrayIndexError סוג מורכב הכולל גם אובייקט FirebaseError וגם אינדקס שניתן להשתמש בו כדי לקבל את הפריט השגוי.
FirebaseError FirebaseError היא תת-מחלקה של אובייקט JavaScript Error הסטנדרטי. בנוסף למחרוזת הודעה ומעקב מחסנית, היא מכילה קוד מחרוזת.
GoogleOAuthAccessToken ממשק עבור אסימוני גישה של Google OAuth 2.0.
חשבון שירות

משתנים

מִשְׁתַנֶה תיאור
SDK_VERSION

applicationDefault()

מחזיר אישורים שנוצרו מאישורי ברירת המחדל של Google Application המעניקים גישת מנהל לשירותי Firebase. ניתן להשתמש באישור זה בקריאה לאתחול App() .

אישורי ברירת המחדל של Google Application זמינים בכל תשתית של Google, כגון Google App Engine ו-Google Compute Engine.

ראה אתחול ה-SDK לפרטים נוספים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
httpAgent סוֹכֵן סוכן HTTP אופציונלי לשימוש בעת אחזור אסימוני גישה משרתי אסימונים של Google.

החזרות:

תְעוּדָה

אישור המאומת באמצעות אישורי ברירת המחדל של יישומי Google שניתן להשתמש בהם כדי לאתחל אפליקציה.

דוגמא

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

cert()

מחזיר אישור שנוצר מחשבון השירות המסופק ומעניק גישת מנהל לשירותי Firebase. ניתן להשתמש באישור זה בקריאה לאתחול App() .

ראה אתחול ה-SDK לפרטים נוספים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
serviceAccountPathOrObject מחרוזת | חשבון שירות הנתיב לקובץ 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 הנתונה הזו לבלתי שמישה ומשחררת את המשאבים של כל השירותים המשויכים (אם כי היא *לא* מנקה משאבים עורפיים כלשהם). בעת הפעלת ה-SDK באופן מקומי, יש לקרוא לשיטה זו כדי להבטיח סיום חינני של התהליך.

חֲתִימָה:

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

פרמטרים

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

החזרות:

הבטחה<void>

דוגמא

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

getApp()

חֲתִימָה:

export declare function getApp(appName?: string): App;

פרמטרים

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

החזרות:

אפליקציה

getApps()

חֲתִימָה:

export declare function getApps(): App[];

החזרות:

אפליקציה []

initializeApp()

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות AppOptions
שם האפליקציה חוּט

החזרות:

אפליקציה

refreshToken()

מחזיר אישור שנוצר מאסימון הרענון שסופק המעניק גישת מנהל לשירותי Firebase. ניתן להשתמש באישור זה בקריאה לאתחול App() .

ראה אתחול ה-SDK לפרטים נוספים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
refreshTokenPathOrObject מחרוזת | לְהִתְנַגֵד הנתיב לקובץ JSON של אסימון רענון OAuth2 של Google או לאובייקט המייצג אסימון רענון של 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

חֲתִימָה:

SDK_VERSION: string