SignInAuthenticationHandler<TOptions> Klasa

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Authentication

Zestaw:

Microsoft.AspNetCore.Authentication.dll

Pakiet:

Microsoft.AspNetCore.App.Ref v8.0.0

Źródło:

SignInAuthenticationHandler.cs

Dodaje obsługę narzędzia SignInAsync

generic <typename TOptions>
 where TOptions : AuthenticationSchemeOptionsgcnew()public ref class SignInAuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::SignOutAuthenticationHandler<TOptions>, Microsoft::AspNetCore::Authentication::IAuthenticationSignInHandler

public abstract class SignInAuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.SignOutAuthenticationHandler<TOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler where TOptions : AuthenticationSchemeOptions, new()

type SignInAuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    inherit SignOutAuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))>
    interface IAuthenticationSignInHandler
    interface IAuthenticationSignOutHandler
    interface IAuthenticationHandler

Public MustInherit Class SignInAuthenticationHandler(Of TOptions)
Inherits SignOutAuthenticationHandler(Of TOptions)
Implements IAuthenticationSignInHandler

Parametry typu

TOptions

Dziedziczenie

Object

AuthenticationHandler<TOptions>

SignOutAuthenticationHandler<TOptions>

SignInAuthenticationHandler<TOptions>

Pochodne

Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationHandler

Microsoft.AspNetCore.Authentication.PolicySchemeHandler

Implementuje

IAuthenticationHandler IAuthenticationSignInHandler IAuthenticationSignOutHandler

Konstruktory

SignInAuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	Inicjuje nowe wystąpienie SignInAuthenticationHandler<TOptions>.
SignInAuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Przestarzałe. Inicjuje nowe wystąpienie SignInAuthenticationHandler<TOptions>.

Właściwości

ChallengeCalled	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
ClaimsIssuer	Pobiera wystawcę, który powinien być używany podczas wydawania oświadczeń. (Odziedziczone po AuthenticationHandler<TOptions>)
Clock	Przestarzałe. Pobiera ISystemClock. (Odziedziczone po AuthenticationHandler<TOptions>)
Context	Pobiera lub ustawia HttpContext. (Odziedziczone po AuthenticationHandler<TOptions>)
CurrentUri	Pobiera bezwzględny bieżący adres URL. (Odziedziczone po AuthenticationHandler<TOptions>)
Events	Procedura obsługi wywołuje metody dla zdarzeń, które dają kontrolę aplikacji w określonych punktach, w których odbywa się przetwarzanie. Jeśli nie podano wystąpienia domyślnego, które nie wykonuje żadnych operacji, gdy metody są wywoływane. (Odziedziczone po AuthenticationHandler<TOptions>)
InitializeResult	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
Logger	Pobiera ILogger. (Odziedziczone po AuthenticationHandler<TOptions>)
Options	Pobiera lub ustawia opcje skojarzone z tą procedurą obsługi uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>)
OptionsMonitor	Pobiera IOptionsMonitor<TOptions> w celu wykrywania zmian w opcjach. (Odziedziczone po AuthenticationHandler<TOptions>)
OriginalPath	Pobiera ścieżkę widzianą przez oprogramowanie pośredniczące uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>)
OriginalPathBase	Pobiera bazę ścieżki, jak widać w przypadku oprogramowania pośredniczącego uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>)
PriorHandler	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
Request	Pobiera HttpRequest skojarzone z bieżącym żądaniem. (Odziedziczone po AuthenticationHandler<TOptions>)
Response	Pobiera HttpResponse skojarzone z bieżącym żądaniem. (Odziedziczone po AuthenticationHandler<TOptions>)
Scheme	Pobiera lub ustawia AuthenticationScheme skojarzone z tą procedurą obsługi uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>)
SignInAccepted	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
SignOutAccepted	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
TimeProvider	Pobiera bieżący czas, głównie na potrzeby testów jednostkowych. (Odziedziczone po AuthenticationHandler<TOptions>)
UrlEncoder	Pobiera UrlEncoder. (Odziedziczone po AuthenticationHandler<TOptions>)

Metody

