Zdalna konfiguracja Firebase.
Funkcje
Funkcja | Opis |
---|---|
getRemoteConfig(aplikacja) | Pobiera usługę RemoteConfig dla domyślnej aplikacji lub aplikacji.getRemoteConfig() można wywołać bez argumentów, aby uzyskać dostęp do usługi RemoteConfig domyślnej aplikacji, lub jako getRemoteConfig(app) , aby uzyskać dostęp do usługi RemoteConfig powiązanej z konkretną aplikacją. |
Zajęcia
Klasa | Opis |
---|---|
Zdalna konfiguracja | Interfejs usługi RemoteConfig Firebase. |
Wyliczenia
Wyliczenie | Opis |
---|---|
PercentConditionOperator | Definiuje obsługiwane operatory dla warunków procentowych. |
Interfejsy
Interfejs | Opis |
---|---|
AndCondition | Reprezentuje zbiór warunków, które zwracają wartość prawda, jeśli wszystkie są spełnione. |
ThatParameterValue | Interfejs reprezentujący jawną wartość parametru. |
GetServerTemplateOptions | Reprezentuje opcjonalne argumenty, których można używać podczas tworzenia instancji ServerTemplate. |
InAppDefaultValue | Interfejs reprezentujący wartość domyślną w aplikacji. |
InitServerTemplateOptions | Reprezentuje opcjonalne argumenty, których można używać podczas synchronicznego tworzenia instancji ServerTemplate. |
ListVersionsOptions | Interfejs przedstawiający opcje operacji listy wersji Zdalnej konfiguracji. |
Wynik listy wersji | Interfejs przedstawiający listę wersji szablonu Zdalnej konfiguracji. |
MikroPercentZakres | Reprezentuje limit centyli docelowych w mikroprocentach. Wartość musi należeć do zakresu od 0 do 100000000 |
NamedCondition | Reprezentuje warunek Zdalnej konfiguracji w platformie danych. Warunek jest kierowany na określoną grupę użytkowników. Lista tych warunków stanowi część szablonu Zdalnej konfiguracji. |
OneOfCondition | Reprezentuje warunek, który może być jednym z kilku typów. Przetworzone zostanie tylko pierwsze zdefiniowane pole. |
OrCondition | Reprezentuje zbiór warunków, które sprawdzają się, jeśli któreś z nich są spełnione. |
PercentCondition | Reprezentuje warunek, który porównuje pseudolosowy percentyl instancji z podanym limitem. |
RemoteConfigCondition | Interfejs reprezentujący warunek Zdalnej konfiguracji. Warunek jest kierowany na określoną grupę użytkowników. Lista tych warunków stanowi część szablonu Zdalnej konfiguracji. |
Parametr Zdalnej konfiguracji | Interfejs reprezentujący parametr Zdalnej konfiguracji. Aby parametr działał, wymagany jest co najmniej wpis defaultValue lub conditionalValues . |
RemoteConfigParameterGroup | Interfejs reprezentujący grupę parametrów Zdalnej konfiguracji. Parametry grupowania służą tylko do zarządzania i nie mają wpływu na pobieranie wartości parametrów po stronie klienta. |
Szablon konfiguracji zdalnej | Reprezentuje szablon klienta Zdalnej konfiguracji. |
Użytkownik Zdalnej konfiguracji | Interfejs reprezentujący użytkownika Zdalnej konfiguracji. |
Konfiguracja serwera | Reprezentuje konfigurację wygenerowaną przez ocenę szablonu serwera. |
Szablon serwera | Reprezentuje stanową abstrakcję dla szablonu serwera Zdalnej konfiguracji. |
ServerTemplateData (Dane szablonu serwera) | Reprezentuje dane w szablonie serwera Zdalnej konfiguracji. |
Wartość | Opakowuje wartość parametru metadanymi i metodami pobierającymi bezpieczne dla typu.Metody pobierające bezpieczne dla typu izolują logikę aplikacji od zdalnych zmian nazw i typów parametrów. |
Wersja | Interfejs reprezentujący wersję szablonu Zdalnej konfiguracji. Tylko dane wyjściowe, z wyjątkiem opisu wersji. Zawiera metadane dotyczące określonej wersji szablonu Zdalnej konfiguracji. Wszystkie pola są ustawiane w momencie opublikowania określonego szablonu Zdalnej konfiguracji. Pole opisu wersji można określić w wywołaniach publishTemplate . |
Typ aliasów
Typ aliasu | Opis |
---|---|
DefaultConfig | Określa format domyślnych wartości parametrów w aplikacji. |
EvaluationContext (Kontekst oceny) | Reprezentuje sygnały wejściowe oceny szablonu. |
ParametrValueType | Typ reprezentujący typ danych wartości parametru Zdalnej konfiguracji. Jeśli nie określono inaczej, domyślna wartość to STRING . |
RemoteConfigParameterValue | Typ reprezentujący wartość parametru Zdalnej konfiguracji. Elementem RemoteConfigParameterValue może być ExplicitParameterValue lub InAppDefaultValue . |
ServerTemplateDataType (Typ danych serwera). | Reprezentuje typ szablonu serwera Zdalnej konfiguracji, który można ustawić w obiekcie ServerTemplate. Może to być obiekt ServerTemplateData lub ciąg tekstowy JSON szablonu. |
TagColor | Kolory powiązane z warunkami do wyświetlania. |
Źródło wartości | Wskazuje źródło wartości.
|
getRemoteConfig(aplikacja)
Pobiera usługę RemoteConfig dla domyślnej aplikacji lub danej aplikacji.
Funkcję getRemoteConfig()
można wywołać bez argumentów, aby uzyskać dostęp do usługi RemoteConfig
domyślnej aplikacji, lub jako getRemoteConfig(app)
, aby uzyskać dostęp do usługi RemoteConfig
powiązanej z konkretną aplikacją.
Podpis:
export declare function getRemoteConfig(app?: App): RemoteConfig;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja | Opcjonalna aplikacja, dla której ma zostać zwrócona usługa RemoteConfig . Jeśli nie zostanie podana, zwracana jest domyślna usługa RemoteConfig . |
Zwroty:
Domyślna usługa RemoteConfig
, jeśli nie podano żadnej aplikacji, lub usługa RemoteConfig
powiązana z udostępnioną aplikacją.
Przykład 1
// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();
Przykład 2
// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);
Domyślna konfiguracja
Określa format domyślnych wartości parametrów w aplikacji.
Podpis:
export type DefaultConfig = {
[key: string]: string | number | boolean;
};
Kontekst oceny
Reprezentuje sygnały wejściowe oceny szablonu.
Podpis:
export type EvaluationContext = {
randomizationId?: string;
};
Typ wartości parametru
Typ reprezentujący typ danych wartości parametru Zdalnej konfiguracji. Jeśli nie określono inaczej, domyślna wartość to STRING
.
Podpis:
export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';
Wartość parametru RemoteConfig
Typ reprezentujący wartość parametru Zdalnej konfiguracji. Elementem RemoteConfigParameterValue
może być ExplicitParameterValue
lub InAppDefaultValue
.
Podpis:
export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
Typ danych szablonu serwera
Reprezentuje typ szablonu serwera Zdalnej konfiguracji, który można ustawić w obiekcie ServerTemplate. Może to być obiekt ServerTemplateData lub ciąg tekstowy JSON szablonu.
Podpis:
export type ServerTemplateDataType = ServerTemplateData | string;
Kolor Znacznika
Kolory powiązane z warunkami do wyświetlania.
Podpis:
export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';
Źródło wartości
Wskazuje źródło wartości.
- „static” wskazuje, że wartość została zdefiniowana przez stałą statyczną.
- „default” wskazuje, że wartość została zdefiniowana w konfiguracji domyślnej.
- „remote” oznacza, że wartość została zdefiniowana przez konfigurację wygenerowaną na podstawie oceny szablonu.
Podpis:
export type ValueSource = 'static' | 'default' | 'remote';
OperatorWarunku%
Definiuje obsługiwane operatory dla warunków procentowych.
Podpis:
export declare enum PercentConditionOperator
Członkowie wyliczenia
Użytkownik | Wartość | Opis |
---|---|---|
POMIĘDZY | "BETWEEN" |
Docelowe percentyle w przedziale zdefiniowanym przez dolną i górną granicę. Dolna granica jest granicą wyłączną (otwartą), a mikro_percent_range_górna_granica jest granicą włączeniową (zamkniętą). Warunek z tym operatorem musi określać mikroPercentRange. |
GREATER_THAN | "GREATER_THAN" |
Docelowe centyle większe niż docelowa wartość procentowa. Warunek z tym operatorem musi określać mikroPercent. |
MNIEJ_LUB_RÓWNE | "LESS_OR_EQUAL" |
Docelowe centyle mniejsze lub równe docelowemu procentowi. Warunek z tym operatorem musi określać mikroPercent. |
BRAK INFORMACJI | "UNKNOWN" |
Przypadek błędu typu catch-all. |