SDK Web Cấu hình từ xa Firebase. SDK này không hoạt động trong môi trường Node.js.
Hàm
| Chức năng | Mô tả |
|---|---|
| hàm(app, ...) | |
| getRemoteConfig(app) | |
| function(remoteConfig, ...) | |
| kích hoạt(remoteConfig) | Cung cấp cấu hình được tìm nạp gần đây nhất cho phương thức getter. |
| đảm bảo khởi tạo(remoteConfig) | Đảm bảo cấu hình được kích hoạt gần đây nhất có sẵn cho các phương thức getter. |
| fetchAndKích hoạt(remoteConfig) | Thực hiện các thao tác tìm nạp và kích hoạt để thuận tiện. |
| fetchConfig(remoteConfig) | Tìm nạp và lưu cấu hình vào bộ nhớ đệm từ dịch vụ Cấu hình từ xa. |
| getAll(remoteConfig) | Lấy tất cả cấu hình. |
| getBoolean(remoteConfig; khoá) | Lấy giá trị cho khoá đã cho dưới dạng boolean.Phương thức thuận tiện để gọi remoteConfig.getValue(key).asBoolean(). |
| getNumber(remoteConfig; key) | Lấy giá trị của khoá đã cho dưới dạng số.Phương thức thuận tiện để gọi remoteConfig.getValue(key).asNumber(). |
| getString(remoteConfig, khoá) | Lấy giá trị của khoá đã cho dưới dạng chuỗi. Phương thức thuận tiện để gọi remoteConfig.getValue(key).asString(). |
| getValue(remoteConfig; key) | Lấy Giá trị cho khoá đã cho. |
| setLogLevel(remoteConfig, loglevel) | Xác định cấp độ nhật ký cần sử dụng. |
| hàm() | |
| isHỗ trợ() | Phương thức này cung cấp hai quy trình kiểm tra:1. Kiểm tra xem IndexedDB có tồn tại trong môi trường trình duyệt hay không. 2. Kiểm tra xem ngữ cảnh trình duyệt hiện tại có cho phép thực hiện lệnh gọi open() IndexedDB hay không. |
Giao diện
| Giao diện | Mô tả |
|---|---|
| RemoteConfig | Giao diện dịch vụ Cấu hình từ xa Firebase. |
| RemoteConfigSettings | Xác định các lựa chọn cấu hình cho SDK Cấu hình từ xa. |
| Giá trị | Gói một giá trị bằng siêu dữ liệu và các phương thức getter an toàn về kiểu. |
Nhập bí danh
| Nhập bí danh | Mô tả |
|---|---|
| Tìm nạp trạng thái | Tóm tắt kết quả của lần tìm nạp cấu hình gần đây nhất từ máy chủ Cấu hình từ xa Firebase.
|
| LogLevel (Cấp độ nhật ký) | Xác định các cấp độ ghi nhật ký Cấu hình từ xa. |
| ValueSource | Cho biết nguồn của một giá trị.
|
function(app, ...)
getRemoteConfig(ứng dụng)
Chữ ký:
export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| ứng dụng | Ứng dụng Firebase | Phiên bản FirebaseApp. |
Trường hợp trả lại hàng:
Một bản sao RemoteConfig.
function(remoteConfig, ...)
kích hoạt(remoteConfig)
Cung cấp cấu hình được tìm nạp gần đây nhất cho phương thức getter.
Chữ ký:
export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
Trường hợp trả lại hàng:
Promise<boolean>
Promise sẽ phân giải thành true nếu lệnh gọi hiện tại kích hoạt các cấu hình đã tìm nạp. Nếu các cấu hình đã tìm nạp đã được kích hoạt, Promise sẽ phân giải thành false.
đảm bảo đã khởi tạo(remoteConfig)
Đảm bảo cấu hình được kích hoạt gần đây nhất có sẵn cho các phương thức getter.
Chữ ký:
export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
Trường hợp trả lại hàng:
Lời hứa<vô hiệu>
Promise phân giải khi cấu hình được kích hoạt gần đây nhất có sẵn cho các phương thức getter.
Tìm nạpAndKích hoạt(remoteConfig)
Thực hiện các thao tác tìm nạp và kích hoạt để thuận tiện.
Chữ ký:
export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
Trường hợp trả lại hàng:
Promise<boolean>
Promise sẽ phân giải thành true nếu lệnh gọi hiện tại kích hoạt các cấu hình đã tìm nạp. Nếu các cấu hình đã tìm nạp đã được kích hoạt, Promise sẽ phân giải thành false.
Tìm nạp cấu hình(remoteConfig)
Tìm nạp và lưu cấu hình vào bộ nhớ đệm từ dịch vụ Cấu hình từ xa.
Chữ ký:
export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
Trường hợp trả lại hàng:
Lời hứa<vô hiệu>
getAll(remoteConfig)
Lấy tất cả cấu hình.
Chữ ký:
export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
Trường hợp trả lại hàng:
Ghi <string, Value>
Tất cả cấu hình.
getBoolean(remoteConfig; khoá)
Lấy giá trị của khoá đã cho dưới dạng boolean.
Phương thức thuận tiện để gọi remoteConfig.getValue(key).asBoolean().
Chữ ký:
export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
| phím | chuỗi | Tên của thông số. |
Trường hợp trả lại hàng:
boolean
Giá trị của khoá đã cho dưới dạng boolean.
getNumber(remoteConfig; khoá)
Lấy giá trị của khoá đã cho dưới dạng số.
Phương thức thuận tiện để gọi remoteConfig.getValue(key).asNumber().
Chữ ký:
export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
| phím | chuỗi | Tên của thông số. |
Trường hợp trả lại hàng:
số
Giá trị của khoá đã cho dưới dạng số.
getString(remoteConfig; khoá)
Lấy giá trị của khoá đã cho dưới dạng chuỗi. Phương thức thuận tiện để gọi remoteConfig.getValue(key).asString().
Chữ ký:
export declare function getString(remoteConfig: RemoteConfig, key: string): string;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
| phím | chuỗi | Tên của thông số. |
Trường hợp trả lại hàng:
chuỗi
Giá trị của khoá đã cho dưới dạng chuỗi.
getValue(remoteConfig; khoá)
Lấy Giá trị cho khoá đã cho.
Chữ ký:
export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
| phím | chuỗi | Tên của thông số. |
Trường hợp trả lại hàng:
Giá trị của khoá đã cho.
setLogLevel(remoteConfig; loglevel)
Xác định cấp độ nhật ký cần sử dụng.
Chữ ký:
export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Cấu hình từ xa | RemoteConfig | Phiên bản RemoteConfig. |
| cấp độ nhật ký | RemoteConfigLoglevel | Cấp độ nhật ký cần đặt. |
Trường hợp trả lại hàng:
trống
Hàm()
được hỗ trợ()
Phương thức này cung cấp 2 quy trình kiểm tra khác nhau:
- Kiểm tra xem IndexedDB có tồn tại trong môi trường trình duyệt hay không. 2. Kiểm tra xem ngữ cảnh trình duyệt hiện tại có cho phép thực hiện lệnh gọi
open()IndexedDB hay không.
Chữ ký:
export declare function isSupported(): Promise<boolean>;
Trường hợp trả lại hàng:
Promise<boolean>
Promise phân giải thành true nếu có thể khởi chạy thực thể RemoteConfig trong môi trường này hoặc false nếu không thể khởi động thực thể này.
FetchStatus (Trạng thái tìm nạp)
Tóm tắt kết quả của lần tìm nạp cấu hình gần đây nhất từ máy chủ Cấu hình từ xa Firebase.
- "chưa tìm nạp" cho biết bản sao [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_Giao diện) chưa tìm nạp cấu hình hoặc quá trình khởi tạo SDK chưa hoàn tất.
- "thành công" cho biết lần thử cuối cùng đã thành công.
- "thất bại" cho biết lần thử gần đây nhất không thành công.
- "điều tiết" cho biết lần gửi cuối cùng có giới hạn tỷ lệ.
Chữ ký:
export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
Cấp độ nhật ký
Xác định các cấp độ ghi nhật ký Cấu hình từ xa.
Chữ ký:
export declare type LogLevel = 'debug' | 'error' | 'silent';
Nguồn giá trị
Cho biết nguồn của một giá trị.
- "tĩnh" cho biết giá trị được xác định bởi một hằng số tĩnh.
- "mặc định" cho biết giá trị được xác định theo cấu hình mặc định.
- "điều khiển từ xa" cho biết giá trị được xác định theo cấu hình đã tìm nạp.
Chữ ký:
export declare type ValueSource = 'static' | 'default' | 'remote';