AuthenticateAsync()	Uwierzytelnij bieżące żądanie. (Odziedziczone po AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
BuildRedirectUri(String)	Tworzy bezwzględny adres URL dla określonego targetPath. (Odziedziczone po AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Wyśmiej bieżące żądanie. (Odziedziczone po AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
CreateEventsAsync()	Tworzy nowe wystąpienie wystąpienia zdarzeń. (Odziedziczone po AuthenticationHandler<TOptions>)
FinishResponseAsync()	Hak, który jest wywoływany, gdy odpowiedź ma zostać wysłana (Odziedziczone po AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Zabronić bieżącego żądania. (Odziedziczone po AuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Umożliwia typom pochodnym obsługę uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	Służy do zapewnienia, że funkcja HandleAuthenticateAsync jest wywoływana tylko raz. Kolejne wywołania będą zwracać ten sam wynik uwierzytelnienia. (Odziedziczone po AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	Służy do zapewnienia, że funkcja HandleAuthenticateAsync jest wywoływana tylko raz. Kolejne wywołania będą zwracać ten sam wynik uwierzytelniania. Wszelkie wyjątki zostaną przekonwertowane na wynik uwierzytelniania, który zakończył się niepowodzeniem zawierający wyjątek. (Odziedziczone po AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	Zastąpij tę metodę, aby poradzić sobie z problemami z wyzwaniem 401, jeśli schemat uwierzytelniania, którego dotyczy problem, dotyczy interakcji z uwierzytelnianiem w ramach przepływu żądań. (na przykład dodanie nagłówka odpowiedzi lub zmiana wyniku 401 na 302 na stronę logowania lub lokalizację logowania zewnętrznego). (Odziedziczone po AuthenticationHandler<TOptions>)
HandleForbiddenAsync(AuthenticationProperties)	Zastąp tę metodę, aby obsługiwać metodę Forbid. (Odziedziczone po AuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	Zastąpi tę metodę, aby poradzić sobie z wyzwaniem, które jest zabronione. (Odziedziczone po AuthenticationHandler<TOptions>)
HandleRequestAsync()	Wywoływany raz przez wspólny kod po zainicjowaniu. Jeśli oprogramowanie pośredniczące uwierzytelniania odpowiada bezpośrednio na znane ścieżki, musi zastąpić tę wirtualną, porównaj ścieżkę żądania ze znanymi ścieżkami, podaj odpowiednie informacje o odpowiedzi i wartość true, aby zatrzymać dalsze przetwarzanie. (Odziedziczone po AuthenticationHandler<TOptions>)
HandleSignInAsync(ClaimsPrincipal, AuthenticationProperties)	Zastąpi tę metodę do obsługi funkcji SignIn.
HandleSignInAsync(SignInContext)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
HandleSignOutAsync(AuthenticationProperties)	Zastąpij tę metodę do obsługi funkcji SignOut. (Odziedziczone po SignOutAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	Zastąpij tę metodę, aby poradzić sobie z problemami z wyzwaniem 401, jeśli schemat uwierzytelniania, którego dotyczy problem, dotyczy interakcji z uwierzytelnianiem w ramach przepływu żądań. (na przykład dodanie nagłówka odpowiedzi lub zmiana wyniku 401 na 302 na stronę logowania lub lokalizację logowania zewnętrznego). (Odziedziczone po AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	Zainicjuj procedurę obsługi, rozwiąż opcje i zweryfikuj je. (Odziedziczone po AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Inicjowanie jest wywoływane raz na żądanie w celu kontekstowania tego wystąpienia z odpowiednim stanem. (Odziedziczone po AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Inicjuje obiekt zdarzeń, wywoływany raz na żądanie przez InitializeAsync(AuthenticationScheme, HttpContext). (Odziedziczone po AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	Wywołana po zainicjowaniu opcji/zdarzeń została zainicjowana, aby program obsługi zakończył inicjowanie. (Odziedziczone po AuthenticationHandler<TOptions>)
ResolveTarget(String)	Rozwiązuje schemat, do którego jest przekazywana ta operacja uwierzytelniania. (Odziedziczone po AuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
SignInAsync(ClaimsPrincipal, AuthenticationProperties)	Obsługa logowania.
SignInAsync(SignInContext)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	Zachowanie wylogowywania. (Odziedziczone po SignOutAuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	Dodaje obsługę narzędzia SignInAsync (Odziedziczone po AuthenticationHandler<TOptions>)