mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-24 08:57:37 +08:00
440 lines
19 KiB
HTML
440 lines
19 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 OpenIddictValidationDataProtectionBuilder
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OpenIddictValidationDataProtectionBuilder
|
|
">
|
|
<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="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder">
|
|
|
|
|
|
<h1 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder" class="text-break">Class OpenIddictValidationDataProtectionBuilder
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Exposes the necessary methods required to configure the
|
|
OpenIddict ASP.NET Core Data Protection 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">OpenIddictValidationDataProtectionBuilder</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</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.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_OpenIddictValidationDataProtectionBuilder_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class OpenIddictValidationDataProtectionBuilder</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder__ctor_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.#ctor*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder__ctor_IServiceCollection_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.#ctor(IServiceCollection)">OpenIddictValidationDataProtectionBuilder(IServiceCollection)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.html">OpenIddictValidationDataProtectionBuilder</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationDataProtectionBuilder(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="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_Services_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.Services*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_Services" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.Services">Services</h4>
|
|
<div class="markdown level1 summary"><p>Gets the services collection.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IServiceCollection Services { get; }</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">IServiceCollection</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_Configure_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.Configure*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_Configure_System_Action_OpenIddictValidationDataProtectionOptions__" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.Configure(System.Action{OpenIddictValidationDataProtectionOptions})">Configure(Action<OpenIddictValidationDataProtectionOptions>)</h4>
|
|
<div class="markdown level1 summary"><p>Amends the default OpenIddict validation ASP.NET Core Data Protection configuration.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationDataProtectionBuilder Configure(Action<OpenIddictValidationDataProtectionOptions> 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>
|
|
<td><span class="xref">System.Action</span><<span class="xref">OpenIddictValidationDataProtectionOptions</span>></td>
|
|
<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.OpenIddictValidationDataProtectionBuilder.html">OpenIddictValidationDataProtectionBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.html">OpenIddictValidationDataProtectionBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_Configure_System_Action_OpenIddictValidationDataProtectionOptions___remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This extension can be safely called multiple times.</p>
|
|
</div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_Equals_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.Equals*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_Equals_System_Object_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.Equals(System.Object)">Equals(Object)</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 override bool Equals(object obj)</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.Object</span></td>
|
|
<td><span class="parametername">obj</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>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.Equals(System.Object)</span></div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_GetHashCode_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.GetHashCode*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_GetHashCode" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.GetHashCode">GetHashCode()</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 override int GetHashCode()</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><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.GetHashCode()</span></div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_ToString_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.ToString*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_ToString" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.ToString">ToString()</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 override string ToString()</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><span class="xref">System.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.ToString()</span></div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_UseDataProtectionProvider_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.UseDataProtectionProvider*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_UseDataProtectionProvider_IDataProtectionProvider_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.UseDataProtectionProvider(IDataProtectionProvider)">UseDataProtectionProvider(IDataProtectionProvider)</h4>
|
|
<div class="markdown level1 summary"><p>Configures OpenIddict to use a specific data protection provider
|
|
instead of relying on the default instance provided by the DI container.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationDataProtectionBuilder UseDataProtectionProvider(IDataProtectionProvider provider)</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">IDataProtectionProvider</span></td>
|
|
<td><span class="parametername">provider</span></td>
|
|
<td><p>The data protection provider used to create token protectors.</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.OpenIddictValidationDataProtectionBuilder.html">OpenIddictValidationDataProtectionBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.html">OpenIddictValidationDataProtectionBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_UseFormatter_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.UseFormatter*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationDataProtectionBuilder_UseFormatter_IOpenIddictValidationDataProtectionFormatter_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.UseFormatter(IOpenIddictValidationDataProtectionFormatter)">UseFormatter(IOpenIddictValidationDataProtectionFormatter)</h4>
|
|
<div class="markdown level1 summary"><p>Configures OpenIddict to use a specific formatter instead of relying on the default instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationDataProtectionBuilder UseFormatter(IOpenIddictValidationDataProtectionFormatter formatter)</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">IOpenIddictValidationDataProtectionFormatter</span></td>
|
|
<td><span class="parametername">formatter</span></td>
|
|
<td><p>The formatter used to read tokens.</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.OpenIddictValidationDataProtectionBuilder.html">OpenIddictValidationDataProtectionBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationDataProtectionBuilder.html">OpenIddictValidationDataProtectionBuilder</a>.</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>
|