Update the documentation pages

This commit is contained in:
OpenIddict Bot
2021-02-08 10:58:19 +00:00
parent 0718bfe145
commit 83e8df701f
136 changed files with 2000 additions and 2029 deletions

View File

@@ -149,7 +149,7 @@ whose result returns the number of authorizations in the database.</p>
<a id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_CountAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.CountAsync*"></a>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_CountAsync__1_System_Func_IQueryable__0__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.CountAsync``1(System.Func{IQueryable{`0},IQueryable{``0}},CancellationToken)">CountAsync&lt;TResult&gt;(Func&lt;IQueryable&lt;TAuthorization&gt;, IQueryable&lt;TResult&gt;&gt;, CancellationToken)</h4>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_CountAsync__1_Func_IQueryable__0__IQueryable___0___CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.CountAsync``1(Func{IQueryable{`0},IQueryable{``0}},CancellationToken)">CountAsync&lt;TResult&gt;(Func&lt;IQueryable&lt;TAuthorization&gt;, IQueryable&lt;TResult&gt;&gt;, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Determines the number of authorizations that match the specified query.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -168,7 +168,7 @@ whose result returns the number of authorizations in the database.</p>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Func</span>&lt;<span class="xref">IQueryable</span>&lt;TAuthorization&gt;, <span class="xref">IQueryable</span>&lt;TResult&gt;&gt;</td>
<td><span class="xref">Func</span>&lt;<span class="xref">IQueryable</span>&lt;TAuthorization&gt;, <span class="xref">IQueryable</span>&lt;TResult&gt;&gt;</td>
<td><span class="parametername">query</span></td>
<td><p>The query to execute.</p>
</td>
@@ -790,7 +790,7 @@ whose result returns the application identifier associated with the authorizatio
<a id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_GetAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.GetAsync*"></a>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_GetAsync__2_System_Func_IQueryable__0____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.GetAsync``2(System.Func{IQueryable{`0},``0,IQueryable{``1}},``0,CancellationToken)">GetAsync&lt;TState, TResult&gt;(Func&lt;IQueryable&lt;TAuthorization&gt;, TState, IQueryable&lt;TResult&gt;&gt;, TState, CancellationToken)</h4>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_GetAsync__2_Func_IQueryable__0____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.GetAsync``2(Func{IQueryable{`0},``0,IQueryable{``1}},``0,CancellationToken)">GetAsync&lt;TState, TResult&gt;(Func&lt;IQueryable&lt;TAuthorization&gt;, TState, IQueryable&lt;TResult&gt;&gt;, 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>
@@ -809,7 +809,7 @@ whose result returns the application identifier associated with the authorizatio
</thead>
<tbody>
<tr>
<td><span class="xref">System.Func</span>&lt;<span class="xref">IQueryable</span>&lt;TAuthorization&gt;, TState, <span class="xref">IQueryable</span>&lt;TResult&gt;&gt;</td>
<td><span class="xref">Func</span>&lt;<span class="xref">IQueryable</span>&lt;TAuthorization&gt;, TState, <span class="xref">IQueryable</span>&lt;TResult&gt;&gt;</td>
<td><span class="parametername">query</span></td>
<td><p>The query to execute.</p>
</td>
@@ -911,7 +911,7 @@ whose result returns the first element returned when executing the query.</p>
</thead>
<tbody>
<tr>
<td><span class="xref">ValueTask</span>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTimeOffset</span>&gt;&gt;</td>
<td><span class="xref">ValueTask</span>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">DateTimeOffset</span>&gt;&gt;</td>
<td><p>A <see cref="!:ValueTask&lt;TResult>"></see> that can be used to monitor the asynchronous operation,
whose result returns the creation date associated with the specified authorization.</p>
</td>
@@ -1336,7 +1336,7 @@ whose result returns the instantiated authorization, that can be persisted in th
<a id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_ListAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.ListAsync*"></a>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_ListAsync__2_System_Func_IQueryable__0____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.ListAsync``2(System.Func{IQueryable{`0},``0,IQueryable{``1}},``0,CancellationToken)">ListAsync&lt;TState, TResult&gt;(Func&lt;IQueryable&lt;TAuthorization&gt;, TState, IQueryable&lt;TResult&gt;&gt;, TState, CancellationToken)</h4>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_ListAsync__2_Func_IQueryable__0____0_IQueryable___1_____0_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.ListAsync``2(Func{IQueryable{`0},``0,IQueryable{``1}},``0,CancellationToken)">ListAsync&lt;TState, TResult&gt;(Func&lt;IQueryable&lt;TAuthorization&gt;, TState, IQueryable&lt;TResult&gt;&gt;, 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>
@@ -1355,7 +1355,7 @@ whose result returns the instantiated authorization, that can be persisted in th
</thead>
<tbody>
<tr>
<td><span class="xref">System.Func</span>&lt;<span class="xref">IQueryable</span>&lt;TAuthorization&gt;, TState, <span class="xref">IQueryable</span>&lt;TResult&gt;&gt;</td>
<td><span class="xref">Func</span>&lt;<span class="xref">IQueryable</span>&lt;TAuthorization&gt;, TState, <span class="xref">IQueryable</span>&lt;TResult&gt;&gt;</td>
<td><span class="parametername">query</span></td>
<td><p>The query to execute.</p>
</td>
@@ -1414,7 +1414,7 @@ whose result returns the instantiated authorization, that can be persisted in th
<a id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_PruneAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.PruneAsync*"></a>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_PruneAsync_System_DateTimeOffset_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.PruneAsync(System.DateTimeOffset,CancellationToken)">PruneAsync(DateTimeOffset, CancellationToken)</h4>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_PruneAsync_DateTimeOffset_CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.PruneAsync(DateTimeOffset,CancellationToken)">PruneAsync(DateTimeOffset, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Removes the authorizations that are marked as invalid and the ad-hoc ones that have no token attached.
Only authorizations created before the specified <code data-dev-comment-type="paramref" class="paramref">threshold</code> are removed.</p>
</div>
@@ -1434,7 +1434,7 @@ Only authorizations created before the specified <code data-dev-comment-type="pa
</thead>
<tbody>
<tr>
<td><span class="xref">System.DateTimeOffset</span></td>
<td><span class="xref">DateTimeOffset</span></td>
<td><span class="parametername">threshold</span></td>
<td><p>The date before which authorizations are not pruned.</p>
</td>
@@ -1463,7 +1463,7 @@ Only authorizations created before the specified <code data-dev-comment-type="pa
</tr>
</tbody>
</table>
<h5 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_PruneAsync_System_DateTimeOffset_CancellationToken__remarks">Remarks</h5>
<h5 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_PruneAsync_DateTimeOffset_CancellationToken__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>To ensure ad-hoc authorizations that no longer have any valid/non-expired token
attached are correctly removed, the tokens should always be pruned first.</p>
</div>
@@ -1527,7 +1527,7 @@ attached are correctly removed, the tokens should always be pruned first.</p>
<a id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_SetCreationDateAsync_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.SetCreationDateAsync*"></a>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_SetCreationDateAsync__0_System_Nullable_System_DateTimeOffset__CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.SetCreationDateAsync(`0,System.Nullable{System.DateTimeOffset},CancellationToken)">SetCreationDateAsync(TAuthorization, Nullable&lt;DateTimeOffset&gt;, CancellationToken)</h4>
<h4 id="OpenIddict_Abstractions_IOpenIddictAuthorizationStore_1_SetCreationDateAsync__0_System_Nullable_DateTimeOffset__CancellationToken_" data-uid="OpenIddict.Abstractions.IOpenIddictAuthorizationStore`1.SetCreationDateAsync(`0,System.Nullable{DateTimeOffset},CancellationToken)">SetCreationDateAsync(TAuthorization, Nullable&lt;DateTimeOffset&gt;, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Sets the creation date associated with an authorization.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1552,7 +1552,7 @@ attached are correctly removed, the tokens should always be pruned first.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTimeOffset</span>&gt;</td>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">DateTimeOffset</span>&gt;</td>
<td><span class="parametername">date</span></td>
<td><p>The expiration date.</p>
</td>