firebase-admin.app package

برنامه Firebase و مقداردهی اولیه SDK.

کارکرد

رابط ها

متغیرها

applicationDefault()

اعتبار ایجاد شده از اعتبارنامه پیش‌فرض برنامه Google را برمی‌گرداند که به سرپرست اجازه دسترسی به خدمات Firebase را می‌دهد. این اعتبار را می توان در فراخوانی برای مقدار دهی اولیه ()App استفاده کرد. .

اعتبارنامه پیش‌فرض برنامه Google در هر زیرساخت Google مانند Google App Engine و Google Compute Engine در دسترس است.

برای جزئیات بیشتر به Initialize the SDK مراجعه کنید.

امضا:

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

مولفه های

برمی گرداند:

اعتبارنامه

اعتبارنامه‌ای که از طریق اعتبارنامه پیش‌فرض Google Application احراز هویت شده و می‌توان از آن برای مقداردهی اولیه یک برنامه استفاده کرد.

مثال

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

گواهی ()

اعتبار ایجاد شده از حساب سرویس ارائه شده را برمی گرداند که دسترسی سرپرست به خدمات Firebase را می دهد. این اعتبار را می توان در فراخوانی برای مقدار دهی اولیه ()App استفاده کرد. .

برای جزئیات بیشتر به Initialize the SDK مراجعه کنید.

امضا:

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

مولفه های

برمی گرداند:

اعتبارنامه

اعتبارنامه ای که از طریق حساب سرویس ارائه شده احراز هویت شده است که می تواند برای مقداردهی اولیه یک برنامه استفاده شود.

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

حذف برنامه ()

این App داده شده را غیرقابل استفاده می کند و منابع همه سرویس های مرتبط را آزاد می کند (اگرچه هیچ منبع باطنی را *نمی** پاکسازی می کند). هنگام اجرای SDK به صورت محلی، این روش باید فراخوانی شود تا از خاتمه برازنده فرآیند اطمینان حاصل شود.

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

مثال

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

آپلیکیشین را دریافت کن()

امضا:

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

مولفه های

برمی گرداند:

برنامه

getApps()

امضا:

export declare function getApps(): App[];

برمی گرداند:

برنامه []

InitializeApp()

امضا:

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

مولفه های

برمی گرداند:

برنامه

refreshToken()

اعتبار ایجاد شده از توکن به‌روزرسانی ارائه شده را برمی‌گرداند که به سرپرست دسترسی به خدمات Firebase را می‌دهد. این اعتبار را می توان در فراخوانی برای مقدار دهی اولیه ()App استفاده کرد. .

برای جزئیات بیشتر به Initialize the SDK مراجعه کنید.

امضا:

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

مولفه های

برمی گرداند:

اعتبارنامه

اعتبارنامه ای که از طریق حساب سرویس ارائه شده احراز هویت شده است که می تواند برای مقداردهی اولیه یک برنامه استفاده شود.

مثال

// 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