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...)
getInstallations(aplicativo) Retorna uma instância de Instalações associada à instância FirebaseApp fornecida.
função(instalações...)
deleteInstallations(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 de instalação.
getToken(instalações, forceRefresh) Retorna um token de autenticação de 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 for alterado. Retorna uma função de cancelamento de inscrição que removerá o retorno de chamada quando chamada.

Interfaces

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

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 Cancelar a assinatura de uma função de retorno de chamada adicionada anteriormente via IdChangeCallbackFn .

getInstallations()

Retorna uma instância de Instalações associada à instância FirebaseApp fornecida.

Assinatura:

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

Parâmetros

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

Retorna:

Instalações

deletarInstalaçõ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()

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()

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

Retorna:

Promessa<string>

onIdChange()

Define um novo retorno de chamada que será chamado quando o ID de instalação for alterado. Retorna uma função de cancelamento de inscrição 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 inscrição.

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 via IdChangeCallbackFn .

Assinatura:

export declare type IdChangeUnsubscribeFn = () => void;