remote-config package

O SDK da Web da Configuração remota do Firebase. Este SDK não funciona em um ambiente Node.js.

Funções

Interfaces

Aliases de tipo

função (aplicativo, ...)

getRemoteConfig(aplicativo)

Assinatura:

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

Parâmetros

Retorna:

Configuração remota

Uma instância RemoteConfig .

função(remoteConfig, ...)

ativar (configuração remota)

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<booleano>

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

garantirInitialized(remoteConfig)

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

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

fetchAndActivate(remoteConfig)

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<booleano>

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

fetchConfig(remoteConfig)

Busca e armazena em cache a configuração do serviço Configuração remota.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

getAll(configremoto)

Obtém todas as configurações.

Assinatura:

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

Parâmetros

Retorna:

Registro<string, Valor >

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() .

Assinatura:

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

Parâmetros

Retorna:

boleano

O valor da chave fornecida como booleano.

getNumber(remoteConfig, chave)

Obtém o valor da 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

Retorna:

número

O valor da chave fornecida como um número.

getString(remoteConfig, chave)

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

Retorna:

corda

O valor da chave fornecida como uma string.

getValue(remoteConfig, chave)

Obtém o valor da chave fornecida.

Assinatura:

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

Parâmetros

Retorna:

Valor

O valor da chave fornecida.

setLogLevel(remoteConfig, logLevel)

Define o nível de log a ser usado.

Assinatura:

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

Parâmetros

Retorna:

vazio

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 open() do IndexedDB.

Assinatura:

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

Retorna:

Promessa<booleano>

Uma Promise que é resolvida como verdadeira se uma instância RemoteConfig puder ser inicializada neste ambiente ou como falsa se não puder.

BuscarStatus

Resume o resultado da última tentativa de buscar a configuração do servidor do 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 teve taxa limitada.

Assinatura:

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

Nível de registro

Define os níveis de registro do Configuração remota.

Assinatura:

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

Fonte de valor

Indica a origem de um valor.

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

Assinatura:

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