auth.UserBuilder class
Stay organized with collections
Save and categorize content based on your preferences.
Builder used to create functions for Firebase Auth user lifecycle events.
Signature:
export declare class UserBuilder
Methods
auth.UserBuilder.beforeCreate()
Blocks request to create a Firebase Auth user.
Signature:
beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeCreateResponse | void>): BlockingFunction;
Parameters
| Parameter |
Type |
Description |
| handler |
(user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeCreateResponse | void> |
Event handler that blocks creation of a Firebase Auth user. |
Returns:
BlockingFunction
auth.UserBuilder.beforeEmail()
Signature:
beforeEmail(handler: (context: AuthEventContext) => MaybeAsync<BeforeEmailResponse | void>): BlockingFunction;
Parameters
| Parameter |
Type |
Description |
| handler |
(context: AuthEventContext) => MaybeAsync<BeforeEmailResponse | void> |
|
Returns:
BlockingFunction
auth.UserBuilder.beforeSignIn()
Blocks request to sign-in a Firebase Auth user.
Signature:
beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeSignInResponse | void>): BlockingFunction;
Parameters
| Parameter |
Type |
Description |
| handler |
(user: AuthUserRecord, context: AuthEventContext) => MaybeAsync<BeforeSignInResponse | void> |
Event handler that blocks sign-in of a Firebase Auth user. |
Returns:
BlockingFunction
auth.UserBuilder.beforeSms()
Signature:
beforeSms(handler: (context: AuthEventContext) => MaybeAsync<BeforeSmsResponse | void>): BlockingFunction;
Parameters
| Parameter |
Type |
Description |
| handler |
(context: AuthEventContext) => MaybeAsync<BeforeSmsResponse | void> |
|
Returns:
BlockingFunction
auth.UserBuilder.onCreate()
Responds to the creation of a Firebase Auth user.
Signature:
onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;
Parameters
| Parameter |
Type |
Description |
| handler |
(user: UserRecord, context: EventContext) => PromiseLike<any> | any |
Event handler that responds to the creation of a Firebase Auth user. |
Returns:
CloudFunction<UserRecord>
auth.UserBuilder.onDelete()
Responds to the deletion of a Firebase Auth user.
Signature:
onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;
Parameters
| Parameter |
Type |
Description |
| handler |
(user: UserRecord, context: EventContext) => PromiseLike<any> | any |
Event handler that responds to the deletion of a Firebase Auth user. |
Returns:
CloudFunction<UserRecord>
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-22 UTC.
[null,null,["Last updated 2024-11-22 UTC."],[],[],null,["# auth.UserBuilder class\n\nBuilder used to create functions for Firebase Auth user lifecycle events.\n\n**Signature:** \n\n export declare class UserBuilder \n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|-----------------------------------------------------------------------------------------------|-----------|---------------------------------------------------|\n| [beforeCreate(handler)](./firebase-functions.auth.userbuilder.md#authuserbuilderbeforecreate) | | Blocks request to create a Firebase Auth user. |\n| [beforeEmail(handler)](./firebase-functions.auth.userbuilder.md#authuserbuilderbeforeemail) | | |\n| [beforeSignIn(handler)](./firebase-functions.auth.userbuilder.md#authuserbuilderbeforesignin) | | Blocks request to sign-in a Firebase Auth user. |\n| [beforeSms(handler)](./firebase-functions.auth.userbuilder.md#authuserbuilderbeforesms) | | |\n| [onCreate(handler)](./firebase-functions.auth.userbuilder.md#authuserbuilderoncreate) | | Responds to the creation of a Firebase Auth user. |\n| [onDelete(handler)](./firebase-functions.auth.userbuilder.md#authuserbuilderondelete) | | Responds to the deletion of a Firebase Auth user. |\n\nauth.UserBuilder.beforeCreate()\n-------------------------------\n\nBlocks request to create a Firebase Auth user.\n\n**Signature:** \n\n beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) =\u003e MaybeAsync\u003cBeforeCreateResponse | void\u003e): BlockingFunction;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------|\n| handler | (user: AuthUserRecord, context: AuthEventContext) =\\\u003e MaybeAsync\\\u003cBeforeCreateResponse \\| void\\\u003e | Event handler that blocks creation of a Firebase Auth user. |\n\n**Returns:**\n\n[BlockingFunction](./firebase-functions.blockingfunction.md#blockingfunction_interface)\n\nauth.UserBuilder.beforeEmail()\n------------------------------\n\n**Signature:** \n\n beforeEmail(handler: (context: AuthEventContext) =\u003e MaybeAsync\u003cBeforeEmailResponse | void\u003e): BlockingFunction;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|---------------------------------------------------------------------------|-------------|\n| handler | (context: AuthEventContext) =\\\u003e MaybeAsync\\\u003cBeforeEmailResponse \\| void\\\u003e | |\n\n**Returns:**\n\n[BlockingFunction](./firebase-functions.blockingfunction.md#blockingfunction_interface)\n\nauth.UserBuilder.beforeSignIn()\n-------------------------------\n\nBlocks request to sign-in a Firebase Auth user.\n\n**Signature:** \n\n beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) =\u003e MaybeAsync\u003cBeforeSignInResponse | void\u003e): BlockingFunction;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|--------------------------------------------------------------------------------------------------|------------------------------------------------------------|\n| handler | (user: AuthUserRecord, context: AuthEventContext) =\\\u003e MaybeAsync\\\u003cBeforeSignInResponse \\| void\\\u003e | Event handler that blocks sign-in of a Firebase Auth user. |\n\n**Returns:**\n\n[BlockingFunction](./firebase-functions.blockingfunction.md#blockingfunction_interface)\n\nauth.UserBuilder.beforeSms()\n----------------------------\n\n**Signature:** \n\n beforeSms(handler: (context: AuthEventContext) =\u003e MaybeAsync\u003cBeforeSmsResponse | void\u003e): BlockingFunction;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|-------------------------------------------------------------------------|-------------|\n| handler | (context: AuthEventContext) =\\\u003e MaybeAsync\\\u003cBeforeSmsResponse \\| void\\\u003e | |\n\n**Returns:**\n\n[BlockingFunction](./firebase-functions.blockingfunction.md#blockingfunction_interface)\n\nauth.UserBuilder.onCreate()\n---------------------------\n\nResponds to the creation of a Firebase Auth user.\n\n**Signature:** \n\n onCreate(handler: (user: UserRecord, context: EventContext) =\u003e PromiseLike\u003cany\u003e | any): CloudFunction\u003cUserRecord\u003e;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|\n| handler | (user: [UserRecord](./firebase-functions.auth.md#authuserrecord), context: [EventContext](./firebase-functions.eventcontext.md#eventcontext_interface)) =\\\u003e PromiseLike\\\u003cany\\\u003e \\| any | Event handler that responds to the creation of a Firebase Auth user. |\n\n**Returns:**\n\n[CloudFunction](./firebase-functions.cloudfunction.md#cloudfunction_interface)\\\u003c[UserRecord](./firebase-functions.auth.md#authuserrecord)\\\u003e\n\nauth.UserBuilder.onDelete()\n---------------------------\n\nResponds to the deletion of a Firebase Auth user.\n\n**Signature:** \n\n onDelete(handler: (user: UserRecord, context: EventContext) =\u003e PromiseLike\u003cany\u003e | any): CloudFunction\u003cUserRecord\u003e;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|\n| handler | (user: [UserRecord](./firebase-functions.auth.md#authuserrecord), context: [EventContext](./firebase-functions.eventcontext.md#eventcontext_interface)) =\\\u003e PromiseLike\\\u003cany\\\u003e \\| any | Event handler that responds to the deletion of a Firebase Auth user. |\n\n**Returns:**\n\n[CloudFunction](./firebase-functions.cloudfunction.md#cloudfunction_interface)\\\u003c[UserRecord](./firebase-functions.auth.md#authuserrecord)\\\u003e"]]
