Funciones
Función | Descripción |
---|---|
usuario(opciones de usuario) | Controla eventos relacionados con los eventos de usuarios de Firebase Auth. |
userRecordConstructor(wireData) | Función auxiliar que crea una clase UserRecord a partir de datos enviados por cable. |
Clases
Clase | Descripción |
---|---|
HttpsError | Un error explícito que puede arrojar un controlador para enviar un error al cliente que llamó a la función. |
UserBuilder | Es el compilador que se usa a fin de crear funciones para los eventos de ciclo de vida de los usuarios de Firebase Auth. |
UserRecordMetadata | Clase auxiliar para crear los metadatos del usuario en un objeto UserRecord . |
Interfaces
Interfaz | Descripción |
---|---|
UserOptions | Opciones para la función de bloqueo de Auth. |
Escribe alias
Alias de tipo | Descripción |
---|---|
Información de usuario | UserInfo que es parte de UserRecord . |
Registro de usuario | El UserRecord que se pasa a Cloud Functions es el mismo UserRecord que muestra el SDK de Firebase Admin. |
auth.user()
Controla eventos relacionados con los eventos de usuarios de Firebase Auth.
Firma:
export declare function user(userOptions?: UserOptions): UserBuilder;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
Opciones de usuario | UserOptions | Opciones de nivel de recursos |
Muestra:
UserBuilder: Compilador que se usa para crear funciones para eventos de ciclo de vida de usuarios de Firebase Auth
auth.userRecordConstructor()
Función auxiliar que crea una clase UserRecord
a partir de datos enviados por cable.
Firma:
export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
datos de cable | Registro<cadena, desconocida> | datos enviados por cable |
Muestra:
una instancia de UserRecord
con las funciones toJSON correctas
Información del usuario de autenticación
UserInfo
, que es parte de UserRecord
.
Firma:
export type UserInfo = auth.UserInfo;
auth.Registro del usuario
El UserRecord
que se pasa a Cloud Functions es el mismo UserRecord que muestra el SDK de Firebase Admin.
Firma:
export type UserRecord = auth.UserRecord;