2021-01-17 18:24:47 +00: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 OpenIddictEntityFrameworkBuilder
</ title >
< meta name = "viewport" content = "width=device-width" >
< meta name = "title" content = "Class OpenIddictEntityFrameworkBuilder
" >
2021-04-09 10:51:20 +00:00
< meta name = "generator" content = "docfx 2.56.7.0" >
2021-01-17 18:24:47 +00:00
< 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 = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder" >
< h1 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder" class = "text-break" > Class OpenIddictEntityFrameworkBuilder
</ h1 >
< div class = "markdown level0 summary" >< p > Exposes the necessary methods required to configure the OpenIddict Entity Framework 6.x services.</ 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" > OpenIddictEntityFrameworkBuilder</ span ></ div >
</ div >
< div class = "inheritedMembers" >
< h5 > Inherited Members</ h5 >
2021-04-09 10:51:20 +00:00
< div >
< span class = "xref" > System.Object.Equals(System.Object)</ span >
</ div >
2021-01-17 18:24:47 +00:00
< div >
< span class = "xref" > System.Object.Equals(System.Object, System.Object)</ span >
</ div >
2021-04-09 10:51:20 +00:00
< div >
< span class = "xref" > System.Object.GetHashCode()</ span >
</ div >
2021-01-17 18:24:47 +00:00
< div >
< span class = "xref" > System.Object.GetType()</ span >
</ div >
< div >
< span class = "xref" > System.Object.MemberwiseClone()</ span >
</ div >
2021-04-09 10:51:20 +00:00
< div >
< span class = "xref" > System.Object.ToString()</ span >
</ div >
2021-01-17 18:24:47 +00:00
< div >
< span class = "xref" > System.Object.ReferenceEquals(System.Object, System.Object)</ span >
</ div >
</ div >
< h6 >< strong > Namespace</ strong > : < a class = "xref" href = "Microsoft.Extensions.DependencyInjection.html" > Microsoft.Extensions.DependencyInjection</ a ></ h6 >
< h6 >< strong > Assembly</ strong > : cs.temp.dll.dll</ h6 >
< h5 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_syntax" > Syntax</ h5 >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public class OpenIddictEntityFrameworkBuilder</ code ></ pre >
</ div >
< h3 id = "constructors" > Constructors
</ h3 >
< a id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder__ctor_" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.#ctor*" ></ a >
< h4 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder__ctor_IServiceCollection_" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.#ctor(IServiceCollection)" > OpenIddictEntityFrameworkBuilder(IServiceCollection)</ h4 >
< div class = "markdown level1 summary" >< p > Initializes a new instance of < a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a > .</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< h5 class = "decalaration" > Declaration</ h5 >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public OpenIddictEntityFrameworkBuilder(IServiceCollection services)</ 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" > IServiceCollection</ span ></ td >
< td >< span class = "parametername" > services</ span ></ td >
< td >< p > The services collection.</ p >
</ td >
</ tr >
</ tbody >
</ table >
< h3 id = "methods" > Methods
</ h3 >
< a id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_Configure_" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.Configure*" ></ a >
2021-02-12 17:16:04 +00:00
< h4 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_Configure_System_Action_OpenIddictEntityFrameworkOptions__" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.Configure(System.Action{OpenIddictEntityFrameworkOptions})" > Configure(Action< OpenIddictEntityFrameworkOptions> )</ h4 >
2021-01-17 18:24:47 +00:00
< div class = "markdown level1 summary" >< p > Amends the default OpenIddict Entity Framework 6.x configuration.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< h5 class = "decalaration" > Declaration</ h5 >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public OpenIddictEntityFrameworkBuilder Configure(Action< OpenIddictEntityFrameworkOptions> configuration)</ 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 >
2021-02-12 17:16:04 +00:00
< td >< span class = "xref" > System.Action</ span > < < span class = "xref" > OpenIddictEntityFrameworkOptions</ span > > </ td >
2021-01-17 18:24:47 +00:00
< td >< span class = "parametername" > configuration</ span ></ td >
< td >< p > The delegate used to configure the OpenIddict options.</ 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 >< a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a ></ td >
< td >< p > The < a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a > .</ p >
</ td >
</ tr >
</ tbody >
</ table >
2021-02-12 17:16:04 +00:00
< h5 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_Configure_System_Action_OpenIddictEntityFrameworkOptions___remarks" > Remarks</ h5 >
2021-01-17 18:24:47 +00:00
< div class = "markdown level1 remarks" >< p > This extension can be safely called multiple times.</ p >
</ div >
< a id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_ReplaceDefaultEntities_" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.ReplaceDefaultEntities*" ></ a >
< h4 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_ReplaceDefaultEntities__5" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.ReplaceDefaultEntities``5" > ReplaceDefaultEntities< TApplication, TAuthorization, TScope, TToken, TKey> ()</ h4 >
< div class = "markdown level1 summary" >< p > Configures OpenIddict to use the specified entities, derived
from the default OpenIddict Entity Framework 6.x entities.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< h5 class = "decalaration" > Declaration</ h5 >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public OpenIddictEntityFrameworkBuilder ReplaceDefaultEntities< TApplication, TAuthorization, TScope, TToken, TKey> ()
where TApplication : OpenIddictEntityFrameworkApplication< TKey, TAuthorization, TToken> where TAuthorization : OpenIddictEntityFrameworkAuthorization< TKey, TApplication, TToken> where TScope : OpenIddictEntityFrameworkScope< TKey> where TToken : OpenIddictEntityFrameworkToken< TKey, TApplication, TAuthorization> where TKey : IEquatable< TKey> </ 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 >
< td >< a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a ></ td >
< td >< p > The < a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a > .</ p >
</ td >
</ tr >
</ tbody >
</ table >
< h5 class = "typeParameters" > Type Parameters</ h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Name</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr >
< td >< span class = "parametername" > TApplication</ span ></ td >
< td ></ td >
</ tr >
< tr >
< td >< span class = "parametername" > TAuthorization</ span ></ td >
< td ></ td >
</ tr >
< tr >
< td >< span class = "parametername" > TScope</ span ></ td >
< td ></ td >
</ tr >
< tr >
< td >< span class = "parametername" > TToken</ span ></ td >
< td ></ td >
</ tr >
< tr >
< td >< span class = "parametername" > TKey</ span ></ td >
< td ></ td >
</ tr >
</ tbody >
</ table >
< a id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_UseDbContext_" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.UseDbContext*" ></ a >
2021-02-12 17:16:04 +00:00
< h4 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_UseDbContext_System_Type_" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.UseDbContext(System.Type)" > UseDbContext(Type)</ h4 >
2021-01-17 18:24:47 +00:00
< div class = "markdown level1 summary" >< p > Configures the OpenIddict Entity Framework 6.x stores to use the specified database context type.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< h5 class = "decalaration" > Declaration</ h5 >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public OpenIddictEntityFrameworkBuilder UseDbContext(Type type)</ 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 >
2021-02-12 17:16:04 +00:00
< td >< span class = "xref" > System.Type</ span ></ td >
2021-01-17 18:24:47 +00:00
< td >< span class = "parametername" > type</ span ></ td >
< td >< p > The type of the < see cref = "!:DbContext" ></ see > used by OpenIddict.</ 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 >< a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a ></ td >
< td >< p > The < a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a > .</ p >
</ td >
</ tr >
</ tbody >
</ table >
< a id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_UseDbContext_" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.UseDbContext*" ></ a >
< h4 id = "Microsoft_Extensions_DependencyInjection_OpenIddictEntityFrameworkBuilder_UseDbContext__1" data-uid = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.UseDbContext``1" > UseDbContext< TContext> ()</ h4 >
< div class = "markdown level1 summary" >< p > Configures the OpenIddict Entity Framework 6.x stores to use the specified database context type.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< h5 class = "decalaration" > Declaration</ h5 >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public OpenIddictEntityFrameworkBuilder UseDbContext< TContext> ()
where TContext : DbContext</ 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 >
< td >< a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a ></ td >
< td >< p > The < a class = "xref" href = "Microsoft.Extensions.DependencyInjection.OpenIddictEntityFrameworkBuilder.html" > OpenIddictEntityFrameworkBuilder</ a > .</ p >
</ td >
</ tr >
</ tbody >
</ table >
< h5 class = "typeParameters" > Type Parameters</ h5 >
< table class = "table table-bordered table-striped table-condensed" >
< thead >
< tr >
< th > Name</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr >
< td >< span class = "parametername" > TContext</ span ></ td >
< td >< p > The type of the < see cref = "!:DbContext" ></ see > used by OpenIddict.</ 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 >