remote-config package

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

İşlevler

İşlev Açıklama
fonksiyon(uygulama, ...)
getRemoteConfig(uygulama)
fonksiyon(remoteConfig, ...)
enable(remoteConfig) En son getirilen yapılandırmayı, alıcıların kullanımına sunar.
ensureInitialized(remoteConfig) Son etkinleştirilen yapılandırmanın alıcılar tarafından kullanılabilir olmasını sağlar.
fetchAndEtkinleştir(remoteConfig) Kolaylık sağlamak amacıyla 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ırmaları alır.
getBoolean(remoteConfig, anahtar) Verilen anahtarın değerini boole olarak alır.remoteConfig.getValue(key).asBoolean() çağrılmasının uygun yöntemi.
getNumber(remoteConfig, anahtar) Belirli bir anahtarın değerini sayı olarak alır.remoteConfig.getValue(key).asNumber() çağrılmasının uygun yöntemi.
getString(remoteConfig, anahtar) Belirli bir anahtarın değerini bir dize olarak alır. remoteConfig.getValue(key).asString() çağrısı için kullanışlı yöntem.
getValue(remoteConfig, anahtar) Belirli bir anahtarın Değerini alır.
setLogLevel(remoteConfig, logLevel) Kullanılacak günlük düzeyini tanımlar.
fonksiyon()
isSupported() Bu yöntem iki farklı kontrol sağlar:1. IndexedDB'nin tarayıcı ortamında mevcut olup olmadığını kontrol edin. 2. Geçerli tarayıcı bağlamının IndexedDB open() çağrılarına izin verip vermediğini kontrol edin.

Arayüzler

Arayüz Açıklama
RemoteConfig Firebase Remote Config hizmeti arayüzü.
RemoteConfigSettings Remote Config SDK'sının yapılandırma seçeneklerini tanımlar.
Değer Bir değeri meta veri ve tür açısından güvenli alıcılarla sarmalar.

Tür Takma Adları

Takma Ad yazın Açıklama
Getirme Durumu Firebase Remote Config sunucusundan yapılandırma getirmeye yönelik son denemenin sonucunu özetler.
  • "henüz getirilmiyor" RemoteConfig örneğinin henüz yapılandırmayı getirmeye çalışmadığını veya SDK başlatma işleminin tamamlanmadığını belirtir.
  • "başarı" son denemenin başarılı olduğunu gösterir.
  • "başarısız" son denemenin başarısız olduğunu gösterir.
  • "kısıtlama" son denemenin hız sınırlı olduğunu gösterir.
LogLevel Remote Config günlük kaydı düzeylerini tanımlar.
ValueSource Bir değerin kaynağını gösterir.
  • "statik" değerin statik bir sabit sayıyla tanımlandığını gösterir.
  • "varsayılan" değerin varsayılan yapılandırma tarafından tanımlandığını gösterir.
  • "uzaktan" değerin getirilen yapılandırma tarafından tanımlandığını gösterir.

function(uygulama; ...)

getRemoteConfig(uygulama)

İmza:

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

Parametreler

Parametre Tür Açıklama
uygulama FirebaseUygulaması FirebaseApp örneği.

Şunu döndürür:

RemoteConfig

RemoteConfig örneği.

function(remoteConfig; ...)

etkin(remoteConfig)

En son getirilen yapılandırmayı, alıcıların kullanımına sunar.

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.

Şunu döndürür:

Promise&lt;boolean&gt;

Alınan yapılandırmalar, geçerli çağrı tarafından etkinleştirildiyse doğru olarak çözümlenen Promise. Getirilen yapılandırmalar daha önce etkinleştirilmişse Promise yanlış değerine çözümlenir.

allowInitialized(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 Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.

Şunu döndürür:

Taahhüt<void>

Son etkinleştirilen yapılandırma, alıcılar tarafından kullanıma sunulduğunda çözümlenen bir Promise.

receiveAndEtkinleştir(remoteConfig)

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

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.

Şunu döndürür:

Promise&lt;boolean&gt;

Alınan yapılandırmalar, geçerli çağrı tarafından etkinleştirildiyse doğru olarak çözümlenen Promise. Getirilen yapılandırmalar daha önce etkinleştirilmişse Promise yanlış değerine çözümlenir.

receiveConfig(remoteConfig)

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

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.

Şunu döndürür:

Taahhüt<void>

getAll(remoteConfig)

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

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.

Şunu döndürür:

Record<dize, Değer>

Tüm yapılandırmalar.

getBoolean(remoteConfig; anahtar)

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

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

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar dize Parametrenin adı.

Şunu döndürür:

boolean

Belirli bir anahtarın boole değeri olarak değeri.

getNumber(remoteConfig; anahtar)

Belirli bir anahtarın değerini sayı olarak alır.

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

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar dize Parametrenin adı.

Şunu döndürür:

sayı

Belirli bir anahtarın sayı olarak değeridir.

getString(remoteConfig; anahtar)

Belirli bir anahtarın değerini bir dize olarak alır. remoteConfig.getValue(key).asString() çağrısı için kullanışlı yöntem.

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar dize Parametrenin adı.

Şunu döndürür:

dize

Belirli bir anahtarın dize olarak değeri.

getValue(remoteConfig; anahtar)

Belirli bir anahtarın Değerini alır.

İmza:

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

Parametreler

Parametre Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.
anahtar dize Parametrenin adı.

Şunu döndürür:

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 Tür Açıklama
RemoteConfig RemoteConfig RemoteConfig örneği.
logLevel RemoteConfigLogLevel Ayarlanacak günlük düzeyi.

Şunu döndürür:

geçersiz

fonksiyon()

isDesteklenen()

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

  1. IndexedDB'nin tarayıcı ortamında mevcut olup olmadığını kontrol edin. 2. Geçerli tarayıcı bağlamının IndexedDB open() çağrılarına izin verip vermediğini kontrol edin.

İmza:

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

Şunu döndürür:

Promise&lt;boolean&gt;

Bu ortamda bir RemoteConfig örneği başlatılabiliyorsa doğru, yapılamıyorsa false (yanlış) olarak çözümlenen Promise.

Getirme Durumu

Firebase Remote Config sunucusundan yapılandırma getirmek için yapılan son denemenin sonucunu özetler.

  • "henüz getirilmiyor" [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) örneğinin henüz yapılandırmayı getirmediğini veya SDK başlatma işleminin tamamlanmadığını gösterir.
  • "başarı" son denemenin başarılı olduğunu gösterir.
  • "başarısız" son denemenin başarısız olduğunu gösterir.
  • "kısıtlama" son denemenin hız sınırlı olduğunu gösterir.

İmza:

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

LogLevel

Remote Config günlük kaydı düzeylerini tanımlar.

İmza:

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

DeğerKaynağı

Bir değerin kaynağını gösterir.

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

İmza:

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