openiddict-documentation/api/OpenIddict.Core.OpenIddictTokenCache-1.html
2021-01-17 18:24:47 +00:00

555 lines
21 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 OpenIddictTokenCache&lt;TToken&gt;
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class OpenIddictTokenCache&lt;TToken&gt;
">
<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.OpenIddictTokenCache`1">
<h1 id="OpenIddict_Core_OpenIddictTokenCache_1" data-uid="OpenIddict.Core.OpenIddictTokenCache`1" class="text-break">Class OpenIddictTokenCache&lt;TToken&gt;
</h1>
<div class="markdown level0 summary"><p>Provides methods allowing to cache tokens after retrieving them from the store.</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">OpenIddictTokenCache&lt;TToken&gt;</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</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_OpenIddictTokenCache_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class OpenIddictTokenCache&lt;TToken&gt; : IOpenIddictTokenCache&lt;TToken&gt;, IDisposable where TToken : class</code></pre>
</div>
<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">TToken</span></td>
<td><p>The type of the Token entity.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="constructors">Constructors
</h3>
<a id="OpenIddict_Core_OpenIddictTokenCache_1__ctor_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.#ctor*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1__ctor_IOptionsMonitor_OpenIddict_Core_OpenIddictCoreOptions__IOpenIddictTokenStoreResolver_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.#ctor(IOptionsMonitor{OpenIddict.Core.OpenIddictCoreOptions},IOpenIddictTokenStoreResolver)">OpenIddictTokenCache(IOptionsMonitor&lt;OpenIddictCoreOptions&gt;, IOpenIddictTokenStoreResolver)</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 OpenIddictTokenCache(IOptionsMonitor&lt;OpenIddictCoreOptions&gt; options, IOpenIddictTokenStoreResolver resolver)</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">IOptionsMonitor</span>&lt;<a class="xref" href="OpenIddict.Core.OpenIddictCoreOptions.html">OpenIddictCoreOptions</a>&gt;</td>
<td><span class="parametername">options</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">IOpenIddictTokenStoreResolver</span></td>
<td><span class="parametername">resolver</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_AddAsync_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.AddAsync*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_AddAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.AddAsync(`0,CancellationToken)">AddAsync(TToken, CancellationToken)</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 ValueTask AddAsync(TToken token, CancellationToken cancellationToken)</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">TToken</span></td>
<td><span class="parametername">token</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</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.Threading.Tasks.ValueTask</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_Dispose_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.Dispose*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_Dispose" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.Dispose">Dispose()</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 void Dispose()</code></pre>
</div>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_FindAsync_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindAsync*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_FindAsync_System_String_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindAsync(System.String,System.String,CancellationToken)">FindAsync(String, String, CancellationToken)</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 IAsyncEnumerable&lt;TToken&gt; FindAsync(string subject, string client, CancellationToken cancellationToken)</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.String</span></td>
<td><span class="parametername">subject</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">client</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</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.Collections.Generic.IAsyncEnumerable</span>&lt;TToken&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_FindAsync_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindAsync*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_FindAsync_System_String_System_String_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindAsync(System.String,System.String,System.String,CancellationToken)">FindAsync(String, String, String, CancellationToken)</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 IAsyncEnumerable&lt;TToken&gt; FindAsync(string subject, string client, string status, CancellationToken cancellationToken)</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.String</span></td>
<td><span class="parametername">subject</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">client</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">status</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</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.Collections.Generic.IAsyncEnumerable</span>&lt;TToken&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_FindAsync_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindAsync*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_FindAsync_System_String_System_String_System_String_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindAsync(System.String,System.String,System.String,System.String,CancellationToken)">FindAsync(String, String, String, String, CancellationToken)</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 IAsyncEnumerable&lt;TToken&gt; FindAsync(string subject, string client, string status, string type, CancellationToken cancellationToken)</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.String</span></td>
<td><span class="parametername">subject</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">client</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">status</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">type</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</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.Collections.Generic.IAsyncEnumerable</span>&lt;TToken&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_FindByApplicationIdAsync_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindByApplicationIdAsync*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_FindByApplicationIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindByApplicationIdAsync(System.String,CancellationToken)">FindByApplicationIdAsync(String, CancellationToken)</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 IAsyncEnumerable&lt;TToken&gt; FindByApplicationIdAsync(string identifier, CancellationToken cancellationToken)</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.String</span></td>
<td><span class="parametername">identifier</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</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.Collections.Generic.IAsyncEnumerable</span>&lt;TToken&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_FindByAuthorizationIdAsync_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindByAuthorizationIdAsync*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_FindByAuthorizationIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindByAuthorizationIdAsync(System.String,CancellationToken)">FindByAuthorizationIdAsync(String, CancellationToken)</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 IAsyncEnumerable&lt;TToken&gt; FindByAuthorizationIdAsync(string identifier, CancellationToken cancellationToken)</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.String</span></td>
<td><span class="parametername">identifier</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</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.Collections.Generic.IAsyncEnumerable</span>&lt;TToken&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Core_OpenIddictTokenCache_1_FindByIdAsync_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindByIdAsync*"></a>
<h4 id="OpenIddict_Core_OpenIddictTokenCache_1_FindByIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictTokenCache`1.FindByIdAsync(System.String,CancellationToken)">FindByIdAsync(String, CancellationToken)</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 ValueTask&lt;TToken&gt; FindByIdAsync(string identifier, CancellationToken cancellationToken)</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.String</span></td>
<td><span class="parametername">identifier</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</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.Threading.Tasks.ValueTask</span>&lt;TToken&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</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>