identity namespace

函式

函式 說明
beforeOperation(eventType, optsOrHandler, 處理常式)
beforeUserCreated(handler) 處理在使用者建立前觸發的事件。
beforeUserCreated(最佳化、處理常式) 處理在使用者建立前觸發的事件。
beforeUserSignedIn(handler) 處理使用者登入前觸發的事件。
beforeUserSignedIn(opts, 處理常式) 處理使用者登入前觸發的事件。
getOpts(blockingOptions)

類別

類別 說明
HttpsError 可從處理常式擲回的明確錯誤，將錯誤傳送至呼叫該函式的用戶端。

介面

介面 說明
AuthBlockingEvent 定義第 2 代封鎖事件的驗證事件
AuthUserRecord UserRecord傳遞到來自身分識別平台的 Auth 封鎖函式。
封鎖選項 所有函式選項，以及 idToken、accessToken 和 refreshToken。

Identity.beforeOperation()

簽名：

export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>), handler: (event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;

參數

參數 類型 說明
eventType 驗證封鎖事件類型
optsOrHandler 封鎖選項 |((event：AuthBlockingEvent) => beforeCreateResponse | beforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>)
handler (事件：AuthBlockingEvent) =>beforeCreateResponse |beforeSignInResponse |void |Promise<BeforeCreateResponse>|Promise<BeforeSignInResponse>|承諾<void>

傳回：

封鎖函式

Identity.beforeUserCreated()

處理在使用者建立前觸發的事件。

簽名：

export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

參數

參數 類型 說明
handler (事件：AuthBlockingEvent) =>beforeCreateResponse |Promise<BeforeCreateResponse>|void |承諾<void> 每次建立使用者前都會執行的事件處理常式

傳回：

封鎖函式

Identity.beforeUserCreated()

處理在使用者建立前觸發的事件。

簽名：

export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

參數

參數 類型 說明
最佳化 封鎖選項 含有函式選項的物件
handler (事件：AuthBlockingEvent) =>beforeCreateResponse |Promise<BeforeCreateResponse>|void |承諾<void> 每次建立使用者前都會執行的事件處理常式

傳回：

封鎖函式

Identity.beforeUserSignedIn()

處理使用者登入前觸發的事件。

簽名：

export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

參數

參數 類型 說明
handler (事件：AuthBlockingEvent) =>beforeSignInResponse |Promise<BeforeSignInResponse>|void |承諾<void> 事件處理常式會在使用者登入前執行

傳回：

封鎖函式

Identity.beforeUserSignedIn()

處理使用者登入前觸發的事件。

簽名：

export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

參數

參數 類型 說明
最佳化 封鎖選項 含有函式選項的物件
handler (事件：AuthBlockingEvent) =>beforeSignInResponse |Promise<BeforeSignInResponse>|void |承諾<void> 事件處理常式會在使用者登入前執行

傳回：

封鎖函式

Identity.getOpts()

簽名：

export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;

參數

參數 類型 說明
封鎖選項 封鎖選項

傳回：

內部選項