Khởi chạy SDK và ứng dụng Firebase.
Hàm
| Chức năng | Mô tả |
|---|---|
| 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 xác thực này có thể được dùng trong lệnh gọi để initializeApp().Thông tin xác thực 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.Hãy xem phần Khởi chạy SDK để biết thêm thông tin chi tiết. |
| 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 dùng trong lệnh gọi để initializeApp().Hãy xem phần Khởi chạy SDK để biết thêm thông tin chi tiết. |
| 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. |
| getApp(tên ứng dụng) | |
| getApps() | |
| khởi tạoApp(các tuỳ chọn, tên ứ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 dùng trong lệnh gọi để initializeApp().Hãy xem phần Khởi chạy SDK để biết thêm thông tin chi tiết. |
Lớp học
| Hạng | Mô tả |
|---|---|
| AppErrorCodes | Mã lỗi của ứng dụng khách và các thông báo mặc định. |
| FirebaseAppError | Cấu trúc mã lỗi của ứng dụng Firebase. Thao tác này mở rộng PrefixedFirebaseError. |
Giao diện
| Giao diện | Mô tả |
|---|---|
| Ứng dụng | Ứng dụng Firebase lưu giữ thông tin về hoạt động khởi chạy của một tập hợp các dịch vụ. |
| Tuỳ chọn ứng dụng | Các tuỳ chọn có sẵn để truyền đến initializeApp(). |
| Thông tin xác thực | Giao diện cung cấp mã truy cập OAuth2 của Google dùng để xác thực với các dịch vụ Firebase.Trong hầu hết trường hợp, bạn không cần tự triển khai quy trình này mà có thể sử dụng phương thức triển khai mặc định do mô-đun firebase-admin/app cung cấp. |
| FirebaseArrayIndexError | Loại tổng hợp bao gồm cả đối tượng FirebaseError và chỉ mục có thể dùng để lấy mục bị lỗi. |
| Lỗi Firebase | FirebaseError là một lớp con của đối tượng Error JavaScript chuẩn. Ngoài một chuỗi thông báo và dấu vết ngăn xếp, thư mục này còn chứa mã chuỗi. |
| GoogleOAuthAccessToken | Giao diện cho mã truy cập Google OAuth 2.0. |
| Tài khoản dịch vụ |
Biến
| Biến | Mô tả |
|---|---|
| PHIÊN BẢN_SDK |
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ố
| Thông số | Loại | Mô tả |
|---|---|---|
| httpNhân viên hỗ trợ | Nhân viên hỗ trợ | Tác nhân HTTP (không bắt buộc) dùng khi truy xuất mã truy cập từ máy chủ mã thông báo của Google. |
Trường hợp trả lại hàng:
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ố
| Thông số | Loại | Mô tả |
|---|---|---|
| dịch vụAccountPathOrObject | chuỗi | Tài khoản dịch vụ | Đường dẫn đến tệp JSON chứa khoá tài khoản dịch vụ hoặc đối tượng đại diện cho khoá tài khoản dịch vụ. |
| httpNhân viên hỗ trợ | Nhân viên hỗ trợ | Tác nhân HTTP (không bắt buộc) dùng khi truy xuất mã truy cập từ máy chủ mã thông báo của Google. |
Trường hợp trả lại hàng:
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ố
| Thông số | Loại | Mô tả |
|---|---|---|
| ứng dụng | Ứng dụng |
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ố
| Thông số | Loại | Mô tả |
|---|---|---|
| tên ứng dụng | chuỗi |
Trường hợp trả lại hà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ố
| Thông số | Loại | Mô tả |
|---|---|---|
| tuỳ chọn | Tuỳ chọn ứng dụng | |
| tên ứng dụng | chuỗi |
Trường hợp trả lại hà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ố
| Thông số | Loại | Mô tả |
|---|---|---|
| làm mớiTokenPathOrObject | chuỗi | đối tượng | Đường dẫn đến tệp JSON của mã làm mới Google OAuth2 hoặc đối tượng đại diện cho mã làm mới Google OAuth2. |
| httpNhân viên hỗ trợ | Nhân viên hỗ trợ | Tác nhân HTTP (không bắt buộc) dùng khi truy xuất mã truy cập từ máy chủ mã thông báo của Google. |
Trường hợp trả lại hàng:
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