remote-config package

SDK web cấu hình từ xa Firebase. SDK này không hoạt động trong môi trường Node.js.

Chức năng

Chức năng Sự miêu tả
chức năng (ứng dụng, ...)
getRemoteConfig(ứng dụng)
chức năng (remoteConfig, ...)
kích hoạt (remoteConfig) Cung cấp cấu hình được tìm nạp cuối cùng cho getters.
đảm bảo được khởi tạo (remoteConfig) Đảm bảo cấu hình được kích hoạt lần cuối có sẵn cho getters.
tìm nạpAndActivate(remoteConfig) Thực hiện các thao tác tìm nạp và kích hoạt để thuận tiện.
tìm nạpConfig(remoteConfig) Tìm nạp và lưu trữ cấu hình từ dịch vụ Cấu hình từ xa.
getAll(remoteConfig) Nhận tất cả cấu hình.
getBoolean(remoteConfig, key) Lấy giá trị cho khóa đã 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 khóa đã cho dưới dạng số. Phương thức thuận tiện để gọi remoteConfig.getValue(key).asNumber() .
getString(remoteConfig, key) Nhận giá trị cho khóa đã cho dưới dạng chuỗi. Phương thức thuận tiện để gọi remoteConfig.getValue(key).asString() .
getValue(remoteConfig, key) Nhận giá trị cho khóa đã cho.
setLogLevel(remoteConfig, logLevel) Xác định cấp độ nhật ký để sử dụng.
chức năng()
được hỗ trợ() Phương pháp này cung cấp hai kiểm tra khác nhau: 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 lệnh gọi IndexedDB open() hay không.

Giao diện

Giao diện Sự miêu tả
Cấu hình từ xa Giao diện dịch vụ Cấu hình từ xa Firebase.
Cài đặt cấu hình từ xa Xác định các tùy chọn cấu hình cho SDK cấu hình từ xa.
Giá trị Bao bọc một giá trị bằng siêu dữ liệu và getter an toàn loại.

Nhập bí danh

Nhập bí danh Sự miêu tả
Trạng thái tìm nạp Tóm tắt kết quả của lần thử 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 phiên bản RemoteConfig chưa thử 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ử cuối cùng không thành công.
  • "ga" cho biết lần thử cuối cùng bị giới hạn tốc độ.
Mức đăng nhập Xác định mức độ ghi nhật ký Cấu hình từ xa.
Nguồn giá trị Cho biết nguồn của một giá trị.
  • "tĩnh" biểu thị giá trị được xác định bởi 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.
  • "remote" cho biết giá trị được xác định bởi cấu hình được tìm nạp.

chức năng (ứng dụng, ...)

getRemoteConfig(ứng dụng)

Chữ ký:

export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Firebase Phiên bản FirebaseApp .

Trả về:

Cấu hình từ xa

Một phiên bản RemoteConfig .

chức năng (remoteConfig, ...)

kích hoạt (remoteConfig)

Cung cấp cấu hình được tìm nạp cuối cùng cho getters.

Chữ ký:

export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;

Thông số

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .

Trả về:

Lời hứa<boolean>

Promise có giá trị đúng nếu lệnh gọi hiện tại kích hoạt cấu hình được tìm nạp. Nếu các cấu hình tìm nạp đã được kích hoạt, Promise sẽ chuyển thành false.

đảm bảo được khởi tạo (remoteConfig)

Đảm bảo cấu hình được kích hoạt lần cuối có sẵn cho getters.

Chữ ký:

export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .

Trả về:

Hứa<void>

Promise sẽ được giải quyết khi cấu hình được kích hoạt lần cuối có sẵn cho getters.

tìm nạpAndActivate(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ố

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .

Trả về:

Lời hứa<boolean>

Promise có giá trị đúng nếu lệnh gọi hiện tại kích hoạt cấu hình được tìm nạp. Nếu các cấu hình tìm nạp đã được kích hoạt, Promise sẽ chuyển thành sai.

tìm nạpConfig(remoteConfig)

Tìm nạp và lưu trữ cấu hình từ dịch vụ Cấu hình từ xa.

Chữ ký:

export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .

Trả về:

Hứa<void>

getAll(remoteConfig)

Nhận tất cả cấu hình.

Chữ ký:

export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;

Thông số

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .

Trả về:

Bản ghi<chuỗi, Giá trị >

Tất cả cấu hình.

getBoolean(remoteConfig, key)

Lấy giá trị cho khóa đã 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ố

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .
chìa khóa sợi dây Tên của thông số.

Trả về:

boolean

Giá trị của khóa đã cho dưới dạng boolean.

getNumber(remoteConfig, key)

Lấy giá trị của khóa đã 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ố

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .
chìa khóa sợi dây Tên của thông số.

Trả về:

con số

Giá trị của khóa đã cho dưới dạng số.

getString(remoteConfig, key)

Nhận giá trị cho khóa đã 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ố

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .
chìa khóa sợi dây Tên của thông số.

Trả về:

sợi dây

Giá trị của khóa đã cho dưới dạng chuỗi.

getValue(remoteConfig, key)

Nhận giá trị cho khóa đã cho.

Chữ ký:

export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;

Thông số

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .
chìa khóa sợi dây Tên của thông số.

Trả về:

Giá trị

Giá trị của khóa đã cho.

setLogLevel(remoteConfig, logLevel)

Xác định cấp độ nhật ký để sử dụng.

Chữ ký:

export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

Thông số

Tham số Kiểu Sự miêu tả
cấu hình từ xa Cấu hình từ xa Phiên bản RemoteConfig .
mức đăng nhập RemoteConfigLogLevel Mức nhật ký cần thiết lập.

Trả về:

trống rỗng

chức năng()

được hỗ trợ()

Phương pháp này cung cấp hai kiểm tra khác nhau:

  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 lệnh gọi IndexedDB open() hay không.

Chữ ký:

export declare function isSupported(): Promise<boolean>;

Trả về:

Lời hứa<boolean>

Một Promise có giá trị đúng nếu phiên bản RemoteConfig có thể được khởi tạo trong môi trường này hoặc sai nếu không thể.

Trạng thái tìm nạp

Tóm tắt kết quả của lần thử tìm nạp cấu hình gần đây nhất từ ​​máy chủ Cấu hình từ xa Firebase.

  • "no-fetch-yet" cho biết phiên bản [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) chưa thử 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ử cuối cùng không thành công.
  • "ga" cho biết lần thử cuối cùng bị giới hạn tốc độ.

Chữ ký:

export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

Mức đăng nhập

Xác định mức độ 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" biểu thị giá trị được xác định bởi 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.
  • "remote" cho biết giá trị được xác định bởi cấu hình được tìm nạp.

Chữ ký:

export declare type ValueSource = 'static' | 'default' | 'remote';