RemoteConfig class

La interfaz de 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 string JSON.
getServerTemplate(opciones) Crea una instancia de ServerTemplate y, luego, recupera y almacena en caché la versión más reciente de la plantilla del proyecto.
getTemplate() Obtiene la versión activa actual del RemoteConfigTemplate del proyecto.
getTemplateAtVersion(versionNumber) Obtiene la versión solicitada del RemoteConfigTemplate del proyecto.
initServerTemplate(opciones) Crea una instancia de ServerTemplate de forma síncrona.
listVersions(opciones) Obtiene una lista de las versiones de plantillas de Remote Config que se publicaron, ordenadas en orden cronológico inverso. Solo se almacenan las últimas 300 versiones. También se borran todas las versiones que correspondan a plantillas no activas de Remote Config (es decir, todas excepto la que recuperan los clientes) si tienen más de 90 días.
publishTemplate(template, options) 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 mediante 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 string JSON.

Firma:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Parámetros

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

Devuelve:

RemoteConfigTemplate

Una instancia de plantilla nueva.

RemoteConfig.getServerTemplate()

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones GetServerTemplateOptions.

Devuelve:

Promesa<ServerTemplate>

RemoteConfig.getTemplate()

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

Firma:

getTemplate(): Promise<RemoteConfigTemplate>;

Devuelve:

Promesa<RemoteConfigTemplate>

Una promesa que se cumple con un RemoteConfigTemplate.

RemoteConfig.getTemplateAtVersion()

Obtiene la versión solicitada del RemoteConfigTemplate del proyecto.

Firma:

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

Parámetros

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

Devuelve:

Promesa<RemoteConfigTemplate>

Una promesa que se cumple con un RemoteConfigTemplate.

RemoteConfig.initServerTemplate()

Crea una instancia de ServerTemplate de forma síncrona.

Firma:

initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;

Parámetros

Parámetro Tipo Descripción
opciones InitServerTemplateOptions

Devuelve:

ServerTemplate

RemoteConfig.listVersions()

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones Opciones de listas de versiones Objeto de opciones opcional para obtener una lista de versiones.

Devuelve:

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: booleano; } Objeto de opciones opcionales cuando se publica una plantilla de Remote Config: - force: Si configuras este parámetro como true, la plantilla de Remote Config se actualizará y se evitará la ETag. Este enfoque no se recomienda, ya que se corre el riesgo de causar la pérdida de las actualizaciones en tu plantilla de Remote Config si varios clientes la están actualizando. Consulta Uso de ETag y actualizaciones forzadas.

Devuelve:

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 mediante una actualización forzada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
númerodeversión número | cadena El número de versión de la plantilla de Remote Config a la que se hará la reversión. El número de versión especificado debe ser inferior al número de versión actual y no se borró por inactividad. Solo se almacenan las últimas 300 versiones. Todas las versiones que correspondan a plantillas no activas de Remote Config (es decir, todas excepto la plantilla que recuperan los clientes) también se borran si tienen más de 90 días.

Devuelve:

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á.

Devuelve:

Promesa<RemoteConfigTemplate>

Es una promesa que se cumple con el RemoteConfigTemplate validado.