remote-config package

O Firebase Remote Config Web SDK. Este SDK não funciona em um ambiente Node.js.

Funções

Função Descrição
função(aplicativo...)
getRemoteConfig(aplicativo)
function(remoteConfig...)
ativar (configuração remota) Disponibiliza a última configuração buscada para os getters.
assegurarInicializado(remoteConfig) Garante que a última configuração ativada esteja disponível para os getters.
fetchAndActivate(remoteConfig) Executa operações de busca e ativação, como uma conveniência.
fetchConfig(remoteConfig) Busca e armazena em cache a configuração do serviço Remote Config.
getAll(remoteConfig) Obtém todas as configurações.
getBoolean(remoteConfig, chave) Obtém o valor da chave fornecida como um booleano. Método de conveniência para chamar remoteConfig.getValue(key).asBoolean() .
getNumber(remoteConfig, chave) Obtém o valor para a chave fornecida como um número. Método de conveniência para chamar remoteConfig.getValue(key).asNumber() .
getString(remoteConfig, chave) Obtém o valor da chave fornecida como uma string. Método de conveniência para chamar remoteConfig.getValue(key).asString() .
getValue(remoteConfig, chave) Obtém o valor para a chave fornecida.
setLogLevel(remoteConfig, logLevel) Define o nível de log a ser usado.
função()
é suportado() Este método fornece duas verificações diferentes: 1. Verifique se IndexedDB existe no ambiente do navegador. 2. Verifique se o contexto atual do navegador permite chamadas indexedDB open() .

Interfaces

Interface Descrição
RemoteConfig A interface do serviço Firebase Remote Config.
RemoteConfigSettings Define opções de configuração para o Remote Config SDK.
Valor Envolve um valor com metadados e getters de tipo seguro.

Aliases de tipo

Digite Alias Descrição
FetchStatus Resume o resultado da última tentativa de buscar a configuração do servidor Firebase Remote Config.
  • "no-fetch-yet" indica que a instância RemoteConfig ainda não tentou buscar a configuração ou que a inicialização do SDK está incompleta.
  • "sucesso" indica que a última tentativa foi bem-sucedida.
  • "falha" indica que a última tentativa falhou.
  • "throttle" indica que a última tentativa foi limitada por taxa.
LogLevel Define os níveis de log do Remote Config.
ValueSource Indica a origem de um valor.
  • "static" indica que o valor foi definido por uma constante estática.
  • "padrão" indica que o valor foi definido pela configuração padrão.
  • "remote" indica que o valor foi definido pela configuração buscada.

getRemoteConfig()

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo FirebaseApp A instância FirebaseApp .

Retorna:

RemoteConfig

Uma instância RemoteConfig .

ativar()

Disponibiliza a última configuração buscada para os getters.

Assinatura:

export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .

Retorna:

Promessa<booleana>

Uma Promise que resolve como verdadeira se a chamada atual ativou as configurações buscadas. Se as configurações buscadas já foram ativadas, a Promise será resolvida como falsa.

assegurarInicializado()

Garante que a última configuração ativada esteja disponível para os getters.

Assinatura:

export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .

Retorna:

Promessa<void>

Uma Promise que resolve quando a última configuração ativada está disponível para os getters.

buscarEAtivar()

Executa operações de busca e ativação, como uma conveniência.

Assinatura:

export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .

Retorna:

Promessa<booleana>

Uma Promise que resolve como verdadeira se a chamada atual ativou as configurações buscadas. Se as configurações buscadas já foram ativadas, a Promise será resolvida como falsa.

fetchConfig()

Busca e armazena em cache a configuração do serviço Remote Config.

Assinatura:

export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .

Retorna:

Promessa<void>

getAll()

Obtém todas as configurações.

Assinatura:

export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .

Retorna:

Registro<string, Valor >

Todas as configurações.

getBoolean()

Obtém o valor da chave fornecida como um booleano.

Método de conveniência para chamar remoteConfig.getValue(key).asBoolean() .

Assinatura:

export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .
chave corda O nome do parâmetro.

Retorna:

boleano

O valor para a chave fornecida como um booleano.

obterNumero()

Obtém o valor para a chave fornecida como um número.

Método de conveniência para chamar remoteConfig.getValue(key).asNumber() .

Assinatura:

export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .
chave corda O nome do parâmetro.

Retorna:

número

O valor para a chave fornecida como um número.

getString()

Obtém o valor da chave fornecida como uma string. Método de conveniência para chamar remoteConfig.getValue(key).asString() .

Assinatura:

export declare function getString(remoteConfig: RemoteConfig, key: string): string;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .
chave corda O nome do parâmetro.

Retorna:

corda

O valor para a chave fornecida como uma string.

Obter valor()

Obtém o valor para a chave fornecida.

Assinatura:

export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .
chave corda O nome do parâmetro.

Retorna:

Valor

O valor para a chave fornecida.

setLogLevel()

Define o nível de log a ser usado.

Assinatura:

export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

Parâmetros

Parâmetro Tipo Descrição
remoteConfig RemoteConfig A instância RemoteConfig .
LogLevel RemoteConfigLogLevel O nível de log a ser definido.

Retorna:

vazio

é suportado()

Este método fornece duas verificações diferentes:

  1. Verifique se IndexedDB existe no ambiente do navegador. 2. Verifique se o contexto atual do navegador permite chamadas indexedDB open() .

Assinatura:

export declare function isSupported(): Promise<boolean>;

Retorna:

Promessa<booleana>

Um Promise que resolve como true se uma instância RemoteConfig puder ser inicializada neste ambiente ou false se não puder.

FetchStatus

Resume o resultado da última tentativa de buscar a configuração do servidor Firebase Remote Config.

  • "no-fetch-yet" indica que a instância [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) ainda não tentou buscar a configuração ou que a inicialização do SDK está incompleta.
  • "sucesso" indica que a última tentativa foi bem-sucedida.
  • "falha" indica que a última tentativa falhou.
  • "throttle" indica que a última tentativa foi limitada por taxa.

Assinatura:

export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

LogLevel

Define os níveis de log do Remote Config.

Assinatura:

export declare type LogLevel = 'debug' | 'error' | 'silent';

ValueSource

Indica a origem de um valor.

  • "static" indica que o valor foi definido por uma constante estática.
  • "padrão" indica que o valor foi definido pela configuração padrão.
  • "remote" indica que o valor foi definido pela configuração buscada.

Assinatura:

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