mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-24 18:04:57 +08:00
448 lines
18 KiB
HTML
448 lines
18 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>Interface IOpenIddictApplicationCache<TApplication>
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Interface IOpenIddictApplicationCache<TApplication>
|
|
">
|
|
<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.Abstractions.IOpenIddictApplicationCache`1">
|
|
|
|
|
|
<h1 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1" class="text-break">Interface IOpenIddictApplicationCache<TApplication>
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides methods allowing to cache applications after retrieving them from the store.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Abstractions.html">OpenIddict.Abstractions</a></h6>
|
|
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
|
|
<h5 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public interface IOpenIddictApplicationCache<TApplication>
|
|
where TApplication : 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">TApplication</span></td>
|
|
<td><p>The type of the Application entity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_AddAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.AddAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_AddAsync__0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.AddAsync(`0,CancellationToken)">AddAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Add the specified application to the cache.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask AddAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application to add to the cache.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</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">ValueTask</span></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByClientIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByClientIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByClientIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByClientIdAsync(System.String,CancellationToken)">FindByClientIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves an application using its client identifier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<TApplication> FindByClientIdAsync(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><p>The client identifier associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</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">ValueTask</span><TApplication></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the client application corresponding to the identifier.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByIdAsync(System.String,CancellationToken)">FindByIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves an application using its unique identifier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<TApplication> 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><p>The unique identifier associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</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">ValueTask</span><TApplication></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the client application corresponding to the identifier.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByPostLogoutRedirectUriAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByPostLogoutRedirectUriAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByPostLogoutRedirectUriAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByPostLogoutRedirectUriAsync(System.String,CancellationToken)">FindByPostLogoutRedirectUriAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves all the applications associated with the specified redirect_uri.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<TApplication> FindByPostLogoutRedirectUriAsync(string address, 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">address</span></td>
|
|
<td><p>The redirect_uri associated with the applications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</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">IAsyncEnumerable</span><TApplication></td>
|
|
<td><p>The client applications corresponding to the specified redirect_uri.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByRedirectUriAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByRedirectUriAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_FindByRedirectUriAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.FindByRedirectUriAsync(System.String,CancellationToken)">FindByRedirectUriAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves all the applications associated with the specified redirect_uri.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<TApplication> FindByRedirectUriAsync(string address, 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">address</span></td>
|
|
<td><p>The redirect_uri associated with the applications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</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">IAsyncEnumerable</span><TApplication></td>
|
|
<td><p>The client applications corresponding to the specified redirect_uri.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_RemoveAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.RemoveAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictApplicationCache_1_RemoveAsync__0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictApplicationCache`1.RemoveAsync(`0,CancellationToken)">RemoveAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Removes the specified application from the cache.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask RemoveAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application to remove from the cache.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</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">ValueTask</span></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation.</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>
|