firebase-admin.app package

Khởi chạy SDK và ứng dụng Firebase.

Hàm

Lớp học

Giao diện

Biến

applicationDefault(httpAgent)

Trả về thông tin đăng nhập được tạo từ Thông tin xác thực mặc định của ứng dụng trên Google để cấp quyền quản trị đối với các dịch vụ Firebase. Thông tin đăng nhập này có thể được sử dụng trong lệnh gọi để initializeApp().

Thông tin đăng nhập mặc định của ứng dụng trên Google có sẵn trên mọi cơ sở hạ tầng của Google, chẳng hạn như Google App Engine và Google Compute Engine.

Xem bài viết Khởi chạy SDK để biết thêm thông tin chi tiết.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Thông tin xác thực

Thông tin đăng nhập được xác thực qua Thông tin xác thực mặc định của ứng dụng trên Google có thể dùng để khởi chạy ứng dụng.

Ví dụ

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

cert(serviceAccountPathOrObject, httpAgent)

Trả về thông tin đăng nhập được tạo từ tài khoản dịch vụ được cung cấp để cấp quyền quản trị đối với các dịch vụ Firebase. Thông tin đăng nhập này có thể được sử dụng trong lệnh gọi để initializeApp().

Xem bài viết Khởi chạy SDK để biết thêm thông tin chi tiết.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Thông tin xác thực

Thông tin đăng nhập được xác thực qua tài khoản dịch vụ được cung cấp, có thể dùng để khởi chạy một ứng dụng.

Ví dụ 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"
});

Ví dụ 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(ứng dụng)

Kết xuất App này không sử dụng được và giải phóng tài nguyên của tất cả dịch vụ liên kết (mặc dù nó *không* dọn dẹp bất kỳ tài nguyên phụ trợ nào). Khi chạy SDK cục bộ, phương thức này phải được gọi để đảm bảo việc kết thúc quy trình một cách linh hoạt.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Ví dụ

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

getApp(tên ứng dụng)

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Ứng dụng

getApps()

Chữ ký:

export declare function getApps(): App[];

Trường hợp trả lại hàng:

Ứng dụng[]

khởi tạoApp(options, appName)

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Ứng dụng

RefreshToken(refreshTokenPathOrObject, httpAgent)

Trả về thông tin đăng nhập được tạo từ mã làm mới được cung cấp để cấp quyền quản trị đối với các dịch vụ Firebase. Thông tin đăng nhập này có thể được sử dụng trong lệnh gọi để initializeApp().

Xem bài viết Khởi chạy SDK để biết thêm thông tin chi tiết.

Chữ ký:

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

Thông số

Trường hợp trả lại hàng:

Thông tin xác thực

Thông tin đăng nhập được xác thực qua tài khoản dịch vụ được cung cấp, có thể dùng để khởi chạy một ứng dụng.

Ví dụ

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

PHIÊN BẢN_SDK

Chữ ký:

SDK_VERSION: string