Funktionen
Funktion | Beschreibung |
---|---|
beforeOperation(eventType, optsOrHandler, handler) | |
beforeUserCreated(handler) | Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer erstellt wird. |
beforeUserCreated(opts, handler) | Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer erstellt wird. |
beforeUserSignedIn(handler) | Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer angemeldet ist. |
beforeUserSignedIn(opts, handler) | Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer angemeldet ist. |
getOpts(blockingOptions) |
Klassen
Klasse | Beschreibung |
---|---|
HttpsError | Ein expliziter Fehler, der von einem Handler ausgelöst werden kann, um einen Fehler an den Client zu senden, der die Funktion aufgerufen hat. |
Schnittstellen
Schnittstelle | Beschreibung |
---|---|
AuthBlockingEvent | Definiert das Authentifizierungsereignis für Blockierungsereignisse der 2. Generation |
AuthUserRecord | Der UserRecord der von der Identitätsplattform an Authentifizierungsblockierungsfunktionen übergeben wird. |
Blockierungsoptionen | Alle Funktionsoptionen plus idToken, accessToken und restartToken. |
Identity.beforeOperation()
Unterschrift:
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;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Ereignistyp | AuthBlockingEventType | |
optsOrHandler | Blockierungsoptionen | ((Ereignis: AuthBlockingEvent ) => BeforeCreateResponse | BeforeSignInResponse | nichtig | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Versprechen<void>) | |
Handler | (Ereignis: AuthBlockingEvent ) => BeforeCreateResponse | BeforeSignInResponse | nichtig | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Versprechen<void> |
Kehrt zurück:
Blockierungsfunktion
Identity.beforeUserCreated()
Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer erstellt wird.
Unterschrift:
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Handler | (Ereignis: AuthBlockingEvent ) => BeforeCreateResponse | Promise<BeforeCreateResponse> | nichtig | Versprechen<void> | Event-Handler, der jedes Mal ausgeführt wird, bevor ein Benutzer erstellt wird |
Kehrt zurück:
Blockierungsfunktion
Identity.beforeUserCreated()
Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer erstellt wird.
Unterschrift:
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
optiert | Blockierungsoptionen | Objekt, das Funktionsoptionen enthält |
Handler | (Ereignis: AuthBlockingEvent ) => BeforeCreateResponse | Promise<BeforeCreateResponse> | nichtig | Versprechen<void> | Event-Handler, der jedes Mal ausgeführt wird, bevor ein Benutzer erstellt wird |
Kehrt zurück:
Blockierungsfunktion
Identity.beforeUserSignedIn()
Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer angemeldet ist.
Unterschrift:
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Handler | (Ereignis: AuthBlockingEvent ) => BeforeSignInResponse | Promise<BeforeSignInResponse> | nichtig | Versprechen<void> | Ereignishandler, der jedes Mal ausgeführt wird, bevor ein Benutzer angemeldet ist |
Kehrt zurück:
Blockierungsfunktion
Identity.beforeUserSignedIn()
Behandelt ein Ereignis, das ausgelöst wird, bevor ein Benutzer angemeldet ist.
Unterschrift:
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
optiert | Blockierungsoptionen | Objekt, das Funktionsoptionen enthält |
Handler | (Ereignis: AuthBlockingEvent ) => BeforeSignInResponse | Promise<BeforeSignInResponse> | nichtig | Versprechen<void> | Ereignishandler, der jedes Mal ausgeführt wird, bevor ein Benutzer angemeldet ist |
Kehrt zurück:
Blockierungsfunktion
Identity.getOpts()
Unterschrift:
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Blockierungsoptionen | Blockierungsoptionen |
Kehrt zurück:
Interne Optionen