Funções
| Função | Descrição |
|---|---|
| user(userOptions); | Processa eventos relacionados a eventos de usuários do Firebase Auth. |
| userRecordConstructor(wireData) | Função auxiliar que cria uma classe UserRecord com base nos dados enviados pela rede. |
Classes
| Turma | Descrição |
|---|---|
| HttpsError (em inglês) | Um erro explícito que pode ser gerado a partir de um manipulador para enviar um erro ao cliente que chamou a função. |
| UserBuilder (link em inglês) | Construtor usado para criar funções para eventos de ciclo de vida do usuário do Firebase Auth. |
| UserRecordMetadata (em inglês) | Classe auxiliar para criar os metadados do usuário em um objeto UserRecord. |
Interfaces
| Interface | Descrição |
|---|---|
| UserOptions | Opções para a função de bloqueio de autenticação. |
Aliases de tipos
| Alias de tipo | Descrição |
|---|---|
| UserInfo (em inglês) | UserInfo que faz parte do UserRecord. |
| UserRecord (em inglês) | O UserRecord transmitido ao Cloud Functions é o mesmo UserRecord retornado pelo SDK Admin do Firebase. |
Auth.user()
Processa eventos relacionados a eventos de usuários do Firebase Auth.
Assinatura:
export declare function user(userOptions?: UserOptions): UserBuilder;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| userOptions | UserOptions | Opções no nível do recurso |
Retorna:
UserBuilder (link em inglês)
UserBuilder: criador usado para criar funções para eventos de ciclo de vida do usuário do Firebase Auth
auth.userRecordConstructor()
Função auxiliar que cria uma classe UserRecord com base nos dados enviados pela rede.
Assinatura:
export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Dados de transferência | Registro<string, desconhecido> | dados enviados pela rede |
Retorna:
UserRecord (em inglês)
uma instância de UserRecord com funções toJSON corretas
auth.UserInfo
UserInfo que faz parte de UserRecord.
Assinatura:
export type UserInfo = auth.UserInfo;
auth.UserRecord
O UserRecord transmitido ao Cloud Functions é o mesmo UserRecord retornado pelo SDK Admin do Firebase.
Assinatura:
export type UserRecord = auth.UserRecord;