Funkcje
| Funkcja | Opis |
|---|---|
| beforeOperation(eventType, optsOrHandler, moduł obsługi) | |
| beforeUserCreated(obsługa) | Obsługuje zdarzenie, które jest wywoływane przed utworzeniem użytkownika. |
| beforeUserCreated(opts, moduł obsługi) | Obsługuje zdarzenie, które jest wywoływane przed utworzeniem użytkownika. |
| beforeUserSignedIn(obsługa) | Obsługuje zdarzenie, które jest wywoływane przed zalogowaniem użytkownika. |
| beforeUserSignedIn(opty, moduł obsługi) | Obsługuje zdarzenie, które jest wywoływane przed zalogowaniem użytkownika. |
| getOpts(blockingOptions) |
Zajęcia
| Klasa | Opis |
|---|---|
| Błąd HTTP | Jawny błąd, który może zostać zgłoszony z modułu obsługi, aby wysłać błąd do klienta, który wywołał tę funkcję. |
Interfejsy
| Interfejs | Opis |
|---|---|
| AuthBlockEvent | Definiuje zdarzenie uwierzytelniania dla zdarzeń blokujących 2 generacji |
| AuthUserRecord (Rekord uwierzytelniania użytkownika AuthUserRecord) | Identyfikator UserRecord przekazany do funkcji blokowania uwierzytelniania z platformy tożsamości. |
| BlockOptions | Wszystkie opcje funkcji oraz identyfikatory idToken, accessToken i refreshToken. |
identity.beforeOperation()
Podpis:
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;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| eventType | Typ zdarzenia AuthBlokuj | |
| optsOrHandler | BlockOptions | ((event: AuthBlockEvent) => beforeCreateResponse | beforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>) | |
| moduł obsługi | (zdarzenie: AuthBlockEvent) => beforeCreateResponse | beforeSignInResponse | nieważna | Promise<BeforeCreateResponse> | Obietnica<BeforeSignInResponse> | Obietnica<void> |
Zwroty:
Funkcja blokowania
identity.beforeUserCreated()
Obsługuje zdarzenie, które jest wywoływane przed utworzeniem użytkownika.
Podpis:
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| moduł obsługi | (zdarzenie: AuthBlockEvent) => beforeCreateResponse | Promise<BeforeCreateResponse> | nieważna | Obietnica<void> | Moduł obsługi zdarzeń, który jest uruchamiany za każdym razem przed utworzeniem użytkownika |
Zwroty:
Funkcja blokowania
identity.beforeUserCreated()
Obsługuje zdarzenie, które jest wywoływane przed utworzeniem użytkownika.
Podpis:
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | BlockOptions | Obiekt zawierający opcje funkcji |
| moduł obsługi | (zdarzenie: AuthBlockEvent) => beforeCreateResponse | Promise<BeforeCreateResponse> | nieważna | Obietnica<void> | Moduł obsługi zdarzeń, który jest uruchamiany za każdym razem przed utworzeniem użytkownika |
Zwroty:
Funkcja blokowania
identity.beforeUserSignedIn()
Obsługuje zdarzenie, które jest wywoływane przed zalogowaniem użytkownika.
Podpis:
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| moduł obsługi | (zdarzenie: AuthBlockEvent) => beforeSignInResponse | Obietnica<BeforeSignInResponse> | nieważna | Obietnica<void> | Moduł obsługi zdarzeń, który jest uruchamiany przed zalogowaniem użytkownika. |
Zwroty:
Funkcja blokowania
identity.beforeUserSignedIn()
Obsługuje zdarzenie, które jest wywoływane przed zalogowaniem użytkownika.
Podpis:
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | BlockOptions | Obiekt zawierający opcje funkcji |
| moduł obsługi | (zdarzenie: AuthBlockEvent) => beforeSignInResponse | Obietnica<BeforeSignInResponse> | nieważna | Obietnica<void> | Moduł obsługi zdarzeń, który jest uruchamiany przed zalogowaniem użytkownika. |
Zwroty:
Funkcja blokowania
identity.getOpts()
Podpis:
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Opcje blokowania | BlockOptions |
Zwroty:
Opcje wewnętrzne