RemoteConfig class

Интерфейс службы Firebase RemoteConfig .

Подпись:

export declare class RemoteConfig

Характеристики

Свойство Модификаторы Тип Описание
приложение Приложение

Методы

Метод Модификаторы Описание
createTemplateFromJSON (json) Создает и возвращает новый шаблон Remote Config из строки JSON.
getServerTemplate (параметры) Создает экземпляр ServerTemplate , а затем извлекает и кэширует последнюю версию шаблона проекта.
получитьШаблон() Получает текущую активную версию RemoteConfigTemplate проекта.
getTemplateAtVersion(номерверсии) Получает запрошенную версию RemoteConfigTemplate проекта.
initServerTemplate (параметры) Синхронно создает экземпляр ServerTemplate. .
списокВерсии (опции) Получает список опубликованных версий шаблона Remote Config, отсортированный в обратном хронологическом порядке. Сохраняются только последние 300 версий. Все версии, соответствующие неактивным шаблонам Remote Config (т. е. все, кроме шаблона, извлекаемого клиентами), также удаляются, если они старше 90 дней.
PublishTemplate(шаблон, параметры) Публикует шаблон Remote Config.
откат (номер версии) Откатывает опубликованный шаблон Remote Config проекта до указанной версии. Откат эквивалентен получению ранее опубликованного шаблона Remote Config и его повторной публикации с использованием принудительного обновления.
validateTemplate (шаблон) Проверяет шаблон RemoteConfigTemplate. .

RemoteConfig.app

Подпись:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

Создает и возвращает новый шаблон Remote Config из строки JSON.

Подпись:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Параметры

Параметр Тип Описание
JSON нить Строка JSON для заполнения шаблона Remote Config.

Возврат:

Шаблон удаленной конфигурации

Новый экземпляр шаблона.

RemoteConfig.getServerTemplate()

Создает экземпляр ServerTemplate , а затем извлекает и кэширует последнюю версию шаблона проекта.

Подпись:

getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;

Параметры

Параметр Тип Описание
параметры GetServerTemplateOptions

Возврат:

Обещание < ServerTemplate >

RemoteConfig.getTemplate()

Получает текущую активную версию RemoteConfigTemplate проекта.

Подпись:

getTemplate(): Promise<RemoteConfigTemplate>;

Возврат:

Обещание < RemoteConfigTemplate >

Обещание, которое выполняется с помощью RemoteConfigTemplate .

RemoteConfig.getTemplateAtVersion()

Получает запрошенную версию RemoteConfigTemplate проекта.

Подпись:

getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;

Параметры

Параметр Тип Описание
номер версии номер | нить Номер версии шаблона Remote Config, который необходимо найти.

Возврат:

Обещание < RemoteConfigTemplate >

Обещание, которое выполняется с помощью RemoteConfigTemplate .

RemoteConfig.initServerTemplate()

Синхронно создает экземпляр ServerTemplate. .

Подпись:

initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;

Параметры

Параметр Тип Описание
параметры Инитсервертемплатеоптионс

Возврат:

Шаблон сервера

RemoteConfig.listVersions()

Получает список опубликованных версий шаблона Remote Config, отсортированный в обратном хронологическом порядке. Сохраняются только последние 300 версий. Все версии, соответствующие неактивным шаблонам Remote Config (т. е. все, кроме шаблона, извлекаемого клиентами), также удаляются, если они старше 90 дней.

Подпись:

listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;

Параметры

Параметр Тип Описание
параметры Параметры списка версий Необязательный объект параметров для получения списка версий.

Возврат:

Обещание < ListVersionsResult >

Обещание, которое выполняется с помощью ListVersionsResult .

RemoteConfig.publishTemplate()

Публикует шаблон Remote Config.

Подпись:

publishTemplate(template: RemoteConfigTemplate, options?: {
        force: boolean;
    }): Promise<RemoteConfigTemplate>;

Параметры

Параметр Тип Описание
шаблон Шаблон удаленной конфигурации Шаблон Remote Config, который нужно опубликовать.
параметры { сила: логическое значение; } Объект необязательных параметров при публикации шаблона Remote Config: - force : установка значения true приводит к обновлению шаблона Remote Config и обходу ETag. Этот подход не рекомендуется, поскольку он может привести к потере обновлений шаблона Remote Config, если несколько клиентов обновляют шаблон Remote Config. См. использование ETag и принудительные обновления. .

Возврат:

Обещание < RemoteConfigTemplate >

Обещание, которое выполняется с опубликованным шаблоном RemoteConfigTemplate .

RemoteConfig.rollback()

Откатывает опубликованный шаблон Remote Config проекта до указанной версии. Откат эквивалентен получению ранее опубликованного шаблона Remote Config и его повторной публикации с использованием принудительного обновления.

Подпись:

rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;

Параметры

Параметр Тип Описание
номер версии номер | нить Номер версии шаблона Remote Config, до которого требуется выполнить откат. Указанный номер версии должен быть ниже текущего номера версии и не быть удален из-за устаревания. Сохраняются только последние 300 версий. Все версии, соответствующие неактивным шаблонам Remote Config (то есть все, кроме шаблона, извлекаемого клиентами), также удаляются, если их возраст превышает 90 дней.

Возврат:

Обещание < RemoteConfigTemplate >

Обещание, которое выполняется с помощью опубликованного RemoteConfigTemplate .

RemoteConfig.validateTemplate()

Проверяет шаблон RemoteConfigTemplate. .

Подпись:

validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;

Параметры

Параметр Тип Описание
шаблон Шаблон удаленной конфигурации Шаблон Remote Config, который необходимо проверить.

Возврат:

Обещание < RemoteConfigTemplate >

Обещание, которое выполняется с помощью проверенного шаблона RemoteConfigTemplate .