firebase-admin.remote-config package

Configuração remota do Firebase.

Funções

Função Descrição
getRemoteConfig(aplicativo) Obtém o serviço RemoteConfig para o aplicativo padrão ou um determinado aplicativo. getRemoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do aplicativo padrão ou como getRemoteConfig(app) para acessar o serviço RemoteConfig associado a um aplicativo específico.

Aulas

Aula Descrição
Configuração remota A interface do serviço Firebase RemoteConfig .

Interfaces

Interface Descrição
ExplicitParameterValue Interface que representa um valor de parâmetro explícito.
InAppDefaultValue Interface que representa um valor padrão no aplicativo.
ListaVersõesOpções Interface que representa opções para operação de versões da lista do Configuração remota.
ListVersionsResult Interface que representa uma lista de versões de modelos do Configuração remota.
Condição deConfiguraçãoRemota Interface que representa uma condição do Configuração remota. Uma condição tem como alvo um grupo específico de usuários. Uma lista dessas condições faz parte de um modelo do Configuração remota.
Parâmetro RemoteConfig Interface que representa um parâmetro do Configuração remota. No mínimo, uma entrada defaultValue ou conditionalValues ​​deve estar presente para que o parâmetro tenha qualquer efeito.
RemoteConfigParameterGroup Interface que representa um grupo de parâmetros do Configuração remota. O agrupamento de parâmetros é apenas para fins de gerenciamento e não afeta a busca de valores de parâmetros no lado do cliente.
Modelo de configuração remota Interface que representa um modelo do Configuração remota.
UsuárioConfiguraçãoRemota Interface que representa um usuário do Configuração remota.
Versão Interface que representa uma versão do modelo do Configuração remota. Somente saída, exceto a descrição da versão. Contém metadados sobre uma versão específica do modelo do Configuração remota. Todos os campos são definidos no momento em que o modelo do Configuração remota especificado é publicado. O campo de descrição de uma versão pode ser especificado em chamadas publishTemplate .

Aliases de tipo

Digite Alias Descrição
ParâmetroValueType Tipo que representa um tipo de dados de valor de parâmetro do Configuração remota. O padrão é STRING se não for especificado.
RemoteConfigParameterValue Tipo que representa um valor de parâmetro do Configuração remota. Um RemoteConfigParameterValue pode ser ExplicitParameterValue ou InAppDefaultValue .
TagColor Cores associadas a condições para fins de exibição.

getRemoteConfig()

Obtém o serviço RemoteConfig para o aplicativo padrão ou um determinado aplicativo.

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

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional para o qual retornar o serviço RemoteConfig . Se não for fornecido, o serviço RemoteConfig padrão será retornado.

Retorna:

Configuração remota

O serviço RemoteConfig padrão se nenhum aplicativo for fornecido ou o serviço RemoteConfig associado ao aplicativo 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);

ParâmetroValueType

Tipo que representa um tipo de dados de valor de parâmetro do Configuração remota. O padrão é STRING se não for especificado.

Assinatura:

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

RemoteConfigParameterValue

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

Assinatura:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

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';