Giao diện dịch vụ Firebase RemoteConfig
.
Chữ ký:
export declare class RemoteConfig
Thuộc tính
Tài sản | Đối tượng sửa đổi | Loại | Mô tả |
---|---|---|---|
ứng dụng | Ứng dụng |
Phương thức
Phương thức | Đối tượng sửa đổi | Mô tả |
---|---|---|
createTemplateFromJSON(json) | Tạo và trả về một mẫu Cấu hình từ xa mới qua một chuỗi JSON. | |
getServerTemplate(tuỳ chọn) | Tạo bản sao của ServerTemplate, sau đó tìm nạp và lưu vào bộ nhớ đệm phiên bản mẫu mới nhất của dự án. | |
getTemplate() | Lấy phiên bản hiện đang hoạt động của RemoteConfigTemplate của dự án. | |
getTemplateAtVersion(versionNumber) | Lấy phiên bản RemoteConfigTemplate của dự án được yêu cầu. | |
initServerTemplate(tuỳ chọn) | Tạo bản sao ServerTemplate một cách đồng bộ. | |
listVersions(options) | 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 thứ tự thời gian đảo ngược. Chỉ 300 phiên bản cuối cùng được lưu trữ. 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 sẽ bị xoá nếu đã quá 90 ngày. | |
publishTemplate(mẫu, lựa chọn) | Xuất bản mẫu Cấu hình từ xa. | |
rollback(phiên bảnNumber) | Khôi phục mẫu Cấu hình từ xa đã phát hành của dự án về phiên bản đã chỉ định. Khôi phục tương đương với việc nhận một mẫu Cấu hình từ xa đã xuất bản trước đó rồi xuất bản lại bằng phương thức cập nhật buộc. | |
verifyTemplate(mẫu) | Xác thực 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 qua 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ẫu Cấu hình từ xa. |
Trường hợp trả lại hàng:
Một thực thể mẫu mới.
RemoteConfig.getServerTemplate()
Tạo bản sao của ServerTemplate, sau đó tìm nạp và lưu vào bộ nhớ đệm phiên bản mẫu mới nhất của dự án.
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 hiện đang hoạt động của RemoteConfigTemplate của dự án.
Chữ ký:
getTemplate(): Promise<RemoteConfigTemplate>;
Trường hợp trả lại hàng:
Hứa hẹn<RemoteConfigTemplate>
Một lời hứa sẽ thực hiện được bằng 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:
Hứa hẹn<RemoteConfigTemplate>
Một lời hứa sẽ thực hiện được bằng RemoteConfigTemplate
.
RemoteConfig.initServerTemplate()
Tạo bản sao ServerTemplate một cách đồng bộ.
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:
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 thứ tự thời gian đảo ngược. Chỉ 300 phiên bản cuối cùng được lưu trữ. 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 sẽ bị xoá nếu đã quá 90 ngày.
Chữ ký:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
tuỳ chọn | ListVersionsOptions | Đối tượng tuỳ chọn không bắt buộc để tải danh sách phiên bản. |
Trường hợp trả lại hàng:
Hứa hẹn<ListVersionsResult>
Một lời hứa sẽ thực hiện được bằng 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 sẽ được xuất bản. |
tuỳ chọn | { force: boolean; } | Đối tượng các 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 tuỳ chọn này thành true sẽ buộc phải cập nhật mẫu Cấu hình từ xa và tránh né ETag. Bạn không nên sử dụng phương pháp này vì nó có nguy cơ khiến mẫu Cấu hình từ xa bị mất bản cập nhật nếu có nhiều ứng dụng cùng cập nhật mẫu Cấu hình từ xa. Xem bài viết Sử dụng thẻ điện tử và việc cập nhật bắt buộc. |
Trường hợp trả lại hàng:
Hứa hẹn<RemoteConfigTemplate>
Lời hứa sẽ thực hiện theo RemoteConfigTemplate
đã phát hành.
RemoteConfig.rollback()
Khôi phục mẫu Cấu hình từ xa đã phát hành của dự án về phiên bản đã chỉ định. Khôi phục tương đương với việc nhận một mẫu Cấu hình từ xa đã xuất bản trước đó rồi xuất bản lại bằng phương thức cập nhậ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. Chỉ 300 phiên bản cuối cùng được lưu trữ. 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 mà ứng dụng đang tìm nạp) cũng sẽ bị xoá nếu đã quá 90 ngày. |
Trường hợp trả lại hàng:
Hứa hẹn<RemoteConfigTemplate>
Một lời hứa sẽ thực hiện được với RemoteConfigTemplate
đã phát hành.
RemoteConfig.validateTemplate()
Xác thực 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 xác thực. |
Trường hợp trả lại hàng:
Hứa hẹn<RemoteConfigTemplate>
Lời hứa sẽ thực hiện với RemoteConfigTemplate
đã được xác thực.