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 tipos

função(app, ...)

getRemoteConfig(app)

Assinatura:

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

Parâmetros

Retorna:

RemoteConfig (em inglês)

Uma instância RemoteConfig.

function(remoteConfig, ...)

enable(remoteConfig)

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

Assinatura:

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

Parâmetros

Retorna:

Promise<boolean>

Uma Promise que é resolvida como verdadeira se a chamada atual ativou as configurações buscadas. Se as configurações buscadas já estiverem ativadas, o Promise será resolvido como falso.

AssuredInitialized(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>

Um Promise que é resolvido quando a última configuração ativada fica disponível para os getters.

buscaAndActivate(remoteConfig)

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

Assinatura:

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

Parâmetros

Retorna:

Promise&lt;boolean&gt;

Uma Promise que é resolvida como verdadeira se a chamada atual ativou as configurações buscadas. Se as configurações buscadas já estiverem ativadas, o Promise será resolvido como falso.

buscaConfig(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(remoteConfig)

Recebe todas as configurações.

Assinatura:

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

Parâmetros

Retorna:

Record<string, Valor>

Todas as configurações

getBoolean(remoteConfig, key)

Recebe o valor da chave especificada 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:

booleano

O valor da chave especificada como booleano.

getNumber(remoteConfig, key)

Recebe o valor da chave especificada 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:

number

O valor da chave fornecida como um número.

getString(remoteConfig, key)

Extrai o valor da chave especificada 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:

string

O valor da chave fornecida como uma string.

getValue(remoteConfig, key)

Recebe o Value da chave especificada.

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 registro a ser usado.

Assinatura:

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

Parâmetros

Retorna:

void

função()

issupported();

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

1. Verifique se o 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:

Promise&lt;boolean&gt;

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

FetchStatus

Resume o resultado da última tentativa de buscar configuração do servidor da Configuração remota do Firebase.

• "sem busca ainda" 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.
• "fracasso" indica que a última tentativa falhou.
• "limitar" indica que a última tentativa teve limitação de taxa.

Assinatura:

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

LogLevel

Define níveis de geração de registros do recurso Configuração remota.

Assinatura:

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

Origem do valor

Indica a origem de um valor.

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

Assinatura:

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