remote-config package

Firebase Remote Config Web SDK. SDK ini tidak berfungsi di lingkungan Node.js.

Functions

Fungsi Deskripsi
fungsi(aplikasi, ...)
getRemoteConfig(aplikasi)
function(remoteConfig, ...)
activate(remoteConfig) Membuat konfigurasi yang terakhir diambil tersedia untuk pengambil.
memastikanInitialized(remoteConfig) Memastikan konfigurasi yang terakhir diaktifkan tersedia untuk pengambil.
fetchAndActivate(remoteConfig) Melakukan operasi pengambilan dan aktifkan, demi kenyamanan.
fetchConfig(remoteConfig) Mengambil dan meng-cache konfigurasi dari layanan Remote Config.
getAll(remoteConfig) Mendapatkan semua konfigurasi.
getBoolean(remoteConfig, kunci) Mendapatkan nilai untuk kunci tertentu 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 level log yang akan digunakan.
function()
isDidukung() Metode ini memberikan dua pemeriksaan yang berbeda:1. Periksa apakah IndexedDB ada di lingkungan browser. 2. Periksa apakah konteks browser saat ini mengizinkan panggilan open() IndexedDB.

Antarmuka

Antarmuka Deskripsi
RemoteConfig Antarmuka layanan Firebase Remote Config.
RemoteConfigSettings Menentukan opsi konfigurasi untuk Remote Config SDK.
Value Menggabungkan nilai dengan metadata dan pengambil yang aman.

Ketik Alias

Ketik Alias Deskripsi
FetchStatus Merangkum hasil upaya terakhir untuk mengambil konfigurasi dari server Firebase Remote Config.
  • "belum diambil" menunjukkan bahwa instance RemoteConfig belum mencoba mengambil konfigurasi, atau inisialisasi SDK tidak lengkap.
  • "berhasil" menunjukkan upaya terakhir yang berhasil.
  • "kegagalan" menunjukkan upaya terakhir yang gagal.
  • "throttle" menunjukkan bahwa upaya terakhir dibatasi kapasitasnya.
Level Log Menentukan tingkat logging Remote Config.
ValueSource Menunjukkan sumber nilai.
  • "statis" menunjukkan bahwa nilai didefinisikan oleh konstanta statis.
  • "default" menunjukkan bahwa nilai yang ditetapkan oleh konfigurasi default.
  • "jarak jauh" menunjukkan bahwa nilai ditetapkan oleh konfigurasi yang diambil.

function(aplikasi, ...)

getRemoteConfig(aplikasi)

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
aplikasi AplikasiFirebase Instance FirebaseApp.

Hasil:

RemoteConfig

Instance RemoteConfig.

function(remoteConfig, ...)

enable(remoteConfig)

Membuat konfigurasi yang terakhir diambil tersedia untuk pengambil.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.

Hasil:

Promise&lt;boolean&gt;

Promise yang di-resolve ke true jika panggilan saat ini mengaktifkan konfigurasi yang diambil. Jika konfigurasi yang diambil sudah diaktifkan, Promise akan me-resolve ke salah (false).

sureInitialized(remoteConfig)

Memastikan konfigurasi yang terakhir diaktifkan tersedia untuk pengambil.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.

Hasil:

Janji<void>

Promise yang me-resolve saat konfigurasi yang terakhir diaktifkan tersedia untuk pengambil.

ambilAndActivate(remoteConfig)

Melakukan operasi pengambilan dan aktifkan, demi kenyamanan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.

Hasil:

Promise&lt;boolean&gt;

Promise yang di-resolve ke true jika panggilan saat ini mengaktifkan konfigurasi yang diambil. Jika konfigurasi yang diambil sudah diaktifkan, Promise akan me-resolve ke salah (false).

pengambilanConfig(remoteConfig)

Mengambil dan meng-cache konfigurasi dari layanan Remote Config.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.

Hasil:

Janji<void>

getAll(remoteConfig)

Mendapatkan semua konfigurasi.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.

Hasil:

Kumpulan data<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 Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.
kunci string Nama parameter.

Hasil:

boolean

Nilai untuk 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 Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.
kunci string Nama parameter.

Hasil:

angka

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 Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.
kunci string Nama parameter.

Hasil:

string

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 Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.
kunci string Nama parameter.

Hasil:

Value

Nilai untuk kunci yang diberikan.

setLogLevel(remoteConfig, logLevel)

Menentukan level log yang akan digunakan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
RemoteConfig RemoteConfig Instance RemoteConfig.
logLevel RemoteConfigLogLevel Level log yang akan ditetapkan.

Hasil:

void

function()

isDidukung()

Metode ini memberikan dua pemeriksaan yang berbeda:

  1. Periksa apakah IndexedDB ada di lingkungan browser. 2. Periksa apakah konteks browser saat ini mengizinkan panggilan open() IndexedDB.

Tanda Tangan:

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

Hasil:

Promise&lt;boolean&gt;

Promise yang ditetapkan ke true (benar) jika instance RemoteConfig dapat diinisialisasi di lingkungan ini, atau false jika tidak bisa.

FetchStatus

Merangkum hasil upaya terakhir untuk mengambil konfigurasi dari server Firebase Remote Config.

  • "belum diambil" menunjukkan bahwa instance [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) belum mencoba mengambil konfigurasi, atau inisialisasi SDK tersebut tidak lengkap.
  • "berhasil" menunjukkan upaya terakhir yang berhasil.
  • "kegagalan" menunjukkan upaya terakhir yang gagal.
  • "throttle" menunjukkan bahwa upaya terakhir dibatasi kapasitasnya.

Tanda Tangan:

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

LogLevel

Menentukan tingkat logging Remote Config.

Tanda Tangan:

export declare type LogLevel = 'debug' | 'error' | 'silent';

SumberNilai

Menunjukkan sumber nilai.

  • "statis" menunjukkan bahwa nilai didefinisikan oleh konstanta statis.
  • "default" menunjukkan bahwa nilai yang ditetapkan oleh konfigurasi default.
  • "jarak jauh" menunjukkan bahwa nilai ditetapkan oleh konfigurasi yang diambil.

Tanda Tangan:

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