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 使用者的事件處理程序。

返回:

雲函數<使用者記錄>