firebase-admin.remote-config package

Удаленная конфигурация Firebase.

Функции

Функция Описание
getRemoteConfig (приложение) Получает службу RemoteConfig для приложения по умолчанию или заданного приложения. getRemoteConfig() можно вызвать без аргументов для доступа к службе RemoteConfig приложения по умолчанию или как getRemoteConfig(app) для доступа к службе RemoteConfig , связанной с конкретным приложением.

Классы

Сорт Описание
Удаленная конфигурация Интерфейс службы Firebase RemoteConfig .

Перечисления

Перечисление Описание
PercentConditionОператор Определяет поддерживаемые операторы для процентных условий.

Интерфейсы

Интерфейс Описание
ИУсловие Представляет коллекцию условий, которые оцениваются как true, если все они верны.
Явное значение параметра Интерфейс, представляющий явное значение параметра.
GetServerTemplateOptions Представляет необязательные аргументы, которые можно использовать при создании экземпляра ServerTemplate. .
InAppDefaultValue Интерфейс, представляющий значение по умолчанию в приложении.
Инитсервертемплатеоптионс Представляет необязательные аргументы, которые можно использовать при синхронном создании экземпляра ServerTemplate .
Параметры списка версий Интерфейс, представляющий параметры работы версий списка Remote Config.
ListVersionsResult Интерфейс, представляющий список версий шаблона Remote Config.
Микропроцентдиапазон Представляет собой предел целевых процентилей в микропроцентах. Значение должно находиться в диапазоне [0 и 100000000]
именованное условие Представляет условие Remote Config в плоскости данных. Условие предназначено для определенной группы пользователей. Список этих условий является частью шаблона Remote Config.
OneOfCondition Представляет состояние, которое может быть одним из нескольких типов. Будет обработано только первое определенное поле.
ИлиСостояние Представляет коллекцию условий, которые оцениваются как true, если какие-либо из них верны.
Процентное условие Представляет условие, которое сравнивает псевдослучайный процентиль экземпляра с заданным пределом.
Удаленноеконфигусловие Интерфейс, представляющий условие удаленной настройки. Условие предназначено для определенной группы пользователей. Список этих условий составляет часть шаблона Remote Config.
RemoteConfigParameter Интерфейс, представляющий параметр Remote Config. Чтобы параметр имел какой-либо эффект, как минимум, должна присутствовать запись defaultValue или conditionalValues .
Группа параметров удаленной конфигурации Интерфейс, представляющий группу параметров Remote Config. Группировка параметров предназначена только для целей управления и не влияет на получение значений параметров на стороне клиента.
Шаблон удаленной конфигурации Представляет шаблон клиента Remote Config.
Удаленная конфигурацияпользователь Интерфейс, представляющий пользователя Remote Config.
Конфигурация сервера Представляет конфигурацию, созданную путем оценки шаблона сервера.
Шаблон сервера Представляет абстракцию с отслеживанием состояния для шаблона сервера Remote Config.
ServerTemplateData Представляет данные в шаблоне сервера Remote Config.
Ценить Обертывает значение параметра метаданными и типобезопасными методами получения. Типобезопасные геттеры изолируют логику приложения от удаленных изменений имен и типов параметров.
Версия Интерфейс, представляющий версию шаблона Remote Config. Только вывод, за исключением описания версии. Содержит метаданные о конкретной версии шаблона Remote Config. Все поля устанавливаются во время публикации указанного шаблона Remote Config. Поле описания версии может быть указано в вызовах publishTemplate .

Введите псевдонимы

Введите псевдоним Описание
Конфигурация по умолчанию Определяет формат значений параметров по умолчанию в приложении.
Контекст оценки Представляет входные сигналы оценки шаблона.
ПараметрЗначениеТип Тип, представляющий тип данных значения параметра Remote Config. По умолчанию используется STRING , если не указано.
RemoteConfigParameterValue Тип, представляющий значение параметра Remote Config. RemoteConfigParameterValue может быть ExplicitParameterValue или InAppDefaultValue .
Сервертемплатедататипе Представляет тип шаблона сервера Remote Config, который можно установить в ServerTemplate. . Это может быть объект ServerTemplateData или строка JSON шаблона.
Цвет тега Цвета, связанные с условиями, для целей отображения.
Источник значения Указывает источник значения.
  • «статический» указывает, что значение было определено статической константой.
  • «по умолчанию» указывает, что значение было определено конфигурацией по умолчанию.
  • «Удаленный» указывает, что значение было определено конфигурацией, созданной путем оценки шаблона.

getRemoteConfig (приложение)

Получает службу RemoteConfig для приложения по умолчанию или заданного приложения.

getRemoteConfig() можно вызвать без аргументов для доступа к службе RemoteConfig приложения по умолчанию или как getRemoteConfig(app) для доступа к службе RemoteConfig , связанной с конкретным приложением.

Подпись:

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

Параметры

Параметр Тип Описание
приложение Приложение Необязательное приложение, для которого возвращается служба RemoteConfig . Если он не указан, возвращается служба RemoteConfig по умолчанию.

Возврат:

Удаленная конфигурация

Служба RemoteConfig по умолчанию, если приложение не предоставлено, или служба RemoteConfig , связанная с предоставленным приложением.

Пример 1 

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

Пример 2 

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

Конфигурация по умолчанию

Определяет формат значений параметров по умолчанию в приложении.

Подпись:

export type DefaultConfig = {
    [key: string]: string | number | boolean;
};

Контекст оценки

Представляет входные сигналы оценки шаблона.

Подпись:

export type EvaluationContext = {
    randomizationId?: string;
};

ПараметрЗначениеТип

Тип, представляющий тип данных значения параметра Remote Config. По умолчанию используется STRING , если не указано.

Подпись:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

RemoteConfigParameterValue

Тип, представляющий значение параметра Remote Config. RemoteConfigParameterValue может быть либо ExplicitParameterValue , либо InAppDefaultValue . .

Подпись:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

Сервертемплатедататипе

Представляет тип шаблона сервера Remote Config, который можно установить в ServerTemplate. . Это может быть объект ServerTemplateData или строка JSON шаблона.

Подпись:

export type ServerTemplateDataType = ServerTemplateData | string;

Цвет тега

Цвета, связанные с условиями, для целей отображения.

Подпись:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';

Источник значения

Указывает источник значения.

  • «статический» указывает, что значение было определено статической константой.
  • «по умолчанию» указывает, что значение было определено конфигурацией по умолчанию.
  • «Удаленный» указывает, что значение было определено конфигурацией, созданной путем оценки шаблона.

Подпись: 

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

PercentConditionОператор

Определяет поддерживаемые операторы для процентных условий.

Подпись: 

export declare enum PercentConditionOperator

Члены перечисления

Член Ценить Описание
МЕЖДУ "BETWEEN" Целевые процентили в интервале, определяемом нижней и верхней границами. Нижняя граница является исключающей (открытой) границей, а micro_percent_range_upper_bound — инклюзивной (закрытой) границей. Условие, использующее этот оператор, должно указывать microPercentRange.
БОЛЬШЕ_ЧЕМ "GREATER_THAN" Целевые процентили превышают целевой процент. Условие, использующее этот оператор, должно указывать microPercent.
МЕНЬШЕ_ИЛИ_РАВНО "LESS_OR_EQUAL" Целевые процентили меньше или равны целевому проценту. Условие, использующее этот оператор, должно указывать microPercent.
НЕИЗВЕСТНЫЙ "UNKNOWN" Общий случай ошибки.