用來建立 Firebase 驗證使用者生命週期事件函式的建構工具。
簽名:
export declare class UserBuilder
方法
方法 | 修飾符 | 說明 |
---|---|---|
beforeCreate(handler) | 封鎖建立 Firebase 驗證使用者的要求。 | |
beforeSignIn(handler) | 封鎖登入 Firebase Auth 使用者的要求。 | |
onCreate(處理常式) | 回應建立 Firebase 驗證使用者的建立作業。 | |
onDelete(處理常式) | 回應刪除 Firebase 驗證使用者的刪除動作。 |
auth.UserBuilder.beforeCreate()
封鎖建立 Firebase 驗證使用者的要求。
簽名:
beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeCreateResponse | void | Promise<BeforeCreateResponse> | Promise<void>): BlockingFunction;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (使用者:AuthUserRecord,內容:AuthEventContext) =>beforeCreateResponse |void |Promise<BeforeCreateResponse>|承諾<void> | 禁止建立 Firebase 驗證使用者的事件處理常式。 |
傳回:
auth.UserBuilder.beforeSignIn()
封鎖登入 Firebase Auth 使用者的要求。
簽名:
beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeSignInResponse | void | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (使用者:AuthUserRecord,內容:AuthEventContext) =>beforeSignInResponse |void |Promise<BeforeSignInResponse>|承諾<void> | 封鎖 Firebase 驗證使用者的登入事件事件處理常式。 |
傳回:
auth.UserBuilder.onCreate()
回應建立 Firebase 驗證使用者的建立作業。
簽名:
onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (使用者:UserRecord,情境:EventContext) =>承諾<任何>|任何 | 回應 Firebase 驗證使用者建立作業的事件處理常式。 |
傳回:
auth.UserBuilder.onDelete()
回應刪除 Firebase 驗證使用者的刪除動作。
簽名:
onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;
參數
參數 | 類型 | 說明 |
---|---|---|
handler | (使用者:UserRecord,情境:EventContext) =>承諾<任何>|任何 | 回應 Firebase 驗證使用者刪除作業的事件處理常式。 |
傳回: