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
função (aplicativo, ...)
getInstalações(aplicativo)	Retorna uma instância de instalações associadas à instância FirebaseApp fornecida.
função(instalações, ...)
deletarInstalações(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 aplicativo e retorna o ID da instalação.
getToken(instalações,forceRefresh)	Retorna um token de autenticação do Firebase Installations, identificando a instalação atual do Firebase.
onIdChange(instalações, retorno de chamada)	Define um novo retorno de chamada que será chamado quando o ID de instalação for alterado. Retorna uma função de cancelamento de assinatura que removerá o retorno de chamada quando chamada.

Interfaces

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

Aliases de tipo

Digite Alias	Descrição
IdChangeCallbackFn	Uma função de retorno de chamada definida pelo usuário que é chamada quando o ID de instalação é alterado.
IdChangeUnsubscribeFn	Cancele a assinatura de uma função de retorno de chamada adicionada anteriormente por meio de IdChangeCallbackFn .

função (aplicativo, ...)

getInstalações(aplicativo)

Retorna uma instância de instalações associadas à instância FirebaseApp fornecida.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
aplicativo	Aplicativo Firebase	A instância do FirebaseApp .

Retorna:

Instalações

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

deletarInstalações(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 aplicativo e retorna o ID da 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(instalações,forceRefresh)

Retorna um token de autenticação do Firebase Installations, 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 .
forçar atualização	boleano	Forçar a atualização independentemente da expiração do token.

Retorna:

Promessa<string>

onIdChange(instalações, retorno de chamada)

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

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 .
ligar de volta	IdChangeCallbackFn	A função de retorno de chamada que é invocada quando o FID é alterado.

Retorna:

IdChangeUnsubscribeFn

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

IdChangeCallbackFn

Uma função de retorno de chamada definida pelo usuário que é chamada quando o ID de instalação é alterado.

Assinatura:

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

IdChangeUnsubscribeFn

Cancelar a assinatura de uma função de retorno de chamada adicionada anteriormente por meio de IdChangeCallbackFn .

Assinatura:

export declare type IdChangeUnsubscribeFn = () => void;