RemoteConfig class

La interfaz del servicio RemoteConfig de Firebase

Firma:

export declare class RemoteConfig

Propiedades

Propiedad Teclas modificadoras Tipo Descripción
app App

Métodos

Método Teclas modificadoras Descripción
createTemplateFromJSON(json) Crea y muestra una plantilla nueva de Remote Config a partir de una cadena JSON.
getServerTemplate(options) Crea una instancia de ServerTemplate y, luego, recupera y almacena en caché la versión de plantilla más reciente del proyecto.
getTemplate(). Obtiene la versión activa actual de la RemoteConfigTemplate del proyecto.
getTemplateAtVersion(versionNumber) Obtiene la versión solicitada de la RemoteConfigTemplate del proyecto.
initServerTemplate(options) Crea una instancia de ServerTemplate de manera síncrona.
listVersions(options) Obtiene una lista de las versiones de plantilla de Remote Config que se publicaron, ordenadas en orden cronológico inverso. Solo se almacenan las últimas 300 versiones. Si tienen más de 90 días, también se borrarán todas las versiones que correspondan a plantillas no activas de Remote Config (es decir, todas excepto la plantilla que los clientes recuperen).
publishTemplate(plantilla, opciones) Publica una plantilla de Remote Config.
rollback(versionNumber) Revierte la plantilla de Remote Config publicada de un proyecto a la versión especificada. Una reversión equivale a obtener una plantilla de Remote Config publicada anteriormente y volver a publicarla con una actualización forzada.
validateTemplate(template) Valida un elemento RemoteConfigTemplate.

RemoteConfig.app

Firma:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

Crea y muestra una plantilla nueva de Remote Config a partir de una cadena JSON.

Firma:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Parámetros

Parámetro Tipo Descripción
json string La cadena JSON para propagar una plantilla de Remote Config.

Muestra:

RemoteConfigTemplate

Una instancia de plantilla nueva.

RemoteConfig.getServerTemplate()

Crea una instancia de ServerTemplate y, luego, recupera y almacena en caché la versión de plantilla más reciente del proyecto.

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones GetServerTemplateOptions

Muestra:

Promesa<ServerTemplate>

RemoteConfig.getTemplate()

Obtiene la versión activa actual de la RemoteConfigTemplate del proyecto.

Firma:

getTemplate(): Promise<RemoteConfigTemplate>;

Muestra:

Promesa<RemoteConfigTemplate>

Una promesa que se cumple con un RemoteConfigTemplate.

RemoteConfig.getTemplateAtVersion()

Obtiene la versión solicitada de la RemoteConfigTemplate del proyecto.

Firma:

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

Parámetros

Parámetro Tipo Descripción
versionNumber número | cadena Número de versión de la plantilla de Remote Config que se debe buscar.

Muestra:

Promesa<RemoteConfigTemplate>

Una promesa que se cumple con un RemoteConfigTemplate.

RemoteConfig.initServerTemplate()

Crea una instancia de ServerTemplate de manera síncrona.

Firma:

initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;

Parámetros

Parámetro Tipo Descripción
opciones InitServerTemplateOptions

Muestra:

ServerTemplate

RemoteConfig.listVersions()

Obtiene una lista de las versiones de plantilla de Remote Config que se publicaron, ordenadas en orden cronológico inverso. Solo se almacenan las últimas 300 versiones. Si tienen más de 90 días, también se borrarán todas las versiones que correspondan a plantillas no activas de Remote Config (es decir, todas excepto la plantilla que los clientes recuperen).

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones ListVersionsOptions Objeto de opciones opcionales para obtener una lista de versiones.

Muestra:

Promesa<ListVersionsResult>

Una promesa que se cumple con un ListVersionsResult.

RemoteConfig.publishTemplate()

Publica una plantilla de Remote Config.

Firma:

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

Parámetros

Parámetro Tipo Descripción
plantilla RemoteConfigTemplate La plantilla de Remote Config que se publicará.
opciones { force: boolean;; }. Objeto de opciones opcionales cuando se publica una plantilla de Remote Config: - force: Establecer este valor en true fuerza la actualización de la plantilla de Remote Config y eludi la ETag. No se recomienda este enfoque, ya que podría causar la pérdida de actualizaciones en tu plantilla de Remote Config si varios clientes la están actualizando. Consulta Uso de ETag y actualizaciones forzadas.

Muestra:

Promesa<RemoteConfigTemplate>

Una promesa que se cumple con el RemoteConfigTemplate publicado.

RemoteConfig.rollback()

Revierte la plantilla de Remote Config publicada de un proyecto a la versión especificada. Una reversión equivale a obtener una plantilla de Remote Config publicada anteriormente y volver a publicarla con una actualización forzada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
versionNumber número | cadena El número de versión de la plantilla de Remote Config a la que se revierte. El número de versión especificado debe ser inferior al número de la versión actual y no se debe haber borrado debido a la obsolescencia. Solo se almacenan las últimas 300 versiones. Si tienen más de 90 días de antigüedad, también se borran todas las versiones que corresponden a plantillas inactivas de Remote Config (es decir, todas excepto la plantilla que recuperan los clientes).

Muestra:

Promesa<RemoteConfigTemplate>

Una promesa que se cumple con el RemoteConfigTemplate publicado.

RemoteConfig.validateTemplate()

Valida un elemento RemoteConfigTemplate.

Firma:

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

Parámetros

Parámetro Tipo Descripción
plantilla RemoteConfigTemplate La plantilla de Remote Config que se validará.

Muestra:

Promesa<RemoteConfigTemplate>

Una promesa que se cumple con el RemoteConfigTemplate validado.