Funciones
Función | Descripción |
---|---|
antes de la operación (tipo de evento, optsOrHandler, controlador) | |
beforeUserCreated (controlador) | Maneja un evento que se desencadena antes de que se cree un usuario. |
beforeUserCreated (opciones, controlador) | Maneja un evento que se desencadena antes de que se cree un usuario. |
beforeUserSignedIn(controlador) | Maneja un evento que se desencadena antes de que un usuario inicie sesión. |
beforeUserSignedIn(opciones, controlador) | Maneja un evento que se desencadena antes de que un usuario inicie sesión. |
getOpts(blockingOptions) |
Clases
Clase | Descripción |
---|---|
HttpsError | Un error explícito que se puede generar desde un controlador para enviar un error al cliente que llamó a la función. |
Interfaces
Interfaz | Descripción |
---|---|
Evento de bloqueo de autenticación | Define el evento de autenticación para eventos de bloqueo v2 |
AuthUserRecord | El UserRecord pasó a auth bloqueando Cloud Functions desde la plataforma de identidad. |
Opciones de bloqueo | Todas las opciones de funciones más idToken, accessToken y refreshToken. |
identidad.beforeOperation()
Firma:
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;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
tipo de evento | AuthBlockingEventTypeAuthBlockingEventType | |
optsOrHandler | Opciones de bloqueo | ((evento: AuthBlockingEvent ) => Antes de Crear Respuesta | Antes de iniciar sesión Respuesta | vacío | Promesa<BeforeCreateResponse> | Promesa<BeforeSignInResponse> | Promesa <vacío>) | |
manipulador | (evento: AuthBlockingEvent ) => Antes de Crear Respuesta | Antes de iniciar sesión Respuesta | vacío | Promesa<BeforeCreateResponse> | Promesa<BeforeSignInResponse> | Promesa <vacío> |
Devoluciones:
función de bloqueo
identidad.beforeUserCreated()
Maneja un evento que se desencadena antes de que se cree un usuario.
Firma:
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
manipulador | (evento: AuthBlockingEvent ) => Antes de Crear Respuesta | Promesa<BeforeCreateResponse> | vacío | Promesa <vacío> | Controlador de eventos que se ejecuta cada vez que se crea un usuario |
Devoluciones:
función de bloqueo
identidad.beforeUserCreated()
Maneja un evento que se desencadena antes de que se cree un usuario.
Firma:
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
opta | Opciones de bloqueo | Objeto que contiene opciones de función |
manipulador | (evento: AuthBlockingEvent ) => Antes de Crear Respuesta | Promesa<BeforeCreateResponse> | vacío | Promesa <vacío> | Controlador de eventos que se ejecuta cada vez que se crea un usuario |
Devoluciones:
función de bloqueo
identidad.beforeUserSignedIn()
Maneja un evento que se desencadena antes de que un usuario inicie sesión.
Firma:
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
manipulador | (evento: AuthBlockingEvent ) => Antes de la respuesta de inicio de sesión | Promesa<BeforeSignInResponse> | vacío | Promesa <vacío> | Controlador de eventos que se ejecuta cada vez antes de que un usuario inicie sesión |
Devoluciones:
función de bloqueo
identidad.beforeUserSignedIn()
Maneja un evento que se desencadena antes de que un usuario inicie sesión.
Firma:
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
opta | Opciones de bloqueo | Objeto que contiene opciones de función |
manipulador | (evento: AuthBlockingEvent ) => Antes de la respuesta de inicio de sesión | Promesa<BeforeSignInResponse> | vacío | Promesa <vacío> | Controlador de eventos que se ejecuta cada vez antes de que un usuario inicie sesión |
Devoluciones:
función de bloqueo
identidad.getOpts()
Firma:
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
opciones de bloqueo | Opciones de bloqueo |
Devoluciones:
InternalOptions