RemoteConfig class

Giao diện dịch vụ Firebase RemoteConfig.

Chữ ký:

export declare class RemoteConfig

Thuộc tính

Tài sản Công cụ sửa đổi Loại Mô tả
ứng dụng Ứng dụng

Phương thức

Phương thức Công cụ sửa đổi Mô tả
createTemplateFromJSON(json) Tạo và trả về một mẫu Cấu hình từ xa mới từ một chuỗi JSON.
getServerTemplate(options) Tạo thực thể cho ServerTemplate rồi tìm nạp và lưu phiên bản mẫu mới nhất của dự án vào bộ nhớ đệm.
getTemplate() Lấy phiên bản đang hoạt động hiện tại của RemoteConfigTemplate của dự án.
getTemplateAtVersion(phiên bản) Lấy phiên bản RemoteConfigTemplate của dự án được yêu cầu.
initServerTemplate(tuỳ chọn) Tạo thực thể đồng bộ cho ServerTemplate.
listVersions(tuỳ chọn) Lấy danh sách phiên bản mẫu Cấu hình từ xa đã được xuất bản, được sắp xếp theo trình tự thời gian ngược. Hệ thống chỉ lưu trữ 300 phiên bản gần nhất. Tất cả các phiên bản tương ứng với mẫu Cấu hình từ xa không hoạt động (tức là tất cả ngoại trừ mẫu mà ứng dụng đang tìm nạp) cũng đều bị xoá nếu cũ hơn 90 ngày.
publishTemplate(mẫu; tuỳ chọn) Xuất bản mẫu Cấu hình từ xa.
rollback(versionNumber) Khôi phục mẫu Cấu hình từ xa đã xuất bản của một dự án về phiên bản được chỉ định. Khôi phục tương đương với việc lấy mẫu Cấu hình từ xa đã xuất bản trước đó và xuất bản lại mẫu đó bằng bản cập nhật bắt buộc.
validateTemplate(mẫu) Xác thực một RemoteConfigTemplate.

RemoteConfig.app

Chữ ký:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

Tạo và trả về một mẫu Cấu hình từ xa mới từ một chuỗi JSON.

Chữ ký:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Thông số

Thông số Loại Mô tả
JSON chuỗi Chuỗi JSON để điền sẵn một mẫu Cấu hình từ xa.

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

RemoteConfigTemplate

Một phiên bản mẫu mới.

RemoteConfig.getServerTemplate()

Tạo thực thể cho ServerTemplate rồi tìm nạp và lưu phiên bản mẫu mới nhất của dự án vào bộ nhớ đệm.

Chữ ký:

getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;

Thông số

Thông số Loại Mô tả
tuỳ chọn GetServerTemplateOptions

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

Cam kết<ServerTemplate>

RemoteConfig.getTemplate()

Lấy phiên bản đang hoạt động hiện tại của RemoteConfigTemplate của dự án.

Chữ ký:

getTemplate(): Promise<RemoteConfigTemplate>;

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

Cam kết<RemoteConfigTemplate>

Lời hứa thể hiện bằng một RemoteConfigTemplate.

RemoteConfig.getTemplateAtVersion()

Lấy phiên bản RemoteConfigTemplate của dự án được yêu cầu.

Chữ ký:

getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;

Thông số

Thông số Loại Mô tả
số phiên bản số | chuỗi Số phiên bản của mẫu Cấu hình từ xa cần tra cứu.

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

Cam kết<RemoteConfigTemplate>

Lời hứa thể hiện bằng một RemoteConfigTemplate.

RemoteConfig.initServerTemplate()

Tạo thực thể đồng bộ cho ServerTemplate.

Chữ ký:

initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;

Thông số

Thông số Loại Mô tả
tuỳ chọn InitServerTemplateOptions

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

Mẫu máy chủ

RemoteConfig.listVersions()

Lấy danh sách phiên bản mẫu Cấu hình từ xa đã được xuất bản, được sắp xếp theo trình tự thời gian ngược. Hệ thống chỉ lưu trữ 300 phiên bản gần nhất. Tất cả các phiên bản tương ứng với mẫu Cấu hình từ xa không hoạt động (tức là tất cả ngoại trừ mẫu mà ứng dụng đang tìm nạp) cũng đều bị xoá nếu cũ hơn 90 ngày.

Chữ ký:

listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;

Thông số

Thông số Loại Mô tả
tuỳ chọn ListVersionsOptions (Tuỳ chọn) Đối tượng tuỳ chọn không bắt buộc để lấy danh sách phiên bản.

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

Hứa hẹn<ListVersionsResult>

Lời hứa thể hiện bằng một ListVersionsResult.

RemoteConfig.publishTemplate()

Xuất bản mẫu Cấu hình từ xa.

Chữ ký:

publishTemplate(template: RemoteConfigTemplate, options?: {
        force: boolean;
    }): Promise<RemoteConfigTemplate>;

Thông số

Thông số Loại Mô tả
mẫu RemoteConfigTemplate Mẫu Cấu hình từ xa cần được xuất bản.
tuỳ chọn { force: boolean; } Đối tượng tuỳ chọn không bắt buộc khi xuất bản mẫu Cấu hình từ xa: – force: Việc đặt đối tượng này thành true sẽ buộc cập nhật mẫu Cấu hình từ xa và tránh né ETag. Bạn không nên dùng phương pháp này vì có nguy cơ làm mất các bản cập nhật cho mẫu Cấu hình từ xa nếu nhiều ứng dụng khách cùng cập nhật mẫu Cấu hình từ xa. Xem bài viết Mức sử dụng ETag và bản cập nhật bắt buộc.

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

Cam kết<RemoteConfigTemplate>

Lời hứa thực hiện với RemoteConfigTemplate đã xuất bản.

RemoteConfig.rollback()

Khôi phục mẫu Cấu hình từ xa đã xuất bản của một dự án về phiên bản được chỉ định. Khôi phục tương đương với việc lấy mẫu Cấu hình từ xa đã xuất bản trước đó và xuất bản lại mẫu đó bằng bản cập nhật bắt buộc.

Chữ ký:

rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;

Thông số

Thông số Loại Mô tả
số phiên bản số | chuỗi Số phiên bản của mẫu Cấu hình từ xa cần khôi phục. Số phiên bản được chỉ định phải thấp hơn số phiên bản hiện tại và không bị xoá do lỗi thời. Hệ thống chỉ lưu trữ 300 phiên bản gần nhất. Tất cả các phiên bản tương ứng với mẫu Cấu hình từ xa không hoạt động (nghĩa là tất cả ngoại trừ mẫu đang được ứng dụng tìm nạp) cũng bị xoá nếu đã quá 90 ngày.

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

Cam kết<RemoteConfigTemplate>

Lời hứa thực hiện với RemoteConfigTemplate đã xuất bản.

Cấu hình từ xa.validateTemplate()

Xác thực một RemoteConfigTemplate.

Chữ ký:

validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;

Thông số

Thông số Loại Mô tả
mẫu RemoteConfigTemplate Mẫu Cấu hình từ xa cần được xác thực.

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

Cam kết<RemoteConfigTemplate>

Lời hứa được thực hiện với RemoteConfigTemplate đã được xác thực.