mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-07-15 05:13:19 +08:00
348 lines
14 KiB
HTML
348 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class OpenIddictCoreOptions
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OpenIddictCoreOptions
|
|
">
|
|
<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.Core.OpenIddictCoreOptions">
|
|
|
|
|
|
<h1 id="OpenIddict_Core_OpenIddictCoreOptions" data-uid="OpenIddict.Core.OpenIddictCoreOptions" class="text-break">Class OpenIddictCoreOptions
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides various settings needed to configure the OpenIddict core 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">OpenIddictCoreOptions</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="OpenIddict.Core.html">OpenIddict.Core</a></h6>
|
|
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
|
|
<h5 id="OpenIddict_Core_OpenIddictCoreOptions_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class OpenIddictCoreOptions</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictCoreOptions_DefaultApplicationType_" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultApplicationType*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictCoreOptions_DefaultApplicationType" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultApplicationType">DefaultApplicationType</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the type corresponding to the default Application entity,
|
|
used by the non-generic application manager and the server/validation services.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Type? DefaultApplicationType { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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">Type</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictCoreOptions_DefaultAuthorizationType_" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultAuthorizationType*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictCoreOptions_DefaultAuthorizationType" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultAuthorizationType">DefaultAuthorizationType</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the type corresponding to the default Authorization entity,
|
|
used by the non-generic authorization manager and the server/validation services.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Type? DefaultAuthorizationType { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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">Type</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictCoreOptions_DefaultScopeType_" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultScopeType*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictCoreOptions_DefaultScopeType" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultScopeType">DefaultScopeType</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the type corresponding to the default Scope entity,
|
|
used by the non-generic scope manager and the server/validation services.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Type? DefaultScopeType { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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">Type</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictCoreOptions_DefaultTokenType_" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultTokenType*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictCoreOptions_DefaultTokenType" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DefaultTokenType">DefaultTokenType</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the type corresponding to the default Token entity,
|
|
used by the non-generic token manager and the server/validation services.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Type? DefaultTokenType { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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">Type</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictCoreOptions_DisableAdditionalFiltering_" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DisableAdditionalFiltering*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictCoreOptions_DisableAdditionalFiltering" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DisableAdditionalFiltering">DisableAdditionalFiltering</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether additional filtering should be disabled,
|
|
so that the OpenIddict managers don't execute a second check to ensure the results
|
|
returned by the stores exactly match the specified query filters, casing included.
|
|
This property SHOULD NOT be set to <code>true</code> except when the underlying stores
|
|
are guaranteed to execute case-sensitive filtering at the database level.
|
|
Disabling this feature MAY result in security vulnerabilities in the other cases.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool DisableAdditionalFiltering { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictCoreOptions_DisableEntityCaching_" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DisableEntityCaching*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictCoreOptions_DisableEntityCaching" data-uid="OpenIddict.Core.OpenIddictCoreOptions.DisableEntityCaching">DisableEntityCaching</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether entity caching should be disabled.
|
|
Disabling entity caching may have a noticeable impact on the performance
|
|
of your application and result in multiple queries being sent by the stores.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool DisableEntityCaching { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictCoreOptions_EntityCacheLimit_" data-uid="OpenIddict.Core.OpenIddictCoreOptions.EntityCacheLimit*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictCoreOptions_EntityCacheLimit" data-uid="OpenIddict.Core.OpenIddictCoreOptions.EntityCacheLimit">EntityCacheLimit</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the maximum number of cached entries allowed. When the threshold
|
|
is reached, the cache is automatically compacted to ensure it doesn't grow
|
|
abnormally and doesn't cause a memory starvation or out-of-memory exceptions.
|
|
This property is not used when <a class="xref" href="OpenIddict.Core.OpenIddictCoreOptions.html#OpenIddict_Core_OpenIddictCoreOptions_DisableEntityCaching">DisableEntityCaching</a> is <code>true</code>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int EntityCacheLimit { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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.Int32</span></td>
|
|
<td></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>
|