SignInAuthenticationHandler<TOptions> 类

定义

命名空间:

Microsoft.AspNetCore.Authentication

程序集:

Microsoft.AspNetCore.Authentication.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

SignInAuthenticationHandler.cs

添加对 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

类型参数

TOptions

继承

Object

AuthenticationHandler<TOptions>

SignOutAuthenticationHandler<TOptions>

SignInAuthenticationHandler<TOptions>

派生

Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationHandler

Microsoft.AspNetCore.Authentication.PolicySchemeHandler

实现

IAuthenticationHandler IAuthenticationSignInHandler IAuthenticationSignOutHandler

构造函数

SignInAuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	已过时. 初始化 SignInAuthenticationHandler<TOptions>的新实例。
SignInAuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	初始化 SignInAuthenticationHandler<TOptions>的新实例。

属性

ChallengeCalled	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
ClaimsIssuer	获取应在发出任何声明时使用的颁发者。 (继承自 AuthenticationHandler<TOptions>)
Clock	已过时. 获取 ISystemClock。 (继承自 AuthenticationHandler<TOptions>)
Context	获取或设置 HttpContext。 (继承自 AuthenticationHandler<TOptions>)
CurrentUri	获取绝对当前 URL。 (继承自 AuthenticationHandler<TOptions>)
Events	处理程序对事件调用方法，这些事件在发生处理的某些点为应用程序控制。 如果未提供默认实例，则会在调用方法时不执行任何操作。 (继承自 AuthenticationHandler<TOptions>)
InitializeResult	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
Logger	获取 ILogger。 (继承自 AuthenticationHandler<TOptions>)
Options	获取或设置与此身份验证处理程序关联的选项。 (继承自 AuthenticationHandler<TOptions>)
OptionsMonitor	获取用于检测选项更改的 IOptionsMonitor<TOptions>。 (继承自 AuthenticationHandler<TOptions>)
OriginalPath	获取身份验证中间件看到的路径。 (继承自 AuthenticationHandler<TOptions>)
OriginalPathBase	获取身份验证中间件看到的路径基。 (继承自 AuthenticationHandler<TOptions>)
PriorHandler	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
Request	获取与当前请求关联的 HttpRequest。 (继承自 AuthenticationHandler<TOptions>)
Response	获取与当前请求关联的 HttpResponse。 (继承自 AuthenticationHandler<TOptions>)
Scheme	获取或设置与此身份验证处理程序关联的 AuthenticationScheme。 (继承自 AuthenticationHandler<TOptions>)
SignInAccepted	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
SignOutAccepted	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
TimeProvider	获取当前时间，主要用于单元测试。 (继承自 AuthenticationHandler<TOptions>)
UrlEncoder	获取 UrlEncoder。 (继承自 AuthenticationHandler<TOptions>)

方法

AuthenticateAsync()	对当前请求进行身份验证。 (继承自 AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
BuildRedirectUri(String)	构造指定 targetPath的绝对 URL。 (继承自 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	质询当前请求。 (继承自 AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
CreateEventsAsync()	创建事件实例的新实例。 (继承自 AuthenticationHandler<TOptions>)
FinishResponseAsync()	即将发送响应时调用的挂钩 (继承自 AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	禁止当前请求。 (继承自 AuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	允许派生类型处理身份验证。 (继承自 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	用于确保 HandleAuthenticateAsync 只调用一次。 后续调用将返回相同的身份验证结果。 (继承自 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	用于确保 HandleAuthenticateAsync 仅安全调用一次。 后续调用将返回相同的身份验证结果。 任何异常都将转换为包含异常的失败身份验证结果。 (继承自 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	如果有问题的身份验证方案在请求流中处理身份验证交互，请重写此方法来处理 401 质询问题。 （例如添加响应标头，或者将 401 结果更改为登录页或外部登录位置的 302）。 (继承自 AuthenticationHandler<TOptions>)
HandleForbiddenAsync(AuthenticationProperties)	重写此方法以处理 Forbid。 (继承自 AuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	重写此方法以处理禁止的质询。 (继承自 AuthenticationHandler<TOptions>)
HandleRequestAsync()	初始化后由常见代码调用一次。 如果身份验证中间件直接响应特定已知路径，则必须重写此虚拟路径，将请求路径与已知路径进行比较，根据需要提供任何响应信息，以及 true 以停止进一步处理。 (继承自 AuthenticationHandler<TOptions>)
HandleSignInAsync(ClaimsPrincipal, AuthenticationProperties)	重写此方法以处理 SignIn。
HandleSignInAsync(SignInContext)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
HandleSignOutAsync(AuthenticationProperties)	重写此方法以处理 SignOut。 (继承自 SignOutAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	如果有问题的身份验证方案在请求流中处理身份验证交互，请重写此方法来处理 401 质询问题。 （例如添加响应标头，或者将 401 结果更改为登录页或外部登录位置的 302）。 (继承自 AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	初始化处理程序，解析选项并验证它们。 (继承自 AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	每次请求调用一次初始化，以便将此实例与适当的状态进行上下文化。 (继承自 AuthenticationHandler<TOptions>)
InitializeEventsAsync()	通过 InitializeAsync(AuthenticationScheme, HttpContext)对每个请求调用一次的事件对象进行初始化。 (继承自 AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	在初始化选项/事件后调用，以便处理程序完成自身初始化。 (继承自 AuthenticationHandler<TOptions>)
ResolveTarget(String)	解析此身份验证操作转发到的方案。 (继承自 AuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
SignInAsync(ClaimsPrincipal, AuthenticationProperties)	处理登录。
SignInAsync(SignInContext)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	注销行为。 (继承自 SignOutAuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	添加对 SignInAsync 的支持 (继承自 AuthenticationHandler<TOptions>)