remote-config package

Firebase Remote Config Web SDK'sı. Bu SDK, Node.js ortamında çalışmaz.

Fonksiyonlar

İşlev Tanım
işlev(uygulama, ...)
getRemoteConfig(uygulama)
fonksiyon(remoteConfig, ...)
etkinleştir(remoteConfig) Son getirilen yapılandırmayı alıcıların kullanımına sunar.
sureInitialized(remoteConfig) Son etkinleştirilen yapılandırmanın alıcılar tarafından kullanılabilir olmasını sağlar.
fetchAndActivate(remoteConfig) Kolaylık sağlamak için getirme ve etkinleştirme işlemlerini gerçekleştirir.
fetchConfig(remoteConfig) Remote Config hizmetinden yapılandırmayı getirir ve önbelleğe alır.
getAll(remoteConfig) Tüm yapılandırmayı alır.
getBoolean(remoteConfig, anahtar) Verilen anahtarın değerini boolean olarak alır. remoteConfig.getValue(key).asBoolean() çağırmak için kullanışlı yöntem.
getNumber(remoteConfig, anahtar) Verilen anahtarın değerini sayı olarak alır. remoteConfig.getValue(key).asNumber() çağırmak için kullanışlı yöntem.
getString(remoteConfig, anahtar) Verilen anahtarın değerini dize olarak alır. remoteConfig.getValue(key).asString() çağırmak için kullanışlı yöntem.
getValue(remoteConfig, anahtar) Verilen anahtarın Değerini alır.
setLogLevel(remoteConfig, logLevel) Kullanılacak günlük düzeyini tanımlar.
işlev()
desteklenir() Bu yöntem iki farklı kontrol sağlar: 1. Tarayıcı ortamında IndexedDB'nin mevcut olup olmadığını kontrol edin. 2. Mevcut tarayıcı içeriğinin IndexedDB open() çağrılarına izin verip vermediğini kontrol edin.

Arayüzler

Arayüz Tanım
RemoteConfig Firebase Remote Config hizmet arayüzü.
RemoteConfig Ayarları Remote Config SDK'nın yapılandırma seçeneklerini tanımlar.
Değer Bir değeri meta veriler ve tür açısından güvenli alıcılarla sarar.

Takma Adları Yazın

Takma Ad yazın Tanım
Durumu Getir Firebase Remote Config sunucusundan yapılandırmayı almaya yönelik son girişimin sonucunu özetler.
  • "henüz getirme yok", RemoteConfig örneğinin henüz yapılandırmayı almaya çalışmadığını veya SDK başlatma işleminin tamamlanmadığını gösterir.
  • "başarılı" son denemenin başarılı olduğunu gösterir.
  • "başarısız" son denemenin başarısız olduğunu gösterir.
  • "gaz kelebeği" son denemenin hız sınırlı olduğunu gösterir.
Günlük Düzeyi Remote Config günlüğünün düzeylerini tanımlar.
Değer Kaynağı Bir değerin kaynağını belirtir.
  • "statik", değerin statik bir sabit tarafından tanımlandığını gösterir.
  • "varsayılan", değerin varsayılan yapılandırma tarafından tanımlandığını gösterir.
  • "uzak", değerin getirilen yapılandırma tarafından tanımlandığını gösterir.

işlev(uygulama, ...)

getRemoteConfig(uygulama)

İmza:

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

Parametreler

Parametre Tip Tanım
uygulama Firebase Uygulaması FirebaseApp örneği.

İadeler:

RemoteConfig

Bir RemoteConfig örneği.

fonksiyon(remoteConfig, ...)

etkinleştir(remoteConfig)

Son getirilen yapılandırmayı alıcıların kullanımına sunar.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.

İadeler:

Söz<boolean>

Geçerli çağrının getirilen yapılandırmaları etkinleştirmesi durumunda doğru olarak çözümlenen bir Promise . Getirilen yapılandırmalar zaten etkinleştirilmişse Promise false olarak çözümlenecektir.

sureInitialized(remoteConfig)

