mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-29 01:47:09 +08:00
2655 lines
109 KiB
HTML
2655 lines
109 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class OpenIddictApplicationManager<TApplication>
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OpenIddictApplicationManager<TApplication>
|
|
">
|
|
<meta name="generator" content="docfx 2.56.6.0">
|
|
|
|
<link rel="shortcut icon" href="../images/favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../images/logo.png" alt="">
|
|
</a> </div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1">
|
|
|
|
|
|
<h1 id="OpenIddict_Core_OpenIddictApplicationManager_1" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1" class="text-break">Class OpenIddictApplicationManager<TApplication>
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides methods allowing to manage the applications stored in the store.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">OpenIddictApplicationManager<TApplication></span></div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Core.html">OpenIddict.Core</a></h6>
|
|
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
|
|
<h5 id="OpenIddict_Core_OpenIddictApplicationManager_1_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class OpenIddictApplicationManager<TApplication> : IOpenIddictApplicationManager where TApplication : class</code></pre>
|
|
</div>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TApplication</span></td>
|
|
<td><p>The type of the Application entity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="OpenIddict_Core_OpenIddictApplicationManager_1_remarks"><strong>Remarks</strong></h5>
|
|
<div class="markdown level0 remarks"><p>Applications that do not want to depend on a specific entity type can use the non-generic
|
|
<see cref="!:IOpenIddictApplicationManager"></see> instead, for which the actual entity type
|
|
is resolved at runtime based on the default entity type registered in the core options.</p>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1__ctor_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.#ctor*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1__ctor_IOpenIddictApplicationCache__0__ILogger_OpenIddict_Core_OpenIddictApplicationManager__0___IOptionsMonitor_OpenIddict_Core_OpenIddictCoreOptions__IOpenIddictApplicationStoreResolver_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.#ctor(IOpenIddictApplicationCache{`0},ILogger{OpenIddict.Core.OpenIddictApplicationManager{`0}},IOptionsMonitor{OpenIddict.Core.OpenIddictCoreOptions},IOpenIddictApplicationStoreResolver)">OpenIddictApplicationManager(IOpenIddictApplicationCache<TApplication>, ILogger<OpenIddictApplicationManager<TApplication>>, IOptionsMonitor<OpenIddictCoreOptions>, IOpenIddictApplicationStoreResolver)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictApplicationManager(IOpenIddictApplicationCache<TApplication> cache, ILogger<OpenIddictApplicationManager<TApplication>> logger, IOptionsMonitor<OpenIddictCoreOptions> options, IOpenIddictApplicationStoreResolver resolver)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IOpenIddictApplicationCache</span><TApplication></td>
|
|
<td><span class="parametername">cache</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ILogger</span><<a class="xref" href="OpenIddict.Core.OpenIddictApplicationManager-1.html">OpenIddictApplicationManager</a><TApplication>></td>
|
|
<td><span class="parametername">logger</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">IOptionsMonitor</span><<a class="xref" href="OpenIddict.Core.OpenIddictCoreOptions.html">OpenIddictCoreOptions</a>></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">IOpenIddictApplicationStoreResolver</span></td>
|
|
<td><span class="parametername">resolver</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_Cache_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Cache*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_Cache" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Cache">Cache</h4>
|
|
<div class="markdown level1 summary"><p>Gets the cache associated with the current manager.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected IOpenIddictApplicationCache<TApplication> Cache { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IOpenIddictApplicationCache</span><TApplication></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_Logger_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Logger*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_Logger" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Logger">Logger</h4>
|
|
<div class="markdown level1 summary"><p>Gets the logger associated with the current manager.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected ILogger Logger { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ILogger</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_Options_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Options*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_Options" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Options">Options</h4>
|
|
<div class="markdown level1 summary"><p>Gets the options associated with the current manager.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected IOptionsMonitor<OpenIddictCoreOptions> Options { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IOptionsMonitor</span><<a class="xref" href="OpenIddict.Core.OpenIddictCoreOptions.html">OpenIddictCoreOptions</a>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_Store_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Store*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_Store" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.Store">Store</h4>
|
|
<div class="markdown level1 summary"><p>Gets the store associated with the current manager.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected IOpenIddictApplicationStore<TApplication> Store { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IOpenIddictApplicationStore</span><TApplication></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_CountAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CountAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_CountAsync_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CountAsync(CancellationToken)">CountAsync(CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines the number of applications 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">public virtual 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 applications in the database.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_CountAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CountAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_CountAsync__1_System_Func_IQueryable__0__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CountAsync``1(System.Func{IQueryable{`0},IQueryable{``0}},CancellationToken)">CountAsync<TResult>(Func<IQueryable<TApplication>, IQueryable<TResult>>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines the number of applications 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">public virtual ValueTask<long> CountAsync<TResult>(Func<IQueryable<TApplication>, 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><TApplication>, <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 applications 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_Core_OpenIddictApplicationManager_1_CreateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CreateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_CreateAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CreateAsync(`0,CancellationToken)">CreateAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask CreateAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application to create.</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_Core_OpenIddictApplicationManager_1_CreateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CreateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_CreateAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CreateAsync(`0,System.String,CancellationToken)">CreateAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new application.
|
|
Note: the default implementation automatically hashes the client
|
|
secret before storing it in the database, 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">public virtual ValueTask CreateAsync(TApplication application, string secret, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application to create.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">secret</span></td>
|
|
<td><p>The client secret associated with the application, if applicable.</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_Core_OpenIddictApplicationManager_1_CreateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CreateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_CreateAsync_OpenIddictApplicationDescriptor_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.CreateAsync(OpenIddictApplicationDescriptor,CancellationToken)">CreateAsync(OpenIddictApplicationDescriptor, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new application based on the specified descriptor.
|
|
Note: the default implementation automatically hashes the client
|
|
secret before storing it in the database, 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">public virtual ValueTask<TApplication> CreateAsync(OpenIddictApplicationDescriptor 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">OpenIddictApplicationDescriptor</span></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The application 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><TApplication></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the unique identifier associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_DeleteAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.DeleteAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_DeleteAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.DeleteAsync(`0,CancellationToken)">DeleteAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Removes an existing application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask DeleteAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application 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_Core_OpenIddictApplicationManager_1_FindByClientIdAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByClientIdAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_FindByClientIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByClientIdAsync(System.String,CancellationToken)">FindByClientIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves an application using its client identifier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<TApplication> FindByClientIdAsync(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 client identifier associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><TApplication></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the client application corresponding to the identifier.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_FindByIdAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByIdAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_FindByIdAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByIdAsync(System.String,CancellationToken)">FindByIdAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves an application using its unique identifier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<TApplication> 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 application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><TApplication></td>
|
|
<td><p>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns the client application corresponding to the identifier.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_FindByPostLogoutRedirectUriAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByPostLogoutRedirectUriAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_FindByPostLogoutRedirectUriAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByPostLogoutRedirectUriAsync(System.String,CancellationToken)">FindByPostLogoutRedirectUriAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves all the applications associated with the specified post_logout_redirect_uri.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IAsyncEnumerable<TApplication> FindByPostLogoutRedirectUriAsync(string address, 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">address</span></td>
|
|
<td><p>The post_logout_redirect_uri associated with the applications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IAsyncEnumerable</span><TApplication></td>
|
|
<td><p>The client applications corresponding to the specified post_logout_redirect_uri.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_FindByRedirectUriAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByRedirectUriAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_FindByRedirectUriAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.FindByRedirectUriAsync(System.String,CancellationToken)">FindByRedirectUriAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves all the applications associated with the specified redirect_uri.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual IAsyncEnumerable<TApplication> FindByRedirectUriAsync(string address, 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">address</span></td>
|
|
<td><p>The redirect_uri associated with the applications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IAsyncEnumerable</span><TApplication></td>
|
|
<td><p>The client applications corresponding to the specified redirect_uri.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetAsync__1_System_Func_IQueryable__0__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetAsync``1(System.Func{IQueryable{`0},IQueryable{``0}},CancellationToken)">GetAsync<TResult>(Func<IQueryable<TApplication>, 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">public virtual ValueTask<TResult> GetAsync<TResult>(Func<IQueryable<TApplication>, 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><TApplication>, <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_Core_OpenIddictApplicationManager_1_GetAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetAsync__2_System_Func_IQueryable__0____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetAsync``2(System.Func{IQueryable{`0},``0,IQueryable{``1}},``0,CancellationToken)">GetAsync<TState, TResult>(Func<IQueryable<TApplication>, 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">public virtual ValueTask<TResult> GetAsync<TState, TResult>(Func<IQueryable<TApplication>, 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><TApplication>, 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_Core_OpenIddictApplicationManager_1_GetClientIdAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetClientIdAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetClientIdAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetClientIdAsync(`0,CancellationToken)">GetClientIdAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the client identifier associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<string> GetClientIdAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<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 client identifier associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetClientTypeAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetClientTypeAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetClientTypeAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetClientTypeAsync(`0,CancellationToken)">GetClientTypeAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the client type associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<string> GetClientTypeAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<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 client type of the application (by default, "public").</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetConsentTypeAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetConsentTypeAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetConsentTypeAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetConsentTypeAsync(`0,CancellationToken)">GetConsentTypeAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the consent type associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<string> GetConsentTypeAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<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 consent type of the application (by default, "explicit").</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetDisplayNameAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetDisplayNameAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetDisplayNameAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetDisplayNameAsync(`0,CancellationToken)">GetDisplayNameAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the display name associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<string> GetDisplayNameAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<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 display name associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetDisplayNamesAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetDisplayNamesAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetDisplayNamesAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetDisplayNamesAsync(`0,CancellationToken)">GetDisplayNamesAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the localized display names associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<ImmutableDictionary<CultureInfo, string>> GetDisplayNamesAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<span class="xref">ImmutableDictionary</span><<span class="xref">CultureInfo</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 all the localized display names associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetIdAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetIdAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetIdAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetIdAsync(`0,CancellationToken)">GetIdAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the unique identifier associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<string> GetIdAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<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 application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetLocalizedDisplayNameAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetLocalizedDisplayNameAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetLocalizedDisplayNameAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetLocalizedDisplayNameAsync(`0,CancellationToken)">GetLocalizedDisplayNameAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the localized display name associated with an application
|
|
and corresponding to the current UI culture or one of its parents.
|
|
If no matching value can be found, the non-localized value is returned.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<string> GetLocalizedDisplayNameAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<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 matching localized display name associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetLocalizedDisplayNameAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetLocalizedDisplayNameAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetLocalizedDisplayNameAsync__0_CultureInfo_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetLocalizedDisplayNameAsync(`0,CultureInfo,CancellationToken)">GetLocalizedDisplayNameAsync(TApplication, CultureInfo, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the localized display name associated with an application
|
|
and corresponding to the specified culture or one of its parents.
|
|
If no matching value can be found, the non-localized value is returned.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<string> GetLocalizedDisplayNameAsync(TApplication application, CultureInfo culture, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CultureInfo</span></td>
|
|
<td><span class="parametername">culture</span></td>
|
|
<td><p>The culture (typically <see cref="!:CultureInfo.CurrentUICulture"></see>).</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 matching localized display name associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetPermissionsAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetPermissionsAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetPermissionsAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetPermissionsAsync(`0,CancellationToken)">GetPermissionsAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the permissions associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<ImmutableArray<string>> GetPermissionsAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<span class="xref">ImmutableArray</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 all the permissions associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetPostLogoutRedirectUrisAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetPostLogoutRedirectUrisAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetPostLogoutRedirectUrisAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetPostLogoutRedirectUrisAsync(`0,CancellationToken)">GetPostLogoutRedirectUrisAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the logout callback addresses associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<ImmutableArray<string>> GetPostLogoutRedirectUrisAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<span class="xref">ImmutableArray</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 all the post_logout_redirect_uri associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetPropertiesAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetPropertiesAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetPropertiesAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetPropertiesAsync(`0,CancellationToken)">GetPropertiesAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the additional properties associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<ImmutableDictionary<string, JsonElement>> GetPropertiesAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<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 application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetRedirectUrisAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetRedirectUrisAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetRedirectUrisAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetRedirectUrisAsync(`0,CancellationToken)">GetRedirectUrisAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the callback addresses associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<ImmutableArray<string>> GetRedirectUrisAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<span class="xref">ImmutableArray</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 all the redirect_uri associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_GetRequirementsAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetRequirementsAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_GetRequirementsAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.GetRequirementsAsync(`0,CancellationToken)">GetRequirementsAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Retrieves the requirements associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<ImmutableArray<string>> GetRequirementsAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span><<span class="xref">ImmutableArray</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 all the requirements associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_HasClientTypeAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasClientTypeAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_HasClientTypeAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasClientTypeAsync(`0,System.String,CancellationToken)">HasClientTypeAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether a given application has the specified client type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<bool> HasClientTypeAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The expected client 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 application has the specified client type, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_HasConsentTypeAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasConsentTypeAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_HasConsentTypeAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasConsentTypeAsync(`0,System.String,CancellationToken)">HasConsentTypeAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether a given application has the specified consent type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<bool> HasConsentTypeAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The expected consent 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 application has the specified consent type, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_HasPermissionAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasPermissionAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_HasPermissionAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasPermissionAsync(`0,System.String,CancellationToken)">HasPermissionAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the specified permission has been granted to the application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<bool> HasPermissionAsync(TApplication application, string permission, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">permission</span></td>
|
|
<td><p>The permission.</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 application has been granted the specified permission, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_HasRequirementAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasRequirementAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_HasRequirementAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.HasRequirementAsync(`0,System.String,CancellationToken)">HasRequirementAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the specified requirement has been enforced for the specified application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<bool> HasRequirementAsync(TApplication application, string requirement, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">requirement</span></td>
|
|
<td><p>The requirement.</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 requirement has been enforced for the specified application, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_ListAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ListAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ListAsync_System_Nullable_System_Int32__System_Nullable_System_Int32__CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.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">public virtual IAsyncEnumerable<TApplication> 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><TApplication></td>
|
|
<td><p>All the elements returned when executing the specified query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_ListAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ListAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ListAsync__1_System_Func_IQueryable__0__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ListAsync``1(System.Func{IQueryable{`0},IQueryable{``0}},CancellationToken)">ListAsync<TResult>(Func<IQueryable<TApplication>, 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">public virtual IAsyncEnumerable<TResult> ListAsync<TResult>(Func<IQueryable<TApplication>, 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><TApplication>, <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_Core_OpenIddictApplicationManager_1_ListAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ListAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ListAsync__2_System_Func_IQueryable__0____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ListAsync``2(System.Func{IQueryable{`0},``0,IQueryable{``1}},``0,CancellationToken)">ListAsync<TState, TResult>(Func<IQueryable<TApplication>, 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">public virtual IAsyncEnumerable<TResult> ListAsync<TState, TResult>(Func<IQueryable<TApplication>, 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><TApplication>, 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_Core_OpenIddictApplicationManager_1_ObfuscateClientSecretAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ObfuscateClientSecretAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ObfuscateClientSecretAsync_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ObfuscateClientSecretAsync(System.String,CancellationToken)">ObfuscateClientSecretAsync(String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Obfuscates the specified client secret so it can be safely stored in a database.
|
|
By default, this method returns a complex hashed representation computed using PBKDF2.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual ValueTask<string> ObfuscateClientSecretAsync(string secret, 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">secret</span></td>
|
|
<td><p>The client secret.</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"></see> that can be used to monitor the asynchronous operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_PopulateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.PopulateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_PopulateAsync__0_OpenIddictApplicationDescriptor_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.PopulateAsync(`0,OpenIddictApplicationDescriptor,CancellationToken)">PopulateAsync(TApplication, OpenIddictApplicationDescriptor, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Populates the application 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">public virtual ValueTask PopulateAsync(TApplication application, OpenIddictApplicationDescriptor 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">OpenIddictApplicationDescriptor</span></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_Core_OpenIddictApplicationManager_1_PopulateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.PopulateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_PopulateAsync_OpenIddictApplicationDescriptor__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.PopulateAsync(OpenIddictApplicationDescriptor,`0,CancellationToken)">PopulateAsync(OpenIddictApplicationDescriptor, TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Populates the specified descriptor using the properties exposed by the application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask PopulateAsync(OpenIddictApplicationDescriptor descriptor, TApplication application, 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">OpenIddictApplicationDescriptor</span></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The descriptor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span></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_Core_OpenIddictApplicationManager_1_UpdateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.UpdateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_UpdateAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.UpdateAsync(`0,CancellationToken)">UpdateAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Updates an existing application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask UpdateAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application 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_Core_OpenIddictApplicationManager_1_UpdateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.UpdateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_UpdateAsync__0_OpenIddictApplicationDescriptor_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.UpdateAsync(`0,OpenIddictApplicationDescriptor,CancellationToken)">UpdateAsync(TApplication, OpenIddictApplicationDescriptor, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Updates an existing application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask UpdateAsync(TApplication application, OpenIddictApplicationDescriptor 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application to update.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">OpenIddictApplicationDescriptor</span></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The descriptor used to update the application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span></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_Core_OpenIddictApplicationManager_1_UpdateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.UpdateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_UpdateAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.UpdateAsync(`0,System.String,CancellationToken)">UpdateAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Updates an existing application and replaces the existing secret.
|
|
Note: the default implementation automatically hashes the client
|
|
secret before storing it in the database, 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">public virtual ValueTask UpdateAsync(TApplication application, string secret, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application to update.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">secret</span></td>
|
|
<td><p>The client secret associated with the application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">ValueTask</span></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_Core_OpenIddictApplicationManager_1_ValidateAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ValidateAsync__0_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateAsync(`0,CancellationToken)">ValidateAsync(TApplication, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Validates the application 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">public virtual IAsyncEnumerable<ValidationResult> ValidateAsync(TApplication application, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>The <see cref="!:CancellationToken"></see> that can be used to abort the operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IAsyncEnumerable</span><<span class="xref">ValidationResult</span>></td>
|
|
<td><p>The validation error encountered when validating the application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_ValidateClientSecretAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateClientSecretAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ValidateClientSecretAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateClientSecretAsync(`0,System.String,CancellationToken)">ValidateClientSecretAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Validates the client_secret associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<bool> ValidateClientSecretAsync(TApplication application, string secret, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">secret</span></td>
|
|
<td><p>The secret that should be compared to the client_secret stored in the database.</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>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_ValidateClientSecretAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateClientSecretAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ValidateClientSecretAsync_System_String_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateClientSecretAsync(System.String,System.String,CancellationToken)">ValidateClientSecretAsync(String, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Validates the specified value to ensure it corresponds to the client secret.
|
|
Note: when overriding this method, using a time-constant comparer is strongly recommended.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual ValueTask<bool> ValidateClientSecretAsync(string secret, string comparand, 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">secret</span></td>
|
|
<td><p>The client secret to compare to the value stored in the database.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">comparand</span></td>
|
|
<td><p>The value stored in the database, which is usually a hashed representation of the secret.</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>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns a boolean indicating whether the specified value was valid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Core_OpenIddictApplicationManager_1_ValidateRedirectUriAsync_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateRedirectUriAsync*"></a>
|
|
<h4 id="OpenIddict_Core_OpenIddictApplicationManager_1_ValidateRedirectUriAsync__0_System_String_CancellationToken_" data-uid="OpenIddict.Core.OpenIddictApplicationManager`1.ValidateRedirectUriAsync(`0,System.String,CancellationToken)">ValidateRedirectUriAsync(TApplication, String, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Validates the redirect_uri to ensure it's associated with an application.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual ValueTask<bool> ValidateRedirectUriAsync(TApplication application, string address, 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">TApplication</span></td>
|
|
<td><span class="parametername">application</span></td>
|
|
<td><p>The application.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">address</span></td>
|
|
<td><p>The address that should be compared to one of the redirect_uri stored in the database.</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>A <see cref="!:ValueTask"></see> that can be used to monitor the asynchronous operation,
|
|
whose result returns a boolean indicating whether the redirect_uri was valid.</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>
|