Ứng dụng Firebase
Gói này điều phối hoạt động liên lạc giữa nhiều thành phần Firebase
Hàm
Chức năng | Mô tả |
---|---|
hàm(app, ...) | |
deleteApp(ứng dụng) | Kết xuất ứng dụng 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. |
hàm() | |
getApps() | Một mảng (chỉ có thể đọc) gồm tất cả ứng dụng đã khởi tạo. |
khởi tạoApp() | Tạo và khởi chạy một phiên bản FirebaseApp. |
function(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, phiên bản, biến thể) | Đăng ký tên và phiên bản của thư viện cho mục đích ghi nhật ký nền tảng. |
hàm(logCallback, ...) | |
onLog(logCallback, các tuỳ chọn) | Đặt trình xử lý nhật ký cho tất cả Firebase SDK. |
hàm(loglevel, ...) | |
setLogLevel(logLevel) | Đặt cấp độ nhật ký cho tất cả Firebase SDK.Mọi loại nhật ký trên cấp độ nhật ký hiện tại đều được ghi lại (tức là nếu bạn đặt cấp độ nhật ký thành info , lỗi sẽ được ghi lại, nhưng nhật ký debug và verbose sẽ không được ghi lại). |
hàm(name, ...) | |
getApp(tên) | Truy xuất một thực thể FirebaseApp.Khi được gọi mà không có đối số, ứng dụng mặc định sẽ được trả về. Khi tên ứng dụng được cung cấp, ứng dụng tương ứng với tên đó sẽ được trả về.Hệ thống sẽ gửi một ngoại lệ nếu ứng dụng đang được truy xuất chưa được khởi chạy. |
hàm(options, ...) | |
khởi tạoApp(tuỳ chọn; tên) | Tạo và khởi chạy một thực thể FirebaseApp.Hãy xem bài viết Thêm Firebase vào ứng dụng của bạn và Khởi chạy nhiều dự án để biết tài liệu chi tiết. |
khởi tạoApp(các tuỳ chọn, cấu hình) | Tạo và khởi chạy một phiên bản FirebaseApp. |
startupServerApp(tuỳ chọn, cấu hình) | Tạo và khởi chạy một thực thể FirebaseServerApp.FirebaseServerApp tương tự như FirebaseApp , nhưng chỉ dùng để thực thi trong môi trường kết xuất phía máy chủ. Khởi chạy sẽ không thành công nếu được gọi từ môi trường trình duyệt.Hãy xem bài viết Thêm Firebase vào ứng dụng và Khởi chạy nhiều dự án để xem tài liệu chi tiết. |
Giao diện
Giao diện | Mô tả |
---|---|
Ứng dụng Firebase | FirebaseApp lưu giữ thông tin khởi chạy cho một tập hợp dịch vụ.Đừng gọi trực tiếp hàm khởi tạo này. Thay vào đó, hãy dùng initializeApp() để tạo một ứng dụng. |
FirebaseAppSettings | Các tuỳ chọn cấu hình được cung cấp cho initializeApp() |
FirebaseOptions | Đối tượng cấu hình Firebase. Chứa tập hợp các thông số mà dịch vụ yêu cầu để giao tiếp thành công với API máy chủ Firebase và để liên kết dữ liệu khách hàng với dự án Firebase và ứng dụng Firebase. Thông thường, đối tượng này được bảng điều khiển của Firebase điền sẵn khi thiết lập dự án. Xem thêm: Tìm hiểu về đối tượng cấu hình Firebase. |
FirebaseServerApp | FirebaseServerApp lưu giữ thông tin khởi chạy cho một tập hợp các dịch vụ chạy trong môi trường máy chủ.Đừng gọi trực tiếp hàm khởi tạo này. Thay vào đó, hãy dùng initializeServerApp() để tạo một ứng dụng. |
FirebaseServerAppSettings | Các lựa chọn cấu hình được cung cấp cho initializeServerApp() |
Biến
Biến | Mô tả |
---|---|
PHIÊN BẢN_SDK | Phiên bản SDK hiện tại. |
function(app, ...)
deleteApp(ứng dụng)
Kết xuất ứng dụng 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.
Chữ ký:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
ứng dụng | Ứng dụng Firebase |
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);
});
Hàm()
getApps()
Một mảng (chỉ có thể đọc) của tất cả ứng dụng đã khởi tạo.
Chữ ký:
export declare function getApps(): FirebaseApp[];
Trường hợp trả lại hàng:
khởi tạoApp()
Tạo và khởi chạy một phiên bản FirebaseApp.
Chữ ký:
export declare function initializeApp(): FirebaseApp;
Trường hợp trả lại hàng:
function(libraryKeyOrName, ...)
subscriptionVersion(libraryKeyOrName; phiên bản; biến thể)
Đăng ký tên và phiên bản của thư viện cho mục đích ghi nhật ký nền tảng.
Chữ ký:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
thư việnKeyOrName | chuỗi | |
phiên bản | chuỗi | Phiên bản hiện tại của thư viện đó. |
variant | chuỗi | Biến thể của gói, ví dụ: nút, rn, v.v. |
Trường hợp trả lại hàng:
trống
hàm(logCallback, ...)
onLog(logCallback, các tuỳ chọn)
Đặt trình xử lý nhật ký cho tất cả Firebase SDK.
Chữ ký:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
logCallback | LogCallback | rỗng | Một trình xử lý nhật ký tuỳ chỉnh không bắt buộc thực thi mã người dùng bất cứ khi nào SDK Firebase thực hiện lệnh gọi ghi nhật ký. |
tuỳ chọn | Tùy chọn nhật ký |
Trường hợp trả lại hàng:
trống
hàm(loglevel, ...)
setLogLevel(logLevel)
Đặt cấp độ nhật ký cho tất cả SDK Firebase.
Tất cả loại nhật ký trên cấp độ nhật ký hiện tại đều được ghi lại (tức là nếu bạn đặt cấp độ nhật ký thành info
, lỗi sẽ được ghi lại, nhưng nhật ký debug
và verbose
sẽ không được ghi lại).
Chữ ký:
export declare function setLogLevel(logLevel: LogLevelString): void;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
cấp độ nhật ký | Chuỗi cấp độ logarit |
Trường hợp trả lại hàng:
trống
function(name, ...)
getApp(tên)
Truy xuất một thực thể FirebaseApp.
Khi được gọi mà không có đối số, ứng dụng mặc định được trả về. Khi tên ứng dụng được cung cấp, ứng dụng tương ứng với tên đó sẽ được trả về.
Hệ thống sẽ gửi một ngoại lệ nếu ứng dụng đang được truy xuất chưa được khởi chạy.
Chữ ký:
export declare function getApp(name?: string): FirebaseApp;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
name | chuỗi | Tên không bắt buộc của ứng dụng cần trả về. Nếu bạn không cung cấp tên, giá trị mặc định sẽ là "[DEFAULT]" . |
Trường hợp trả lại hàng:
Ứng dụng tương ứng với tên ứng dụng đã cung cấp. Nếu bạn không cung cấp tên ứng dụng, thì ứng dụng mặc định sẽ được trả về.
Ví dụ 1
// Return the default app
const app = getApp();
Ví dụ 2
// Return a named app
const otherApp = getApp("otherApp");
hàm(options, ...)
khởi tạoỨng dụng(tuỳ chọn, tên)
Tạo và khởi chạy một phiên bản FirebaseApp.
Xem bài viết Thêm Firebase vào ứng dụng và Khởi chạy nhiều dự án để biết tài liệu chi tiết.
Chữ ký:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
tuỳ chọn | FirebaseOptions | Các tuỳ chọn để định cấu hình dịch vụ của ứng dụng. |
name | chuỗi | Tên không bắt buộc của ứng dụng để khởi chạy. Nếu bạn không cung cấp tên, giá trị mặc định sẽ là "[DEFAULT]" . |
Trường hợp trả lại hàng:
Ứng dụng đã khởi tạo.
Ví dụ 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
});
Ví dụ 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
khởi độngApp(tuỳ chọn, cấu hình)
Tạo và khởi chạy một phiên bản FirebaseApp.
Chữ ký:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
tuỳ chọn | FirebaseOptions | Các tuỳ chọn để định cấu hình dịch vụ của ứng dụng. |
cấu hình | FirebaseAppSettings | Cấu hình FirebaseApp |
Trường hợp trả lại hàng:
compileServerApp(tuỳ chọn, cấu hình)
Tạo và khởi chạy một thực thể FirebaseServerApp.
FirebaseServerApp
tương tự như FirebaseApp
, nhưng chỉ dùng để thực thi trong môi trường kết xuất phía máy chủ. Khởi chạy sẽ không thành công nếu được gọi từ môi trường trình duyệt.
Xem bài viết Thêm Firebase vào ứng dụng và Khởi chạy nhiều dự án để biết tài liệu chi tiết.
Chữ ký:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
tuỳ chọn | FirebaseOptions | Ứng dụng Firebase | Firebase.AppOptions để định cấu hình các dịch vụ của ứng dụng hoặc một thực thể FirebaseApp chứa AppOptions bên trong. |
cấu hình | FirebaseServerAppSettings | Cấu hình FirebaseServerApp . |
Trường hợp trả lại hàng:
FirebaseServerApp
đã khởi tạo.
Ví dụ
// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
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
},
{
authIdToken: "Your Auth ID Token"
});
PHIÊN BẢN_SDK
Phiên bản SDK hiện tại.
Chữ ký:
SDK_VERSION: string