函数
| 函数 | 说明 |
|---|---|
| beforeOperation(eventType, optsOrHandler, Handler) | |
| beforeUserCreated(handler) | 处理在创建用户之前触发的事件。 |
| beforeUserCreated(opts, Handler) | 处理在创建用户之前触发的事件。 |
| beforeUserSignedIn(handler) | 处理在用户登录之前触发的事件。 |
| beforeUserSignedIn(opts, Handler) | 处理在用户登录之前触发的事件。 |
| getOpts(blockingOptions) |
类
| 类 | 说明 |
|---|---|
| HttpsError | 可以从处理程序抛出的显式错误，以向调用函数的客户端发送错误。 |
接口
| 接口 | 说明 |
|---|---|
| AuthBlockingEvent | 定义第 2 代屏蔽事件的身份验证事件 |
| AuthUserRecord | 从身份平台传递给身份验证屏蔽函数的 UserRecord。 |
| 屏蔽选项 | 所有函数选项以及 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 | AuthBlockingEventType | |
| optsOrHandler | BlockOptions |((event: AuthBlockingEvent) =>BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>) | |
| handler | （事件：AuthBlockingEvent）=>beforeCreateResponse |beforeSignInResponse |无效 |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> | 每次创建用户前都会运行的事件处理脚本 |
返回：
屏蔽函数
Identity.beforeUserCreated()
处理在创建用户之前触发的事件。
签名：
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| 优化 | BlockOptions | 包含函数选项的对象 |
| handler | （事件：AuthBlockingEvent）=>beforeCreateResponse |Promise<BeforeCreateResponse>|无效 |承诺<void> | 每次创建用户前都会运行的事件处理脚本 |
返回：
屏蔽函数
Identity.beforeUserSignedIn()
处理在用户登录之前触发的事件。
签名：
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| handler | （事件：AuthBlockingEvent）=>beforeSignInResponse |Promise <BeforeSignInResponse>|无效 |承诺<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> | 每次用户登录前都会运行的事件处理脚本 |
返回：
屏蔽函数
Identity.getOpts()
签名：
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
参数
| 参数 | 类型 | 说明 |
|---|---|---|
| blockOptions | 屏蔽选项 |
返回：
内部选项