Funciones
| Función | Descripción |
|---|---|
| beforeOperation(tipo de evento, optsOrHandler, controlador) | |
| antes de UserCreated (controlador) | Maneja un evento que se activa antes de que se cree un usuario. |
| beforeUserCreated(opts, controlador) | Maneja un evento que se activa antes de que se cree un usuario. |
| antes de que el usuario inicie sesión (controlador) | Maneja un evento que se activa antes de que un usuario inicie sesión. |
| beforeUserSignedIn (opta, controlador) | Maneja un evento que se activa antes de que un usuario inicie sesión. |
| getOpts(opciones de bloqueo) |
Clases
| Clase | Descripción |
|---|---|
| Error HTTPS | Un error explícito que puede generar 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 de segunda generación. |
| Registro de usuario de autenticación | El UserRecord pasó a las funciones de bloqueo de autenticación desde la plataforma de identidad. |
| Opciones de bloqueo | Todas las opciones de funciones más idToken, accessToken y refrescoToken. |
identidad.antes de la operación()
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 | Tipo de evento de bloqueo de autenticación | |
| optsOrHandler | Opciones de bloqueo | ((evento: AuthBlockingEvent ) => Antes de crear respuesta | Antes de iniciar sesiónRespuesta | vacío | Promesa<Antes de crear respuesta> | Promesa<BeforeSignInResponse> | Promesa<nulo>) | |
| manipulador | (evento: AuthBlockingEvent ) => Antes de crear respuesta | Antes de iniciar sesiónRespuesta | vacío | Promesa<Antes de crear respuesta> | Promesa<BeforeSignInResponse> | Promesa<nulo> |
Devoluciones:
Función de bloqueo
identidad.beforeUserCreated()
Maneja un evento que se activa 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<Antes de crear respuesta> | vacío | Promesa<nulo> | Controlador de eventos que se ejecuta cada vez antes de que se cree un usuario |
Devoluciones:
Función de bloqueo
identidad.beforeUserCreated()
Maneja un evento que se activa 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<Antes de crear respuesta> | vacío | Promesa<nulo> | Controlador de eventos que se ejecuta cada vez antes de que se cree un usuario |
Devoluciones:
Función de bloqueo
identidad.beforeUserSignedIn()
Maneja un evento que se activa 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 iniciar sesión en respuesta | Promesa<BeforeSignInResponse> | vacío | Promesa<nulo> | Controlador de eventos que se ejecuta cada vez que un usuario inicia sesión |
Devoluciones:
Función de bloqueo
identidad.beforeUserSignedIn()
Maneja un evento que se activa 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 iniciar sesión en respuesta | Promesa<BeforeSignInResponse> | vacío | Promesa<nulo> | Controlador de eventos que se ejecuta cada vez que un usuario inicia 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:
Opciones internas