auth.UserBuilder class

用于为 Firebase Auth 用户生命周期事件创建函数的构建器。

签名:

export declare class UserBuilder 

方法

方法修饰符描述
创建之前(处理程序)阻止创建 Firebase Auth 用户的请求。
登录之前(处理程序)阻止登录 Firebase Auth 用户的请求。
onCreate(处理程序)响应 Firebase Auth 用户的创建。
onDelete(处理程序)响应删除 Firebase Auth 用户。

auth.UserBuilder.beforeCreate()

阻止创建 Firebase Auth 用户的请求。

签名:

beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeCreateResponse | void | Promise<BeforeCreateResponse> | Promise<void>): BlockingFunction;

参数

范围类型描述
处理程序(用户:AuthUserRecord,上下文:AuthEventContext)=> BeforeCreateResponse |无效| Promise<BeforeCreateResponse> |承诺<无效>阻止创建 Firebase Auth 用户的事件处理程序。

返回:

阻塞功能

auth.UserBuilder.beforeSignIn()

阻止登录 Firebase Auth 用户的请求。

签名:

beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeSignInResponse | void | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;

参数

范围类型描述
处理程序(用户:AuthUserRecord,上下文:AuthEventContext)=> BeforeSignInResponse |无效|承诺<BeforeSignInResponse> |承诺<无效>阻止 Firebase Auth 用户登录的事件处理程序。

返回:

阻塞功能

auth.UserBuilder.onCreate()

响应 Firebase Auth 用户的创建。

签名:

onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;

参数

范围类型描述
处理程序(用户:用户记录, 上下文: EventContext ) => PromiseLike<任意> |任何响应 Firebase Auth 用户创建的事件处理程序。

返回:

云函数<用户记录>

auth.UserBuilder.onDelete()

响应删除 Firebase Auth 用户。

签名:

onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;

参数

范围类型描述
处理程序(用户:用户记录, 上下文: EventContext ) => PromiseLike<任意> |任何响应删除 Firebase Auth 用户的事件处理程序。

返回:

云函数<用户记录>