firebase-admin.remote-config package

Configuração remota do Firebase.

Funções

Função	Descrição
getRemoteConfig(app) (link em inglês)	Recebe o serviço RemoteConfig para o app padrão ou um determinado app.getRemoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do app padrão ou como getRemoteConfig(app) para acessar o serviço RemoteConfig associado a um app específico.

Classes

Turma	Descrição
RemoteConfig (em inglês)	A interface de serviço RemoteConfig do Firebase.

Enumerações

Enumeração	Descrição
PercentConditionOperator (link em inglês)	Define os operadores compatíveis para condições percentuais.

Interfaces

Interface	Descrição
AndCondition (link em inglês)	Representa uma coleção de condições que são avaliadas como verdadeiras se todas forem verdadeiras.
explicitParameterValue (em inglês)	Interface que representa um valor de parâmetro explícito.
GetServerTemplateOptions (em inglês)	Representa argumentos opcionais que podem ser usados ao instanciar ServerTemplate.
InAppDefaultValue (em inglês)	Interface que representa um valor padrão no app.
InitServerTemplateOptions (em inglês)	Representa argumentos opcionais que podem ser usados ao instanciar ServerTemplate de forma síncrona.
ListVersionsOptions (em inglês)	Interface que representa opções para a operação de lista de versões da Configuração remota.
ListVersionsResult (link em inglês)	Interface que representa uma lista de versões de modelo da Configuração remota.
MicroPercentRange (link em inglês)	Representa o limite de percentis para segmentar, em microporcentagens. O valor precisa estar no intervalo [0 e 100000000]
NamedCondition (link em inglês)	Representa uma condição do Configuração remota no plano de dados. Uma condição segmenta um grupo específico de usuários. Uma lista dessas condições faz parte de um modelo da Configuração remota.
OneOfCondition (em inglês)	Representa uma condição que pode ser de vários tipos. Somente o primeiro campo definido será processado.
OrCondition	Representa uma coleção de condições avaliadas como verdadeiras, se alguma delas for verdadeira.
PercentCondition (link em inglês)	Representa uma condição que compara o percentil pseudoaleatório da instância com um determinado limite.
RemoteConfigCondition (link em inglês)	Interface que representa uma condição da Configuração remota. Uma condição segmenta um grupo específico de usuários. Uma lista dessas condições faz parte de um modelo da Configuração remota.
RemoteConfigParameter	Interface que representa um parâmetro da Configuração remota. No mínimo, uma entrada defaultValue ou conditionalValues precisa estar presente para que o parâmetro tenha efeito.
RemoteConfigParameterGroup (em inglês)	Interface que representa um grupo de parâmetros da Configuração remota. O agrupamento de parâmetros serve apenas para fins de gerenciamento e não afeta a busca de valores de parâmetro no lado do cliente.
RemoteConfigTemplate	Representa um modelo de cliente da Configuração remota.
RemoteConfigUser (em inglês)	Interface que representa um usuário da Configuração remota.
ServerConfig (em inglês)	Representa a configuração produzida pela avaliação de um modelo de servidor.
ServerTemplate (em inglês)	Representa uma abstração com estado para um modelo de servidor da Configuração remota.
ServerTemplateData (em inglês)	Representa os dados em um modelo de servidor da Configuração remota.
Valor	Agrupa um valor de parâmetro com metadados e getters com segurança de tipo.Getters com segurança de tipo isolam a lógica do aplicativo das mudanças remotas em nomes e tipos de parâmetros.
Versão	Interface que representa uma versão de modelo da Configuração remota. Somente saída, exceto a descrição da versão. Contém metadados sobre uma versão específica do modelo da Configuração remota. Todos os campos são definidos no momento em que o modelo especificado da Configuração remota é publicado. O campo de descrição de uma versão pode ser especificado em chamadas publishTemplate.

Aliases de tipos

Alias de tipo	Descrição
DefaultConfig (link em inglês)	Define o formato dos valores de parâmetros padrão no app.
AvaliaçãoContext	Representa os sinais de entrada da avaliação do modelo.
ParameterValueType (em inglês)	Tipo que representa um tipo de dados de valor de parâmetro da Configuração remota. Quando não especificado, o padrão é STRING.
RemoteConfigParameterValue (em inglês)	Tipo que representa um valor de parâmetro da Configuração remota. Um RemoteConfigParameterValue pode ser um ExplicitParameterValue ou um InAppDefaultValue.
ServerTemplateDataType (em inglês)	Representa o tipo de um modelo de servidor da Configuração remota que pode ser definido em ServerTemplate. Pode ser um objeto ServerTemplateData ou uma string JSON de modelo.
TagColor (link em inglês)	Cores associadas a condições para fins de exibição.
ValueSource (link em inglês)	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 produzida pela avaliação de um modelo.

getRemoteConfig(app)

Recebe o serviço RemoteConfig do app padrão ou de um determinado app.

O getRemoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do app padrão ou como getRemoteConfig(app) para acessar o serviço RemoteConfig associado a um app específico.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
app	App	App opcional para retornar o serviço RemoteConfig. Se não for informado, o serviço RemoteConfig padrão será retornado.

Retorna:

RemoteConfig (em inglês)

O serviço RemoteConfig padrão, se nenhum app for fornecido, ou o serviço RemoteConfig associado ao app fornecido.

Exemplo 1

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

Exemplo 2

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

DefaultConfig

Define o formato dos valores de parâmetros padrão no app.

Assinatura:

export type DefaultConfig = {
    [key: string]: string | number | boolean;
};

Contexto de avaliação

Representa os sinais de entrada da avaliação do modelo.

Assinatura:

export type EvaluationContext = {
    randomizationId?: string;
};

ParameterValueType

Tipo que representa um tipo de dados de valor de parâmetro da Configuração remota. Quando não especificado, o padrão é STRING.

Assinatura:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

RemoteConfigParameterValue

Tipo que representa um valor de parâmetro da Configuração remota. Um RemoteConfigParameterValue pode ser um ExplicitParameterValue ou um InAppDefaultValue.

Assinatura:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

ServerTemplateDataType

Representa o tipo de um modelo de servidor da Configuração remota que pode ser definido em ServerTemplate. Pode ser um objeto ServerTemplateData ou uma string JSON de modelo.

Assinatura:

export type ServerTemplateDataType = ServerTemplateData | string;

TagColor

Cores associadas a condições para fins de exibição.

Assinatura:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';

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 produzida pela avaliação de um modelo.

Assinatura:

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

Operador "PercentCondition"

Define os operadores compatíveis para condições percentuais.

Assinatura:

export declare enum PercentConditionOperator 

Membros de enumeração

Participante	Valor	Descrição
BETWEEN	"BETWEEN"	Percentis desejados dentro de um intervalo definido por um limite inferior e um limite superior. O limite inferior é um limite exclusivo (aberto), e o micro_percent_range_upper_bound é um limite inclusivo (fechado). Uma condição que usa esse operador deve especificar microPercentRange.
GREATER_THAN	"GREATER_THAN"	Percentis desejados maiores que o percentual desejado. Uma condição que usa esse operador deve especificar microPercent.
MENOS_OU_EQUAL	"LESS_OR_EQUAL"	Percentis desejados menores ou iguais à porcentagem desejada. Uma condição que usa esse operador deve especificar microPercent.
DESCONHECIDO	"UNKNOWN"	Um caso de erro "pega-tudo".