app package

Ứng dụng Firebase

Gói này điều phối hoạt động giao tiếp giữa các thành phần Firebase

Hàm

Hàm Nội dung mô tả
hàm(ứng dụng, ...)
deleteApp(ứng dụng) Hiển thị ứ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ả các ứng dụng đã khởi tạo.
initializeApp() Tạo và khởi chạy một thực thể FirebaseApp.
hàm(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant) Đă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ả SDK Firebase.
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ý cao hơ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ý debugverbose thì không).
hàm(tên, ...)
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ẽ trả về 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, ...)
initializeApp(các lựa chọn, tên) Tạo và khởi chạy một thực thể FirebaseApp.Xem bài viết Thêm Firebase vào ứng dụng của bạnKhởi chạy nhiều dự án để biết tài liệu chi tiết.
khởi tạo ứng dụng(các lựa chọn, cấu hình) Tạo và khởi chạy một thực thể FirebaseApp.
initializeServerApp(các lựa chọn, cấu hình) Tạo và khởi chạy một thực thể FirebaseServerApp.FirebaseServerApp này tương tự như FirebaseApp, nhưng chỉ dùng để thực thi trong các môi trường kết xuất phía máy chủ. Quá trình 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 của bạnKhởi chạy nhiều dự án để biết tài liệu chi tiết.

Giao diện

Giao diện Nội dung mô tả
FirebaseApp FirebaseApp lưu giữ thông tin khởi chạy của 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 sử 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 một bộ thông số theo yêu cầu của các dịch vụ để giao tiếp thành công với API máy chủ Firebase và để liên kết dữ liệu ứng dụng với dự án Firebase và ứng dụng Firebase của bạn. Thông thường, đối tượng này được điền sẵn bằng bảng điều khiển của Firebase 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 của một tập hợp 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 sử 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 Nội dung mô tả
SDK_VERSION Phiên bản SDK hiện tại.

chức năng(ứng dụng, ...)

xoá ứng dụng(ứng dụng)

Hiển thị ứ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>;

Tham số

Thông số Loại Nội dung mô tả
ứng dụng FirebaseApp

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

Promise<void>

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) gồm tất cả các ứng dụng đã khởi tạo.

Chữ ký:

export declare function getApps(): FirebaseApp[];

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

FirebaseApp[]

initializeApp()

Tạo và khởi chạy một thực thể FirebaseApp.

Chữ ký:

export declare function initializeApp(): FirebaseApp;

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

FirebaseApp

hàm(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

Đă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;

Tham số

Thông số Loại Nội dung mô tả
libraryKeyOrName string
version string Phiên bản hiện tại của thư viện đó.
biến thể string Biến thể gói, ví dụ: nút, rn, v.v.

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

void

hàm(logCallback, ...)

onLog(logCallback, tuỳ chọn)

Đặt trình xử lý nhật ký cho tất cả SDK Firebase.

Chữ ký:

export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;

Tham số

Thông số Loại Nội dung mô tả
logCallback LogCallback | rỗng Một trình xử lý nhật ký tuỳ chỉnh (không bắt buộc) sẽ 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ý.
tùy chọn LogOptions

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

void

hàm(logLevel, ...)

setLogLevel(logLevel)

Đặt cấp nhật ký cho tất cả SDK Firebase.

Tất cả các loại nhật ký cao hơ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ý debugverbose thì không).

Chữ ký:

export declare function setLogLevel(logLevel: LogLevelString): void;

Tham số

Thông số Loại Nội dung mô tả
logLevel LogLevelString

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

void

hàm(tên, ...)

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 động.

Chữ ký:

export declare function getApp(name?: string): FirebaseApp;

Tham số

Thông số Loại Nội dung mô tả
tên string 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:

FirebaseApp

Ứng dụng tương ứng với tên ứng dụng được 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(tuỳ chọn, ...)

LaunchApp(tuỳ chọn, tên)

Tạo và khởi chạy một thực thể FirebaseApp.

Xem bài viết Thêm Firebase vào ứng dụngKhở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;

Tham số

Thông số Loại Nội dung mô tả
tùy chọn FirebaseOptions Các lựa chọn để định cấu hình dịch vụ của ứng dụng.
tên string 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:

FirebaseApp

Ứ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");

LaunchApp(tuỳ chọn, cấu hình)

Tạo và khởi chạy một thực thể FirebaseApp.

Chữ ký:

export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;

Tham số

Thông số Loại Nội dung mô tả
tùy chọn FirebaseOptions Các lựa 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:

FirebaseApp

LaunchServerApp(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ành để thực thi trong môi trường kết xuất phía máy chủ. Quá trình 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ụngKhở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;

Tham số

Thông số Loại Nội dung mô tả
tùy chọn FirebaseOptions | FirebaseApp 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

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

SDK_VERSION

Phiên bản SDK hiện tại.

Chữ ký:

SDK_VERSION: string