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;

参数

范围类型描述
阻塞选项阻止选项

返回:

内部选项