mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-29 01:47:09 +08:00
2410 lines
97 KiB
HTML
2410 lines
97 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 IOpenIddictTokenManager
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Interface IOpenIddictTokenManager
|
|
">
|
|
<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.IOpenIddictTokenManager">
|
|
|
|
|
|
<h1 id="OpenIddict_Abstractions_IOpenIddictTokenManager" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager" class="text-break">Interface IOpenIddictTokenManager
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides methods allowing to manage the tokens stored in the store.
|
|
Note: this interface is not meant to be implemented by custom managers,
|
|
that should inherit from the generic OpenIddictTokenManager class.
|
|
It is primarily intended to be used by services that cannot easily
|
|
depend on the generic token manager. The actual token entity type is
|
|
automatically determined at runtime based on the OpenIddict core options.</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_IOpenIddictTokenManager_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public interface IOpenIddictTokenManager</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_CountAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CountAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_CountAsync_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CountAsync(CancellationToken)">CountAsync(CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines the number of tokens that exist in the database.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<long> CountAsync(CancellationToken cancellationToken = null)</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">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><<span class="xref">System.Int64</span>></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the number of tokens in the database.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_CountAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CountAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_CountAsync__1_System_Func_IQueryable_System_Object__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CountAsync``1(System.Func{IQueryable{System.Object},IQueryable{``0}},CancellationToken)">CountAsync<TResult>(Func<IQueryable<Object>, IQueryable<TResult>>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines the number of tokens that match the specified query.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<long> CountAsync<TResult>(Func<IQueryable<object>, IQueryable<TResult>> query, CancellationToken cancellationToken = null)</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.Func</span><<span class="xref">IQueryable</span><<span class="xref">System.Object</span>>, <span class="xref">IQueryable</span><TResult>></td>
|
|
<td><span class="parametername">query</span></td>
|
|
<td><p>The query to execute.</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><<span class="xref">System.Int64</span>></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the number of tokens that match the specified query.</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">TResult</span></td>
|
|
<td><p>The result type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_CreateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CreateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_CreateAsync_OpenIddict_Abstractions_OpenIddictTokenDescriptor_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CreateAsync(OpenIddict.Abstractions.OpenIddictTokenDescriptor,CancellationToken)">CreateAsync(OpenIddictTokenDescriptor, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new token based on the specified descriptor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<object> CreateAsync(OpenIddictTokenDescriptor descriptor, CancellationToken cancellationToken = null)</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><a class="xref" href="OpenIddict.Abstractions.OpenIddictTokenDescriptor.html">OpenIddictTokenDescriptor</a></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The token descriptor.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation, whose result returns the token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_CreateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CreateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_CreateAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.CreateAsync(System.Object,CancellationToken)">CreateAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask CreateAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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_IOpenIddictTokenManager_DeleteAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.DeleteAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_DeleteAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.DeleteAsync(System.Object,CancellationToken)">DeleteAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Removes an existing token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask DeleteAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token to delete.</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_IOpenIddictTokenManager_FindAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindAsync_System_String_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindAsync(System.String,System.String,CancellationToken)">FindAsync(String, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the tokens corresponding to the specified
|
|
subject and associated with the application identifier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<object> FindAsync(string subject, string client, CancellationToken cancellationToken = null)</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><p>The subject associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">client</span></td>
|
|
<td><p>The client associated with the token.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>The tokens corresponding to the subject/client.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindAsync_System_String_System_String_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindAsync(System.String,System.String,System.String,CancellationToken)">FindAsync(String, String, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the tokens matching the specified parameters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<object> FindAsync(string subject, string client, string status, CancellationToken cancellationToken = null)</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><p>The subject associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">client</span></td>
|
|
<td><p>The client associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">status</span></td>
|
|
<td><p>The token status.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>The tokens corresponding to the criteria.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindAsync_System_String_System_String_System_String_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindAsync(System.String,System.String,System.String,System.String,CancellationToken)">FindAsync(String, String, String, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the tokens matching the specified parameters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<object> FindAsync(string subject, string client, string status, string type, CancellationToken cancellationToken = null)</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><p>The subject associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">client</span></td>
|
|
<td><p>The client associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">status</span></td>
|
|
<td><p>The token status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The token type.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>The tokens corresponding to the criteria.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByApplicationIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByApplicationIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByApplicationIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByApplicationIdAsync(System.String,CancellationToken)">FindByApplicationIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the list of tokens corresponding to the specified application identifier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<object> FindByApplicationIdAsync(string identifier, CancellationToken cancellationToken = null)</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 application identifier associated with the tokens.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>The tokens corresponding to the specified application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByAuthorizationIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByAuthorizationIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByAuthorizationIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByAuthorizationIdAsync(System.String,CancellationToken)">FindByAuthorizationIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the list of tokens corresponding to the specified authorization identifier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<object> FindByAuthorizationIdAsync(string identifier, CancellationToken cancellationToken = null)</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 authorization identifier associated with the tokens.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>The tokens corresponding to the specified authorization.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByIdAsync(System.String,CancellationToken)">FindByIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves a token 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<object> FindByIdAsync(string identifier, CancellationToken cancellationToken = null)</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 token.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the token corresponding to the unique identifier.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByReferenceIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByReferenceIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindByReferenceIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindByReferenceIdAsync(System.String,CancellationToken)">FindByReferenceIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the list of tokens corresponding to the specified reference identifier.
|
|
Note: the reference identifier may be hashed or encrypted for security reasons.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<object> FindByReferenceIdAsync(string identifier, CancellationToken cancellationToken = null)</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 reference identifier associated with the tokens.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the tokens corresponding to the specified reference identifier.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindBySubjectAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindBySubjectAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_FindBySubjectAsync_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.FindBySubjectAsync(System.String,CancellationToken)">FindBySubjectAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the list of tokens corresponding to the specified subject.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<object> FindBySubjectAsync(string subject, CancellationToken cancellationToken = null)</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><p>The subject associated with the tokens.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>The tokens corresponding to the specified subject.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetApplicationIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetApplicationIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetApplicationIdAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetApplicationIdAsync(System.Object,CancellationToken)">GetApplicationIdAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the optional application identifier associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetApplicationIdAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the application identifier associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetAsync__1_System_Func_IQueryable_System_Object__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetAsync``1(System.Func{IQueryable{System.Object},IQueryable{``0}},CancellationToken)">GetAsync<TResult>(Func<IQueryable<Object>, IQueryable<TResult>>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Executes the specified query and returns the first element.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<TResult> GetAsync<TResult>(Func<IQueryable<object>, IQueryable<TResult>> query, CancellationToken cancellationToken = null)</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.Func</span><<span class="xref">IQueryable</span><<span class="xref">System.Object</span>>, <span class="xref">IQueryable</span><TResult>></td>
|
|
<td><span class="parametername">query</span></td>
|
|
<td><p>The query to execute.</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><TResult></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the first element returned when executing the query.</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">TResult</span></td>
|
|
<td><p>The result type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetAsync__2_System_Func_IQueryable_System_Object____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetAsync``2(System.Func{IQueryable{System.Object},``0,IQueryable{``1}},``0,CancellationToken)">GetAsync<TState, TResult>(Func<IQueryable<Object>, TState, IQueryable<TResult>>, TState, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Executes the specified query and returns the first element.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<TResult> GetAsync<TState, TResult>(Func<IQueryable<object>, TState, IQueryable<TResult>> query, TState state, CancellationToken cancellationToken = null)</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.Func</span><<span class="xref">IQueryable</span><<span class="xref">System.Object</span>>, TState, <span class="xref">IQueryable</span><TResult>></td>
|
|
<td><span class="parametername">query</span></td>
|
|
<td><p>The query to execute.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TState</span></td>
|
|
<td><span class="parametername">state</span></td>
|
|
<td><p>The optional state.</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><TResult></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the first element returned when executing the query.</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">TState</span></td>
|
|
<td><p>The state type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResult</span></td>
|
|
<td><p>The result type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetAuthorizationIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetAuthorizationIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetAuthorizationIdAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetAuthorizationIdAsync(System.Object,CancellationToken)">GetAuthorizationIdAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the optional authorization identifier associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetAuthorizationIdAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the authorization identifier associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetCreationDateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetCreationDateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetCreationDateAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetCreationDateAsync(System.Object,CancellationToken)">GetCreationDateAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the creation date associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<DateTimeOffset?> GetCreationDateAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the creation date associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetExpirationDateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetExpirationDateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetExpirationDateAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetExpirationDateAsync(System.Object,CancellationToken)">GetExpirationDateAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the expiration date associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<DateTimeOffset?> GetExpirationDateAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the expiration date associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetIdAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetIdAsync(System.Object,CancellationToken)">GetIdAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the unique identifier associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetIdAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the unique identifier associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetPayloadAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetPayloadAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetPayloadAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetPayloadAsync(System.Object,CancellationToken)">GetPayloadAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the payload associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetPayloadAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the payload associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetPropertiesAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetPropertiesAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetPropertiesAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetPropertiesAsync(System.Object,CancellationToken)">GetPropertiesAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the additional properties associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<ImmutableDictionary<string, JsonElement>> GetPropertiesAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">ImmutableDictionary</span><<span class="xref">System.String</span>, <span class="xref">JsonElement</span>>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns all the additional properties associated with the token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetRedemptionDateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetRedemptionDateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetRedemptionDateAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetRedemptionDateAsync(System.Object,CancellationToken)">GetRedemptionDateAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the redemption date associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<DateTimeOffset?> GetRedemptionDateAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the redemption date associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetReferenceIdAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetReferenceIdAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetReferenceIdAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetReferenceIdAsync(System.Object,CancellationToken)">GetReferenceIdAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the reference identifier associated with a token.
|
|
Note: depending on the manager used to create the token,
|
|
the reference identifier may be hashed for security reasons.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetReferenceIdAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the reference identifier associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetStatusAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetStatusAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetStatusAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetStatusAsync(System.Object,CancellationToken)">GetStatusAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the status associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetStatusAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the status associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetSubjectAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetSubjectAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetSubjectAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetSubjectAsync(System.Object,CancellationToken)">GetSubjectAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the subject associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetSubjectAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the subject associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetTypeAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetTypeAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_GetTypeAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.GetTypeAsync(System.Object,CancellationToken)">GetTypeAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the token type associated with a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<string> GetTypeAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">System.String</span>></td>
|
|
<td><p>A <see cref="!:ValueTask<TResult>"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the token type associated with the specified token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_HasStatusAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.HasStatusAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_HasStatusAsync_System_Object_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.HasStatusAsync(System.Object,System.String,CancellationToken)">HasStatusAsync(Object, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether a given token has the specified status.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<bool> HasStatusAsync(object token, string status, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">status</span></td>
|
|
<td><p>The expected status.</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><<span class="xref">System.Boolean</span>></td>
|
|
<td><p><code>true</code> if the token has the specified status, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_HasTypeAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.HasTypeAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_HasTypeAsync_System_Object_System_String_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.HasTypeAsync(System.Object,System.String,CancellationToken)">HasTypeAsync(Object, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether a given token has the specified type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<bool> HasTypeAsync(object token, string type, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The expected type.</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><<span class="xref">System.Boolean</span>></td>
|
|
<td><p><code>true</code> if the token has the specified type, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_ListAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ListAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_ListAsync_System_Nullable_System_Int32__System_Nullable_System_Int32__CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ListAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},CancellationToken)">ListAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Executes the specified query and returns all the corresponding elements.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<object> ListAsync(int? count = default(int? ), int? offset = default(int? ), CancellationToken cancellationToken = null)</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.Nullable</span><<span class="xref">System.Int32</span>></td>
|
|
<td><span class="parametername">count</span></td>
|
|
<td><p>The number of results to return.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
|
<td><span class="parametername">offset</span></td>
|
|
<td><p>The number of results to skip.</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><<span class="xref">System.Object</span>></td>
|
|
<td><p>All the elements returned when executing the specified query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_ListAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ListAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_ListAsync__1_System_Func_IQueryable_System_Object__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ListAsync``1(System.Func{IQueryable{System.Object},IQueryable{``0}},CancellationToken)">ListAsync<TResult>(Func<IQueryable<Object>, IQueryable<TResult>>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Executes the specified query and returns all the corresponding elements.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<TResult> ListAsync<TResult>(Func<IQueryable<object>, IQueryable<TResult>> query, CancellationToken cancellationToken = null)</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.Func</span><<span class="xref">IQueryable</span><<span class="xref">System.Object</span>>, <span class="xref">IQueryable</span><TResult>></td>
|
|
<td><span class="parametername">query</span></td>
|
|
<td><p>The query to execute.</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><TResult></td>
|
|
<td><p>All the elements returned when executing the specified query.</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">TResult</span></td>
|
|
<td><p>The result type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_ListAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ListAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_ListAsync__2_System_Func_IQueryable_System_Object____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ListAsync``2(System.Func{IQueryable{System.Object},``0,IQueryable{``1}},``0,CancellationToken)">ListAsync<TState, TResult>(Func<IQueryable<Object>, TState, IQueryable<TResult>>, TState, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Executes the specified query and returns all the corresponding elements.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<TResult> ListAsync<TState, TResult>(Func<IQueryable<object>, TState, IQueryable<TResult>> query, TState state, CancellationToken cancellationToken = null)</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.Func</span><<span class="xref">IQueryable</span><<span class="xref">System.Object</span>>, TState, <span class="xref">IQueryable</span><TResult>></td>
|
|
<td><span class="parametername">query</span></td>
|
|
<td><p>The query to execute.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TState</span></td>
|
|
<td><span class="parametername">state</span></td>
|
|
<td><p>The optional state.</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><TResult></td>
|
|
<td><p>All the elements returned when executing the specified query.</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">TState</span></td>
|
|
<td><p>The state type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResult</span></td>
|
|
<td><p>The result type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_PopulateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.PopulateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_PopulateAsync_OpenIddict_Abstractions_OpenIddictTokenDescriptor_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.PopulateAsync(OpenIddict.Abstractions.OpenIddictTokenDescriptor,System.Object,CancellationToken)">PopulateAsync(OpenIddictTokenDescriptor, Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Populates the specified descriptor using the properties exposed by the token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask PopulateAsync(OpenIddictTokenDescriptor descriptor, object token, CancellationToken cancellationToken = null)</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><a class="xref" href="OpenIddict.Abstractions.OpenIddictTokenDescriptor.html">OpenIddictTokenDescriptor</a></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The descriptor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span></td>
|
|
<td><span class="parametername">token</span></td>
|
|
<td><p>The token.</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_IOpenIddictTokenManager_PopulateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.PopulateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_PopulateAsync_System_Object_OpenIddict_Abstractions_OpenIddictTokenDescriptor_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.PopulateAsync(System.Object,OpenIddict.Abstractions.OpenIddictTokenDescriptor,CancellationToken)">PopulateAsync(Object, OpenIddictTokenDescriptor, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Populates the token using the specified descriptor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask PopulateAsync(object token, OpenIddictTokenDescriptor descriptor, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="OpenIddict.Abstractions.OpenIddictTokenDescriptor.html">OpenIddictTokenDescriptor</a></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The descriptor.</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_IOpenIddictTokenManager_PruneAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.PruneAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_PruneAsync_System_DateTimeOffset_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.PruneAsync(System.DateTimeOffset,CancellationToken)">PruneAsync(DateTimeOffset, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Removes the tokens that are marked as invalid or whose attached authorization is no longer valid.
|
|
Only tokens created before the specified <code data-dev-comment-type="paramref" class="paramref">threshold</code> are removed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask PruneAsync(DateTimeOffset threshold, CancellationToken cancellationToken = null)</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.DateTimeOffset</span></td>
|
|
<td><span class="parametername">threshold</span></td>
|
|
<td><p>The date before which tokens are not pruned.</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_IOpenIddictTokenManager_TryRedeemAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.TryRedeemAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_TryRedeemAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.TryRedeemAsync(System.Object,CancellationToken)">TryRedeemAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Tries to redeem a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<bool> TryRedeemAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token to redeem.</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><<span class="xref">System.Boolean</span>></td>
|
|
<td><p><code>true</code> if the token was successfully redemeed, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_TryRejectAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.TryRejectAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_TryRejectAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.TryRejectAsync(System.Object,CancellationToken)">TryRejectAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Tries to reject a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<bool> TryRejectAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token to reject.</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><<span class="xref">System.Boolean</span>></td>
|
|
<td><p><code>true</code> if the token was successfully redemeed, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_TryRevokeAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.TryRevokeAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_TryRevokeAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.TryRevokeAsync(System.Object,CancellationToken)">TryRevokeAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Tries to revoke a token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask<bool> TryRevokeAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token to revoke.</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><<span class="xref">System.Boolean</span>></td>
|
|
<td><p><code>true</code> if the token was successfully revoked, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_IOpenIddictTokenManager_UpdateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.UpdateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_UpdateAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.UpdateAsync(System.Object,CancellationToken)">UpdateAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Updates an existing token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask UpdateAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token to update.</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_IOpenIddictTokenManager_UpdateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.UpdateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_UpdateAsync_System_Object_OpenIddict_Abstractions_OpenIddictTokenDescriptor_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.UpdateAsync(System.Object,OpenIddict.Abstractions.OpenIddictTokenDescriptor,CancellationToken)">UpdateAsync(Object, OpenIddictTokenDescriptor, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Updates an existing token.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">ValueTask UpdateAsync(object token, OpenIddictTokenDescriptor descriptor, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token to update.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="OpenIddict.Abstractions.OpenIddictTokenDescriptor.html">OpenIddictTokenDescriptor</a></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The descriptor used to update the token.</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_IOpenIddictTokenManager_ValidateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ValidateAsync*"></a>
|
|
<h4 id="OpenIddict_Abstractions_IOpenIddictTokenManager_ValidateAsync_System_Object_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictTokenManager.ValidateAsync(System.Object,CancellationToken)">ValidateAsync(Object, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Validates the token to ensure it's in a consistent state.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">IAsyncEnumerable<ValidationResult> ValidateAsync(object token, CancellationToken cancellationToken = null)</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">token</span></td>
|
|
<td><p>The token.</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><<span class="xref">ValidationResult</span>></td>
|
|
<td><p>The validation error encountered when validating the token.</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>
|