RemoteConfig class

A interface do serviço Firebase RemoteConfig .

Assinatura:

export declare class RemoteConfig

Propriedades

Propriedade Modificadores Tipo Descrição
aplicativo Aplicativo

Métodos

Método Modificadores Descrição
criarTemplateFromJSON(json) Cria e retorna um novo modelo do Configuração remota a partir de uma string JSON.
getTemplate() Obtém a versão ativa atual do RemoteConfigTemplate do projeto.
getTemplateAtVersion(versãoNumber) Obtém a versão solicitada do RemoteConfigTemplate do projeto.
listaVersões(opções) Obtém uma lista de versões de modelos do Configuração remota que foram publicadas, classificadas em ordem cronológica inversa. Apenas as últimas 300 versões são armazenadas. Todas as versões que correspondem a modelos inativos do Configuração remota (ou seja, todas, exceto o modelo que está sendo buscado pelos clientes) também serão excluídas se tiverem mais de 90 dias.
publicarTemplate(modelo, opções) Publica um modelo do Configuração remota.
reversão (número da versão) Reverte o modelo do Configuração remota publicado de um projeto para a versão especificada. Uma reversão equivale a obter um modelo do Configuração remota publicado anteriormente e publicá-lo novamente usando uma atualização forçada.
validarTemplate(modelo) Valida um RemoteConfigTemplate .

RemoteConfig.app

Assinatura:

readonly app: App;

RemoteConfig.createTemplateFromJSON()

Cria e retorna um novo modelo do Configuração remota a partir de uma string JSON.

Assinatura:

createTemplateFromJSON(json: string): RemoteConfigTemplate;

Parâmetros

Parâmetro Tipo Descrição
JSON corda A string JSON para preencher um modelo do Configuração remota.

Retorna:

Modelo de configuração remota

Uma nova instância de modelo.

RemoteConfig.getTemplate()

Obtém a versão ativa atual do RemoteConfigTemplate do projeto.

Assinatura:

getTemplate(): Promise<RemoteConfigTemplate>;

Retorna:

Promessa< RemoteConfigTemplate >

Uma promessa que cumpre com um RemoteConfigTemplate .

RemoteConfig.getTemplateAtVersion()

Obtém a versão solicitada do RemoteConfigTemplate do projeto.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
número da versão número | corda Número da versão do modelo do Configuração remota a ser pesquisado.

Retorna:

Promessa< RemoteConfigTemplate >

Uma promessa que cumpre com um RemoteConfigTemplate .

RemoteConfig.listVersions()

Obtém uma lista de versões de modelos do Configuração remota que foram publicadas, classificadas em ordem cronológica inversa. Apenas as últimas 300 versões são armazenadas. Todas as versões que correspondem a modelos inativos do Configuração remota (ou seja, todas, exceto o modelo que está sendo buscado pelos clientes) também serão excluídas se tiverem mais de 90 dias.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
opções ListaVersõesOpções Objeto de opções opcionais para obter uma lista de versões.

Retorna:

Promessa< ListVersionsResult >

Uma promessa que cumpre com um ListVersionsResult .

RemoteConfig.publishTemplate()

Publica um modelo do Configuração remota.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
modelo Modelo de configuração remota O modelo do Configuração remota a ser publicado.
opções {força: booleano; } Objeto de opções opcionais ao publicar um modelo do Configuração remota: - force : definir como true força a atualização do modelo do Configuração remota e contorna a ETag. Essa abordagem não é recomendada porque corre o risco de causar a perda de atualizações do modelo da Configuração remota se vários clientes estiverem atualizando o modelo da Configuração remota. Consulte o uso de ETag e atualizações forçadas .

Retorna:

Promessa< RemoteConfigTemplate >

Uma promessa que cumpre o RemoteConfigTemplate publicado .

RemoteConfig.rollback()

Reverte o modelo do Configuração remota publicado de um projeto para a versão especificada. Uma reversão equivale a obter um modelo do Configuração remota publicado anteriormente e publicá-lo novamente usando uma atualização forçada.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
número da versão número | corda O número da versão do modelo do Configuração remota para a qual reverter. O número de versão especificado deve ser inferior ao número da versão atual e não ter sido excluído devido a obsolescência. Apenas as últimas 300 versões são armazenadas. Todas as versões que correspondem a modelos inativos do Configuração remota (ou seja, todas, exceto o modelo que está sendo buscado pelos clientes) também serão excluídas se tiverem mais de 90 dias.

Retorna:

Promessa< RemoteConfigTemplate >

Uma promessa que cumpre o RemoteConfigTemplate publicado .

RemoteConfig.validateTemplate()

Valida um RemoteConfigTemplate .

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
modelo Modelo de configuração remota O modelo do Configuração remota a ser validado.

Retorna:

Promessa< RemoteConfigTemplate >

Uma promessa que cumpre com o RemoteConfigTemplate validado .