Son etkinleştirilen yapılandırmanın alıcılar tarafından kullanılabilir olmasını sağlar.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.

İadeler:

Söz<void>

Alıcılar için son etkinleştirilen yapılandırma mevcut olduğunda çözülen bir Promise .

fetchAndActivate(remoteConfig)

Kolaylık sağlamak için getirme ve etkinleştirme işlemlerini gerçekleştirir.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.

İadeler:

Söz<boolean>

Geçerli çağrının getirilen yapılandırmaları etkinleştirmesi durumunda doğru olarak çözümlenen bir Promise . Getirilen yapılandırmalar zaten etkinleştirilmişse Promise false olarak çözümlenecektir.

fetchConfig(remoteConfig)

Remote Config hizmetinden yapılandırmayı getirir ve önbelleğe alır.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.

İadeler:

Söz<void>

getAll(remoteConfig)

Tüm yapılandırmayı alır.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.

İadeler:

Kayıt<dize, Değer >

Tüm yapılandırma.

getBoolean(remoteConfig, anahtar)

Verilen anahtarın değerini boolean olarak alır.

remoteConfig.getValue(key).asBoolean() çağırmak için kullanışlı yöntem.

İmza:

export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar sicim Parametrenin adı.

İadeler:

boolean

Verilen anahtarın boole değeri.

getNumber(remoteConfig, anahtar)

Verilen anahtarın değerini sayı olarak alır.

remoteConfig.getValue(key).asNumber() çağırmak için kullanışlı yöntem.

İmza:

export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar sicim Parametrenin adı.

İadeler:

sayı

Verilen anahtarın sayı olarak değeri.

getString(remoteConfig, anahtar)

Verilen anahtarın değerini string olarak alır. remoteConfig.getValue(key).asString() çağırmak için kullanışlı yöntem.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar sicim Parametrenin adı.

İadeler:

sicim

Verilen anahtarın dize olarak değeri.

getValue(remoteConfig, anahtar)

Verilen anahtarın Değerini alır.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar sicim Parametrenin adı.

İadeler:

Değer

Verilen anahtarın değeri.

setLogLevel(remoteConfig, logLevel)

Kullanılacak günlük düzeyini tanımlar.

İmza:

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

Parametreler

Parametre Tip Tanım
RemoteConfig RemoteConfig RemoteConfig örneği.
günlükSeviyesi RemoteConfigLogLevel Ayarlanacak günlük düzeyi.

İadeler:

geçersiz

işlev()

desteklenir()

Bu yöntem iki farklı kontrol sağlar:

  1. Tarayıcı ortamında IndexedDB'nin mevcut olup olmadığını kontrol edin. 2. Mevcut tarayıcı içeriğinin IndexedDB open() çağrılarına izin verip vermediğini kontrol edin.

İmza:

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

İadeler:

Söz<boolean>

Bir RemoteConfig örneği bu ortamda başlatılabiliyorsa true değerine, başlatılamıyorsa false değerine çözümlenen bir Promise .

Durumu Getir

Firebase Remote Config sunucusundan yapılandırmayı almaya yönelik son girişimin sonucunu özetler.

  • "no-fetch-henüz", [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) örneğinin henüz yapılandırmayı almaya çalışmadığını veya SDK başlatma işleminin tamamlanmadığını belirtir.
  • "başarılı" son denemenin başarılı olduğunu gösterir.
  • "başarısız" son denemenin başarısız olduğunu gösterir.
  • "gaz kelebeği" son denemenin hız sınırlı olduğunu gösterir.

İmza:

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

Günlük Düzeyi

Remote Config günlüğünün düzeylerini tanımlar.

İmza:

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

Değer Kaynağı

Bir değerin kaynağını belirtir.

  • "statik", değerin statik bir sabit tarafından tanımlandığını gösterir.
  • "varsayılan", değerin varsayılan yapılandırma tarafından tanımlandığını gösterir.
  • "uzak", değerin getirilen yapılandırma tarafından tanımlandığını gösterir.

İmza:

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