A interface do serviço RemoteConfig
do Firebase.
Assinatura:
export declare class RemoteConfig
Propriedades
Propriedade | Modificadores | Tipo | Descrição |
---|---|---|---|
app | App |
Métodos
Método | Modificadores | Descrição |
---|---|---|
createTemplateFromJSON (json) (link em inglês) | Cria e retorna um novo modelo da Configuração remota de uma string JSON. | |
getServerTemplate(options) (em inglês) | Instancia o ServerTemplate e, em seguida, busca e armazena em cache a versão de modelo mais recente do projeto. | |
getTemplate() (em inglês) | Recebe a versão ativa atual do RemoteConfigTemplate do projeto. | |
getTemplateAtVersion(versionNumber) (em inglês) | Recebe a versão solicitada do RemoteConfigTemplate do projeto. | |
initServerTemplate(options) (link em inglês) | instancia de maneira síncrona o ServerTemplate. | |
listVersions(options) (em inglês) | Recebe uma lista de versões de modelos da Configuração remota que foram publicadas, classificadas em ordem cronológica inversa. Somente as últimas 300 versões são armazenadas. Todas as versões que correspondem aos modelos não ativos da Configuração remota (ou seja, todos, exceto o modelo que está sendo buscado pelos clientes) também serão excluídas se tiverem mais de 90 dias. | |
publishTemplate(template, options) | Publica um modelo da Configuração remota. | |
rollback(versionNumber) | Reverte o modelo publicado da Configuração remota de um projeto para a versão especificada. Uma reversão é equivalente a receber um modelo da Configuração remota publicado anteriormente e republicá-lo usando uma atualização forçada. | |
validarTemplate(template) | Valida um RemoteConfigTemplate. |
RemoteConfig.app
Assinatura:
readonly app: App;
RemoteConfig.createTemplateFromJSON()
Cria e retorna um novo modelo da Configuração remota de uma string JSON.
Assinatura:
createTemplateFromJSON(json: string): RemoteConfigTemplate;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
json | string | A string JSON para preencher um modelo da Configuração remota. |
Retorna:
RemoteConfigTemplate (em inglês)
Uma nova instância de modelo.
RemoteConfig.getServerTemplate()
Instancia o ServerTemplate e, em seguida, busca e armazena em cache a versão de modelo mais recente do projeto.
Assinatura:
getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
do modelo. | GetServerTemplateOptions (em inglês) |
Retorna:
Promessa<ServerTemplate>
RemoteConfig.getTemplate()
Recebe a versão ativa atual do RemoteConfigTemplate do projeto.
Assinatura:
getTemplate(): Promise<RemoteConfigTemplate>;
Retorna:
Promessa<RemoteConfigTemplate>
Uma promessa que será atendida com um RemoteConfigTemplate
.
RemoteConfig.getTemplateAtVersion()
Recebe a versão solicitada do RemoteConfigTemplate do projeto.
Assinatura:
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
Número da versão | número | string | Número da versão do modelo da Configuração remota a ser pesquisado. |
Retorna:
Promessa<RemoteConfigTemplate>
Uma promessa que será atendida com um RemoteConfigTemplate
.
RemoteConfig.initServerTemplate()
instancia de maneira síncrona o ServerTemplate.
Assinatura:
initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
do modelo. | InitServerTemplateOptions (em inglês) |
Retorna:
ServerTemplate (em inglês)
RemoteConfig.listVersions()
Recebe uma lista de versões de modelos da Configuração remota que foram publicadas, classificadas em ordem cronológica inversa. Somente as últimas 300 versões são armazenadas. Todas as versões que correspondem aos modelos não ativos da Configuração remota (ou seja, todos, exceto o modelo que está sendo buscado pelos clientes) também serão excluídas se tiverem mais de 90 dias.
Assinatura:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
do modelo. | ListVersionsOptions (link em inglês) | Objeto de opções opcionais para receber uma lista de versões. |
Retorna:
Prometer<ListVersionsResult>
Uma promessa que será atendida com um ListVersionsResult
.
RemoteConfig.publishTemplate()
Publica um modelo da Configuração remota.
Assinatura:
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
modelo | RemoteConfigTemplate (em inglês) | O modelo da Configuração remota a ser publicado. |
do modelo. | { force: booleano; } | Objeto de opções opcionais ao publicar um modelo da Configuração remota: - force : definir como true força a atualização do modelo da Configuração remota e burlar a ETag. Essa abordagem não é recomendada porque há o risco de perda de atualizações do modelo da Configuração remota caso vários clientes estejam atualizando o modelo. Consulte Uso de ETag e atualizações forçadas. |
Retorna:
Promessa<RemoteConfigTemplate>
Uma promessa que é atendida com o RemoteConfigTemplate
publicado.
RemoteConfig.rollback()
Reverte o modelo publicado da Configuração remota de um projeto para a versão especificada. Uma reversão é equivalente a receber um modelo da Configuração remota publicado anteriormente e republicá-lo usando uma atualização forçada.
Assinatura:
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
Número da versão | número | string | O número da versão do modelo da Configuração remota para reverter. O número da versão especificado precisa ser inferior ao número da versão atual e não ter sido excluído devido à inatividade. Somente as últimas 300 versões são armazenadas. Todas as versões que correspondem aos modelos não ativos da Configuração remota (ou seja, todas, exceto o modelo que está sendo buscado pelos clientes) também serão excluídas se tiverem mais de 90 dias. |
Retorna:
Promessa<RemoteConfigTemplate>
Uma promessa que será atendida com o RemoteConfigTemplate
publicado.
RemoteConfig.validateTemplate()
Valida um RemoteConfigTemplate.
Assinatura:
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
modelo | RemoteConfigTemplate (em inglês) | O modelo da Configuração remota que será validado. |
Retorna:
Promessa<RemoteConfigTemplate>
Uma promessa que é atendida com o RemoteConfigTemplate
validado.