firebase-admin.extensions package

Dịch vụ Tiện ích Firebase.

Hàm

Chức năng Mô tả
getExtension(app) Nhận dịch vụ Tiện ích dành cho ứng dụng mặc định hoặc một ứng dụng nhất định.getExtensions() có thể được gọi mà không cần đối số để truy cập vào dịch vụ Extensions của ứng dụng mặc định hoặc dưới dạng getExtensions(app) để truy cập vào dịch vụ Extensions liên kết với một ứng dụng cụ thể.

Lớp học

Hạng Mô tả
Tiện ích Giao diện dịch vụ Firebase Extensions.
Thời gian chạy Thời gian chạy cung cấp các phương thức để sửa đổi dữ liệu thời gian chạy của một thực thể tiện ích.

Nhập bí danh

Nhập bí danh Mô tả
SettableProcessingState SettableProcessingState biểu thị tất cả các trạng thái xử lý có thể đặt trên dữ liệu thời gian chạy của một thực thể Tiện ích.

getExtension(ứng dụng)

Tải dịch vụ Tiện ích dành cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

getExtensions() có thể được gọi mà không có đối số để truy cập dịch vụ Extensions của ứng dụng mặc định hoặc dưới dạng getExtensions(app) để truy cập dịch vụ Extensions liên kết với một ứng dụng cụ thể.

Chữ ký:

export declare function getExtensions(app?: App): Extensions;

Thông số

Thông số Loại Mô tả
ứng dụng Ứng dụng Ứng dụng không bắt buộc để trả về dịch vụ Extensions. Nếu không được cung cấp, dịch vụ Extensions mặc định sẽ được trả về.

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

Tiện ích

Dịch vụ Extensions mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Extensions liên kết với ứng dụng đã cung cấp.

Ví dụ 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

Ví dụ 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

Trạng thái xử lý có thể xử lý

SettableProcessingState biểu thị tất cả các trạng thái xử lý có thể đặt trên dữ liệu thời gian chạy của một thực thể Tiện ích.

Bạn có thể đặt các trạng thái sau:

  • NONE: Chưa xử lý sự kiện liên quan nào trong vòng đời. Đặt trạng thái này để xoá các trạng thái cũ.

  • PROCESSING_COMPLETE: Công việc của sự kiện trong vòng đời đã hoàn tất mà không có lỗi.

  • PROCESSING_WARNING: Hoạt động của sự kiện trong vòng đời đã thành công một phần hoặc đã xảy ra sự kiện nào đó mà người dùng cần được cảnh báo.

  • PROCESSING_FAILED: Không thể hoàn toàn hoạt động của sự kiện trong vòng đời, nhưng thực thể này vẫn sẽ hoạt động chính xác trong tương lai.

Nếu thực thể tiện ích ở trạng thái bị lỗi do lỗi, hãy gọi Runtime.setFatalError().

Việc "đang xử lý" trạng thái được đặt tự động khi trình xử lý sự kiện trong vòng đời bắt đầu; bạn không thể đặt nó một cách rõ ràng. Để báo cáo trạng thái duy trì một chức năng của một tiện ích, hãy sử dụng console.log hoặc SDK trình ghi nhật ký Chức năng đám mây.

Chữ ký:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';