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 OpenIddictServerOwinHelpers
< / title >
< meta name = "viewport" content = "width=device-width" >
< meta name = "title" content = "Class OpenIddictServerOwinHelpers
">
< 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 = "Owin.OpenIddictServerOwinHelpers" >
< h1 id = "Owin_OpenIddictServerOwinHelpers" data-uid = "Owin.OpenIddictServerOwinHelpers" class = "text-break" > Class OpenIddictServerOwinHelpers
< / h1 >
< div class = "markdown level0 summary" > < p > Exposes companion extensions for the OpenIddict/OWIN integration.< / 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" > OpenIddictServerOwinHelpers< / span > < / div >
< / div >
< div class = "inheritedMembers" >
< h5 > Inherited Members< / h5 >
< div >
< span class = "xref" > System.Object.Equals(System.Object)< / span >
< / div >
< div >
< span class = "xref" > System.Object.Equals(System.Object, System.Object)< / span >
< / div >
< div >
< span class = "xref" > System.Object.GetHashCode()< / span >
< / div >
< div >
< span class = "xref" > System.Object.GetType()< / span >
< / div >
< div >
< span class = "xref" > System.Object.MemberwiseClone()< / span >
< / div >
< div >
< span class = "xref" > System.Object.ToString()< / span >
< / div >
< div >
< span class = "xref" > System.Object.ReferenceEquals(System.Object, System.Object)< / span >
< / div >
< / div >
< h6 > < strong > Namespace< / strong > : < a class = "xref" href = "Owin.html" > Owin< / a > < / h6 >
< h6 > < strong > Assembly< / strong > : cs.temp.dll.dll< / h6 >
< h5 id = "Owin_OpenIddictServerOwinHelpers_syntax" > Syntax< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static class OpenIddictServerOwinHelpers< / code > < / pre >
< / div >
< h3 id = "methods" > Methods
< / h3 >
< a id = "Owin_OpenIddictServerOwinHelpers_GetOpenIddictServerEndpointType_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOpenIddictServerEndpointType*" > < / a >
< h4 id = "Owin_OpenIddictServerOwinHelpers_GetOpenIddictServerEndpointType_IOwinContext_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOpenIddictServerEndpointType(IOwinContext)" > GetOpenIddictServerEndpointType(IOwinContext)< / h4 >
2021-01-24 16:39:56 +08:00
< div class = "markdown level1 summary" > < p > Retrieves the < see cref = "!:OpenIddictServerEndpointType" > < / see > instance stored in < see cref = "!:BaseContext" > < / see > .< / p >
2021-01-18 02:24:47 +08:00
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static OpenIddictServerEndpointType GetOpenIddictServerEndpointType(this IOwinContext context)< / 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" > IOwinContext< / span > < / td >
< td > < span class = "parametername" > context< / span > < / td >
< td > < p > The context instance.< / p >
< / 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 >
< td > < span class = "xref" > OpenIddictServerEndpointType< / span > < / td >
< td > < p > The < see cref = "!:OpenIddictServerEndpointType" > < / see > .< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "Owin_OpenIddictServerOwinHelpers_GetOpenIddictServerRequest_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOpenIddictServerRequest*" > < / a >
< h4 id = "Owin_OpenIddictServerOwinHelpers_GetOpenIddictServerRequest_IOwinContext_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOpenIddictServerRequest(IOwinContext)" > GetOpenIddictServerRequest(IOwinContext)< / h4 >
2021-01-24 16:39:56 +08:00
< div class = "markdown level1 summary" > < p > Retrieves the < see cref = "!:OpenIddictRequest" > < / see > instance stored in < see cref = "!:BaseContext" > < / see > .< / p >
2021-01-18 02:24:47 +08:00
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static OpenIddictRequest? GetOpenIddictServerRequest(this IOwinContext context)< / 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" > IOwinContext< / span > < / td >
< td > < span class = "parametername" > context< / span > < / td >
< td > < p > The context instance.< / p >
< / 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 >
< td > < span class = "xref" > System.Nullable< / span > < < span class = "xref" > OpenIddictRequest< / span > > < / td >
< td > < p > The < see cref = "!:OpenIddictRequest" > < / see > instance or < code > null< / code > if it couldn' t be found.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "Owin_OpenIddictServerOwinHelpers_GetOpenIddictServerResponse_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOpenIddictServerResponse*" > < / a >
< h4 id = "Owin_OpenIddictServerOwinHelpers_GetOpenIddictServerResponse_IOwinContext_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOpenIddictServerResponse(IOwinContext)" > GetOpenIddictServerResponse(IOwinContext)< / h4 >
2021-01-24 16:39:56 +08:00
< div class = "markdown level1 summary" > < p > Retrieves the < see cref = "!:OpenIddictResponse" > < / see > instance stored in < see cref = "!:BaseContext" > < / see > .< / p >
2021-01-18 02:24:47 +08:00
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static OpenIddictResponse? GetOpenIddictServerResponse(this IOwinContext context)< / 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" > IOwinContext< / span > < / td >
< td > < span class = "parametername" > context< / span > < / td >
< td > < p > The context instance.< / p >
< / 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 >
< td > < span class = "xref" > System.Nullable< / span > < < span class = "xref" > OpenIddictResponse< / span > > < / td >
< td > < p > The < see cref = "!:OpenIddictResponse" > < / see > instance or < code > null< / code > if it couldn' t be found.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "Owin_OpenIddictServerOwinHelpers_GetOwinRequest_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOwinRequest*" > < / a >
< h4 id = "Owin_OpenIddictServerOwinHelpers_GetOwinRequest_OpenIddictServerTransaction_" data-uid = "Owin.OpenIddictServerOwinHelpers.GetOwinRequest(OpenIddictServerTransaction)" > GetOwinRequest(OpenIddictServerTransaction)< / h4 >
< div class = "markdown level1 summary" > < p > Retrieves the < see cref = "!:IOwinRequest" > < / see > instance stored in the < see cref = "!:OpenIddictServerTransaction" > < / see > properties.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static IOwinRequest? GetOwinRequest(this OpenIddictServerTransaction transaction)< / 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" > OpenIddictServerTransaction< / span > < / td >
< td > < span class = "parametername" > transaction< / span > < / td >
< td > < p > The transaction instance.< / p >
< / 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 >
< td > < span class = "xref" > System.Nullable< / span > < < span class = "xref" > IOwinRequest< / span > > < / td >
< td > < p > The < see cref = "!:IOwinRequest" > < / see > instance or < code > null< / code > if it couldn' t be found.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< a id = "Owin_OpenIddictServerOwinHelpers_UseOpenIddictServer_" data-uid = "Owin.OpenIddictServerOwinHelpers.UseOpenIddictServer*" > < / a >
< h4 id = "Owin_OpenIddictServerOwinHelpers_UseOpenIddictServer_IAppBuilder_" data-uid = "Owin.OpenIddictServerOwinHelpers.UseOpenIddictServer(IAppBuilder)" > UseOpenIddictServer(IAppBuilder)< / h4 >
< div class = "markdown level1 summary" > < p > Registers the OpenIddict server OWIN middleware in the application pipeline.
Note: when using a dependency injection container supporting per-request
middleware resolution (like Autofac), calling this method is NOT recommended.< / p >
< / div >
< div class = "markdown level1 conceptual" > < / div >
< h5 class = "decalaration" > Declaration< / h5 >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static IAppBuilder UseOpenIddictServer(this IAppBuilder app)< / 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" > IAppBuilder< / span > < / td >
< td > < span class = "parametername" > app< / span > < / td >
< td > < p > The application builder used to register middleware instances.< / p >
< / 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 >
< td > < span class = "xref" > IAppBuilder< / span > < / td >
< td > < p > The < see cref = "!:IAppBuilder" > < / see > .< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / 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 >
