SDK Web Konfigurasi Jarak Jauh Firebase. SDK ini tidak berfungsi di lingkungan Node.js.
Fungsi
Fungsi | Keterangan |
---|---|
fungsi(aplikasi, ...) | |
dapatkanRemoteConfig(aplikasi) | |
fungsi(konfigurasi jarak jauh, ...) | |
aktifkan (remoteConfig) | Membuat konfigurasi yang terakhir diambil tersedia bagi pengambil. |
memastikan Inisialisasi (remoteConfig) | Memastikan konfigurasi yang terakhir diaktifkan tersedia untuk pengambil. |
ambilDanAktifkan(remoteConfig) | Melakukan operasi pengambilan dan pengaktifan, demi kenyamanan. |
ambilConfig(remoteConfig) | Mengambil dan menyimpan konfigurasi dari layanan Remote Config. |
dapatkanSemua(remoteConfig) | Mendapatkan semua konfigurasi. |
getBoolean(remoteConfig, kunci) | Mendapatkan nilai untuk kunci yang diberikan sebagai boolean. Metode praktis untuk memanggil remoteConfig.getValue(key).asBoolean() . |
getNumber(remoteConfig, kunci) | Mendapatkan nilai untuk kunci yang diberikan sebagai angka. Metode praktis untuk memanggil remoteConfig.getValue(key).asNumber() . |
getString(remoteConfig, kunci) | Mendapatkan nilai untuk kunci yang diberikan sebagai string. Metode praktis untuk memanggil remoteConfig.getValue(key).asString() . |
getValue(remoteConfig, kunci) | Mendapatkan Nilai untuk kunci yang diberikan. |
setLogLevel(remoteConfig, logLevel) | Menentukan tingkat log yang akan digunakan. |
fungsi() | |
didukung() | Metode ini menyediakan dua pemeriksaan berbeda: 1. Periksa apakah IndexedDB ada di lingkungan browser. 2. Periksa apakah konteks browser saat ini mengizinkan panggilan IndexedDB open() . |
Antarmuka
Antarmuka | Keterangan |
---|---|
Konfigurasi Jarak Jauh | Antarmuka layanan Firebase Remote Config. |
Pengaturan Konfigurasi Jarak Jauh | Menentukan opsi konfigurasi untuk Remote Config SDK. |
Nilai | Membungkus nilai dengan metadata dan pengambil yang aman untuk tipe. |
Ketik Alias
Ketik Alias | Keterangan |
---|---|
AmbilStatus | Meringkas hasil upaya terakhir mengambil konfigurasi dari server Firebase Remote Config.
|
Tingkat Log | Menentukan tingkat logging Remote Config. |
Sumber Nilai | Menunjukkan sumber suatu nilai.
|
fungsi(aplikasi, ...)
dapatkanRemoteConfig(aplikasi)
Tanda tangan:
export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi Firebase | Contoh FirebaseApp . |
Pengembalian:
Contoh RemoteConfig .
fungsi(konfigurasi jarak jauh, ...)
aktifkan (remoteConfig)
Membuat konfigurasi yang terakhir diambil tersedia bagi pengambil.
Tanda tangan:
export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
Pengembalian:
Janji<boolean>
Promise
yang dianggap benar jika panggilan saat ini mengaktifkan konfigurasi yang diambil. Jika konfigurasi yang diambil sudah diaktifkan, Promise
akan dianggap salah.
memastikan Inisialisasi (remoteConfig)
Memastikan konfigurasi yang terakhir diaktifkan tersedia untuk pengambil.
Tanda tangan:
export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
Pengembalian:
Janji<batal>
Promise
yang diselesaikan ketika konfigurasi terakhir yang diaktifkan tersedia untuk pengambil.
ambilDanAktifkan(remoteConfig)
Melakukan operasi pengambilan dan pengaktifan, demi kenyamanan.
Tanda tangan:
export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
Pengembalian:
Janji<boolean>
Promise
yang dianggap benar jika panggilan saat ini mengaktifkan konfigurasi yang diambil. Jika konfigurasi yang diambil sudah diaktifkan, Promise
akan dianggap salah.
ambilConfig(remoteConfig)
Mengambil dan menyimpan konfigurasi dari layanan Remote Config.
Tanda tangan:
export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
Pengembalian:
Janji<batal>
dapatkanSemua(remoteConfig)
Mendapatkan semua konfigurasi.
Tanda tangan:
export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
Pengembalian:
Rekam<string, Nilai >
Semua konfigurasi.
getBoolean(remoteConfig, kunci)
Mendapatkan nilai untuk kunci yang diberikan sebagai boolean.
Metode praktis untuk memanggil remoteConfig.getValue(key).asBoolean()
.
Tanda tangan:
export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
kunci | rangkaian | Nama parameternya. |
Pengembalian:
boolean
Nilai kunci yang diberikan sebagai boolean.
getNumber(remoteConfig, kunci)
Mendapatkan nilai untuk kunci yang diberikan sebagai angka.
Metode praktis untuk memanggil remoteConfig.getValue(key).asNumber()
.
Tanda tangan:
export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
kunci | rangkaian | Nama parameternya. |
Pengembalian:
nomor
Nilai untuk kunci yang diberikan sebagai angka.
getString(remoteConfig, kunci)
Mendapatkan nilai untuk kunci yang diberikan sebagai string. Metode praktis untuk memanggil remoteConfig.getValue(key).asString()
.
Tanda tangan:
export declare function getString(remoteConfig: RemoteConfig, key: string): string;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
kunci | rangkaian | Nama parameternya. |
Pengembalian:
rangkaian
Nilai untuk kunci yang diberikan sebagai string.
getValue(remoteConfig, kunci)
Mendapatkan Nilai untuk kunci yang diberikan.
Tanda tangan:
export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
kunci | rangkaian | Nama parameternya. |
Pengembalian:
Nilai untuk kunci yang diberikan.
setLogLevel(remoteConfig, logLevel)
Menentukan tingkat log yang akan digunakan.
Tanda tangan:
export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
konfigurasi jarak jauh | Konfigurasi Jarak Jauh | Contoh RemoteConfig . |
tingkat log | Tingkat RemoteConfigLog | Level log yang akan disetel. |
Pengembalian:
ruang kosong
fungsi()
didukung()
Metode ini menyediakan dua pemeriksaan berbeda:
- Periksa apakah IndexedDB ada di lingkungan browser. 2. Periksa apakah konteks browser saat ini mengizinkan panggilan IndexedDB
open()
.
Tanda tangan:
export declare function isSupported(): Promise<boolean>;
Pengembalian:
Janji<boolean>
Promise
yang ditetapkan menjadi true jika instance RemoteConfig dapat diinisialisasi di lingkungan ini, atau false jika tidak dapat diinisialisasi.
AmbilStatus
Meringkas hasil upaya terakhir mengambil konfigurasi dari server Firebase Remote Config.
- "no-fetch-yet" menunjukkan instance [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) belum mencoba mengambil konfigurasi, atau inisialisasi SDK tidak lengkap.
- "sukses" menunjukkan upaya terakhir berhasil.
- "kegagalan" menunjukkan upaya terakhir gagal.
- "throttle" menunjukkan upaya terakhir dibatasi tingkatnya.
Tanda tangan:
export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
Tingkat Log
Menentukan tingkat logging Remote Config.
Tanda tangan:
export declare type LogLevel = 'debug' | 'error' | 'silent';
Sumber Nilai
Menunjukkan sumber suatu nilai.
- "statis" menunjukkan nilai ditentukan oleh konstanta statis.
- "default" menunjukkan nilai yang ditentukan oleh konfigurasi default.
- "jarak jauh" menunjukkan nilai ditentukan oleh konfigurasi yang diambil.
Tanda tangan:
export declare type ValueSource = 'static' | 'default' | 'remote';