firebase-admin.extensions package

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

Hàm

Chức năng Mô tả
getExtensions(ứng dụng) Lấy dịch vụ Tiện ích 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 getExtensions(app) để truy cập dịch vụ Extensions liên kết với một ứng dụng cụ thể.

Hạng

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.

Loại bí danh

Loại bí danh Mô tả
SettableprocessingState SettableProcessingState thể hiện 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.

getExtensions(ứng dụng)

Lấy dịch vụ Tiện ích cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi getExtensions() mà không có đố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ể.

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 được 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ý settable

SettableProcessingState thể hiện 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 hoàn thành công việc nào có liên quan đến sự kiện trong vòng đời. Hãy đặt mục này để xoá các trạng thái cũ.

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

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

  • PROCESSING_FAILED: Công việc sự kiện trong vòng đời không thành công hoàn toàn, nhưng thực thể này vẫn sẽ hoạt động đúng cách về sau.

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

Trạng thái "xử lý" đượ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 trạng thái này một cách rõ ràng. Để báo cáo trạng thái đang diễn ra của chức năng trên 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';