identity namespace

功能

功能描述
beforeOperation(事件類型,optsOrHandler,處理程序)
在使用者建立之前(處理程序)處理建立使用者之前觸發的事件。
beforeUserCreated(選擇,處理程序)處理建立使用者之前觸發的事件。
用戶登入之前(處理程序)處理使用者登入之前觸發的事件。
beforeUserSignedIn(選擇,處理程序)處理使用者登入之前觸發的事件。
getOpts(阻塞選項)

課程

班級描述
Https錯誤可以從處理程序引發的明確錯誤,以將錯誤傳送到呼叫函數的用戶端。

介面

介面描述
AuthBlocking事件定義第二代阻止事件的身份驗證事件
驗證使用者記錄UserRecord從身分識別平台傳遞到驗證阻止函數。
阻止選項所有功能選項加上idToken、accessToken 和refreshToken。

身份.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;

參數

範圍類型描述
事件類型AuthBlockingEventType
選項或處理程序阻止選項| ((事件: AuthBlockingEvent ) => 建立回應之前 |登入回應之前 |無效| Promise<BeforeCreateResponse> |承諾<BeforeSignInResponse> |承諾<無效>)
處理程式(事件: AuthBlockingEvent ) => 建立回應之前 |登入回應之前 |無效| Promise<BeforeCreateResponse> |承諾<BeforeSignInResponse> |承諾<無效>

返回:

阻塞功能

身份.beforeUserCreated()

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

簽名:

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

參數

範圍類型描述
處理程式(事件: AuthBlockingEvent ) => 建立回應之前 | Promise<BeforeCreateResponse> |無效|承諾<無效>每次創建用戶之前運行的事件處理程序

返回:

阻塞功能

身份.beforeUserCreated()

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

簽名:

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

參數

範圍類型描述
選擇阻止選項包含函數選項的對象
處理程式(事件: AuthBlockingEvent ) => 建立回應之前 | Promise<BeforeCreateResponse> |無效|承諾<無效>每次創建用戶之前運行的事件處理程序

返回:

阻塞功能

身份.beforeUserSignedIn()

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

簽名:

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

參數

範圍類型描述
處理程式(事件: AuthBlockingEvent ) => 在登入回應之前 |承諾<BeforeSignInResponse> |無效|承諾<無效>每次使用者登入之前執行的事件處理程序

返回:

阻塞功能

身份.beforeUserSignedIn()

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

簽名:

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

參數

範圍類型描述
選擇阻止選項包含函數選項的對象
處理程式(事件: AuthBlockingEvent ) => 在登入回應之前 |承諾<BeforeSignInResponse> |無效|承諾<無效>每次使用者登入之前執行的事件處理程序

返回:

阻塞功能

身份.getOpts()

簽名:

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

參數

範圍類型描述
阻塞選項阻止選項

返回:

內部選項