2021-01-18 02:24:47 +08:00
<!DOCTYPE html>
<!-- [if IE]><![endif] -->
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge,chrome=1" >
< title > Class OpenIddictServerAspNetCoreHandler
< / title >
< meta name = "viewport" content = "width=device-width" >
< meta name = "title" content = "Class OpenIddictServerAspNetCoreHandler
">
< meta name = "generator" content = "docfx 2.56.6.0" >
< link rel = "shortcut icon" href = "../images/favicon.ico" >
< link rel = "stylesheet" href = "../styles/docfx.vendor.css" >
< link rel = "stylesheet" href = "../styles/docfx.css" >
< link rel = "stylesheet" href = "../styles/main.css" >
< link href = "https://fonts.googleapis.com/css?family=Roboto" rel = "stylesheet" >
< meta property = "docfx:navrel" content = "../toc.html" >
< meta property = "docfx:tocrel" content = "toc.html" >
< / head > < body data-spy = "scroll" data-target = "#affix" data-offset = "120" >
< div id = "wrapper" >
< header >
< nav id = "autocollapse" class = "navbar navbar-inverse ng-scope" role = "navigation" >
< div class = "container" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = "#navbar" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "../index.html" >
< img id = "logo" class = "svg" src = "../images/logo.png" alt = "" >
< / a > < / div >
< div class = "collapse navbar-collapse" id = "navbar" >
< form class = "navbar-form navbar-right" role = "search" id = "search" >
< div class = "form-group" >
< input type = "text" class = "form-control" id = "search-query" placeholder = "Search" autocomplete = "off" >
< / div >
< / form >
< / div >
< / div >
< / nav >
< div class = "subnav navbar navbar-default" >
< div class = "container hide-when-search" id = "breadcrumb" >
< ul class = "breadcrumb" >
< li > < / li >
< / ul >
< / div >
< / div >
< / header >
< div role = "main" class = "container body-content hide-when-search" >
< div class = "sidenav hide-when-search" >
< a class = "btn toc-toggle collapse" data-toggle = "collapse" href = "#sidetoggle" aria-expanded = "false" aria-controls = "sidetoggle" > Show / Hide Table of Contents< / a >
< div class = "sidetoggle collapse" id = "sidetoggle" >
< div id = "sidetoc" > < / div >
< / div >
< / div >
< div class = "article row grid-right" >
< div class = "col-md-10" >
< article class = "content wrap" id = "_content" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler" >
< h1 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler" class = "text-break" > Class OpenIddictServerAspNetCoreHandler
< / h1 >
< div class = "markdown level0 summary" > < p > Provides the logic necessary to extract, validate and handle OpenID Connect requests.< / p >
< / div >
< div class = "markdown level0 conceptual" > < / div >
< div class = "inheritance" >
< h5 > Inheritance< / h5 >
< div class = "level0" > < span class = "xref" > System.Object< / span > < / div >
< div class = "level1" > < span class = "xref" > OpenIddictServerAspNetCoreHandler< / span > < / div >
< / div >
< div classs = "implements" >
< h5 > Implements< / h5 >
< div > < span class = "xref" > IAuthenticationRequestHandler< / span > < / div >
< div > < span class = "xref" > IAuthenticationSignInHandler< / span > < / div >
< div > < span class = "xref" > IAuthenticationSignOutHandler< / span > < / div >
< / div >
< h6 > < strong > Namespace< / strong > : < a class = "xref" href = "OpenIddict.Server.AspNetCore.html" > OpenIddict.Server.AspNetCore< / a > < / h6 >
< h6 > < strong > Assembly< / strong > : cs.temp.dll.dll< / h6 >
< h5 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_syntax" > Syntax< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public class OpenIddictServerAspNetCoreHandler : AuthenticationHandler< OpenIddictServerAspNetCoreOptions> , IAuthenticationRequestHandler, IAuthenticationSignInHandler, IAuthenticationSignOutHandler< / code > < / pre >
< / div >
< h3 id = "constructors" > Constructors
< / h3 >
< a id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler__ctor_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.#ctor*" > < / a >
< h4 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler__ctor_OpenIddict_Server_IOpenIddictServerDispatcher_OpenIddict_Server_IOpenIddictServerFactory_IOptionsMonitor_OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions__ILoggerFactory_UrlEncoder_ISystemClock_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.#ctor(OpenIddict.Server.IOpenIddictServerDispatcher,OpenIddict.Server.IOpenIddictServerFactory,IOptionsMonitor{OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions},ILoggerFactory,UrlEncoder,ISystemClock)" > OpenIddictServerAspNetCoreHandler(IOpenIddictServerDispatcher, IOpenIddictServerFactory, IOptionsMonitor< OpenIddictServerAspNetCoreOptions> , ILoggerFactory, UrlEncoder, ISystemClock)< / h4 >
< div class = "markdown level1 summary" > < p > Creates a new instance of the < a class = "xref" href = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.html" > OpenIddictServerAspNetCoreHandler< / a > class.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public OpenIddictServerAspNetCoreHandler(IOpenIddictServerDispatcher dispatcher, IOpenIddictServerFactory factory, IOptionsMonitor< OpenIddictServerAspNetCoreOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < a class = "xref" href = "OpenIddict.Server.IOpenIddictServerDispatcher.html" > IOpenIddictServerDispatcher< / a > < / td >
< td > < span class = "parametername" > dispatcher< / span > < / td >
< td > < / td >
< / tr >
< tr >
< td > < a class = "xref" href = "OpenIddict.Server.IOpenIddictServerFactory.html" > IOpenIddictServerFactory< / a > < / td >
< td > < span class = "parametername" > factory< / span > < / td >
< td > < / td >
< / tr >
< tr >
< td > < span class = "xref" > IOptionsMonitor< / span > < < a class = "xref" href = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.html" > OpenIddictServerAspNetCoreOptions< / a > > < / td >
< td > < span class = "parametername" > options< / span > < / td >
< td > < / td >
< / tr >
< tr >
< td > < span class = "xref" > ILoggerFactory< / span > < / td >
< td > < span class = "parametername" > logger< / span > < / td >
< td > < / td >
< / tr >
< tr >
< td > < span class = "xref" > UrlEncoder< / span > < / td >
< td > < span class = "parametername" > encoder< / span > < / td >
< td > < / td >
< / tr >
< tr >
< td > < span class = "xref" > ISystemClock< / span > < / td >
< td > < span class = "parametername" > clock< / span > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< h3 id = "methods" > Methods
< / h3 >
< a id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleAuthenticateAsync_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleAuthenticateAsync*" > < / a >
< h4 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleAuthenticateAsync" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleAuthenticateAsync" > HandleAuthenticateAsync()< / h4 >
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > protected override Task< AuthenticateResult> HandleAuthenticateAsync()< / code > < / pre >
< / div >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > Task< / span > < < span class = "xref" > AuthenticateResult< / span > > < / td >
2021-01-18 02:24:47 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleChallengeAsync_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleChallengeAsync*" > < / a >
< h4 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleChallengeAsync_System_Nullable_AuthenticationProperties__" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleChallengeAsync(System.Nullable{AuthenticationProperties})" > HandleChallengeAsync(Nullable< AuthenticationProperties> )< / h4 >
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > protected override Task HandleChallengeAsync(AuthenticationProperties? properties)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Nullable< / span > < < span class = "xref" > AuthenticationProperties< / span > > < / td >
< td > < span class = "parametername" > properties< / span > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > Task< / span > < / td >
2021-01-18 02:24:47 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleForbiddenAsync_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleForbiddenAsync*" > < / a >
< h4 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleForbiddenAsync_System_Nullable_AuthenticationProperties__" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleForbiddenAsync(System.Nullable{AuthenticationProperties})" > HandleForbiddenAsync(Nullable< AuthenticationProperties> )< / h4 >
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > protected override Task HandleForbiddenAsync(AuthenticationProperties? properties)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Nullable< / span > < < span class = "xref" > AuthenticationProperties< / span > > < / td >
< td > < span class = "parametername" > properties< / span > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > Task< / span > < / td >
2021-01-18 02:24:47 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleRequestAsync_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleRequestAsync*" > < / a >
< h4 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_HandleRequestAsync" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.HandleRequestAsync" > HandleRequestAsync()< / h4 >
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public Task< bool> HandleRequestAsync()< / code > < / pre >
< / div >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > Task< / span > < < span class = "xref" > System.Boolean< / span > > < / td >
2021-01-18 02:24:47 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_SignInAsync_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.SignInAsync*" > < / a >
< h4 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_SignInAsync_ClaimsPrincipal_System_Nullable_AuthenticationProperties__" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.SignInAsync(ClaimsPrincipal,System.Nullable{AuthenticationProperties})" > SignInAsync(ClaimsPrincipal, Nullable< AuthenticationProperties> )< / h4 >
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public Task SignInAsync(ClaimsPrincipal user, AuthenticationProperties? properties)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > ClaimsPrincipal< / span > < / td >
< td > < span class = "parametername" > user< / span > < / td >
< td > < / td >
< / tr >
< tr >
< td > < span class = "xref" > System.Nullable< / span > < < span class = "xref" > AuthenticationProperties< / span > > < / td >
< td > < span class = "parametername" > properties< / span > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > Task< / span > < / td >
2021-01-18 02:24:47 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< a id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_SignOutAsync_" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.SignOutAsync*" > < / a >
< h4 id = "OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreHandler_SignOutAsync_System_Nullable_AuthenticationProperties__" data-uid = "OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandler.SignOutAsync(System.Nullable{AuthenticationProperties})" > SignOutAsync(Nullable< AuthenticationProperties> )< / h4 >
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public Task SignOutAsync(AuthenticationProperties? properties)< / code > < / pre >
< / div >
< h5 class = "parameters" > Parameters< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "xref" > System.Nullable< / span > < < span class = "xref" > AuthenticationProperties< / span > > < / td >
< td > < span class = "parametername" > properties< / span > < / td >
< td > < / td >
< / tr >
< / tbody >
< / table >
< h5 class = "returns" > Returns< / h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-01-24 16:39:56 +08:00
< td > < span class = "xref" > Task< / span > < / td >
2021-01-18 02:24:47 +08:00
< td > < / td >
< / tr >
< / tbody >
< / table >
< h3 id = "implements" > Implements< / h3 >
< div >
< span class = "xref" > IAuthenticationRequestHandler< / span >
< / div >
< div >
< span class = "xref" > IAuthenticationSignInHandler< / span >
< / div >
< div >
< span class = "xref" > IAuthenticationSignOutHandler< / span >
< / div >
< / article >
< / div >
< div class = "hidden-sm col-md-2" role = "complementary" >
< div class = "sideaffix" >
< div class = "contribution" >
< ul class = "nav" >
< / ul >
< / div >
< nav class = "bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id = "affix" >
< h5 > In This Article< / h5 >
< div > < / div >
< / nav >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "grad-bottom" > < / div >
< div class = "footer" >
< div class = "container" >
< span class = "pull-right" >
< a href = "#top" > Back to top< / a >
< / span >
< span > Generated by < strong > DocFX< / strong > < / span >
< / div >
< / div >
< / footer >
< / div >
< script type = "text/javascript" src = "../styles/docfx.vendor.js" > < / script >
< script type = "text/javascript" src = "../styles/docfx.js" > < / script >
< script type = "text/javascript" src = "../styles/main.js" > < / script >
< / body >
< / html >
