installations package

O SDK da Web de instalações do Firebase. Este SDK não funciona em um ambiente Node.js.

Funções

Função	Descrição
function(app, ...) (link em inglês)
getInstalls(app) (em inglês)	Retorna uma instância de Instalações associadas à instância do FirebaseApp especificada.
função(instalações, ...)
deleteInstalls(instalações)	Exclui a instalação do Firebase e todos os dados associados.
getId(Instalações)	Cria uma instalação do Firebase se não houver uma para o app e retorna o ID de instalação.
getToken(installations, forceRefresh)	Retorna um token de autenticação das instalações do Firebase, identificando a instalação atual do Firebase.
onIdChange(instalações, callback)	Define um novo retorno de chamada que será chamado quando o ID de instalação mudar. Retorna uma função de cancelamento de inscrição que removerá o callback quando for chamado.

Interfaces

Interface	Descrição
Instalações	Interface pública do SDK de instalações do Firebase.

Aliases de tipos

Alias de tipo	Descrição
IdChangeCallbackFn (link em inglês)	Uma função de callback definida pelo usuário que é chamada quando o ID de instalações muda.
IdChangeUnsubscribeFn (em inglês)	Cancelar a inscrição de uma função de callback adicionada anteriormente por IdChangeCallbackFn.

função(app, ...)

getInstalls(app)

Retorna uma instância de Instalações associadas à instância do FirebaseApp especificada.

Assinatura:

export declare function getInstallations(app?: FirebaseApp): Installations;

Parâmetros

Parâmetro	Tipo	Descrição
app	FirebaseApp	A instância FirebaseApp.

Retorna:

Instalações

função(instalações, ...)

deleteInstalls(instalações)

Exclui a instalação do Firebase e todos os dados associados.

Assinatura:

export declare function deleteInstallations(installations: Installations): Promise<void>;

Parâmetros

Parâmetro	Tipo	Descrição
instalações	Instalações	A instância Installations.

Retorna:

Promessa<void>

getId(instalações)

Cria uma instalação do Firebase se não houver uma para o app e retorna o ID de instalação.

Assinatura:

export declare function getId(installations: Installations): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
instalações	Instalações	A instância Installations.

Retorna:

Promessa<string>

getToken(Installs, forceRefresh)

Retorna um token de autenticação das instalações do Firebase, identificando a instalação atual do Firebase.

Assinatura:

export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

Parâmetros

Parâmetro	Tipo	Descrição
instalações	Instalações	A instância Installations.
forceRefresh	booleano	Forçar a atualização, independentemente da expiração do token.

Retorna:

Promessa<string>

onIdChange(instalações, callback)

Define um novo retorno de chamada que será chamado quando o ID de instalação mudar. Retorna uma função de cancelamento de inscrição que removerá o callback quando for chamado.

Assinatura:

export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;

Parâmetros

Parâmetro	Tipo	Descrição
instalações	Instalações	A instância Installations.
callback	IdChangeCallbackFn (link em inglês)	A função de callback que é invocada quando a FID muda.

Retorna:

IdChangeUnsubscribeFn (em inglês)

Uma função que pode ser chamada para cancelar a inscrição.

IdChangeCallbackFn.

Uma função de callback definida pelo usuário que é chamada quando o ID de instalações muda.

Assinatura:

export declare type IdChangeCallbackFn = (installationId: string) => void;

IdChangeUnsubscribeFn

Cancelar a inscrição de uma função de callback adicionada anteriormente por IdChangeCallbackFn.

Assinatura:

export declare type IdChangeUnsubscribeFn = () => void;