mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-14 20:54:16 +01:00
docs: regenerate
This commit is contained in:
goat
parent
39a7afa4b6
commit
94571bb41b
71 changed files with 3254 additions and 7339 deletions
|
|
@ -136,8 +136,7 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_CreatedAt_" data-uid="Discord.Rest.RestChannel.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_CreatedAt" data-uid="Discord.Rest.RestChannel.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -154,8 +153,7 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -170,8 +168,7 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_UpdateAsync_" data-uid="Discord.Rest.RestChannel.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestChannel.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -220,8 +217,7 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -240,20 +236,17 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -268,9 +261,7 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -283,8 +274,7 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_Discord_IChannel_GetUsersAsync_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUsersAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUsersAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel or are currently in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -303,14 +293,12 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -325,23 +313,10 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IUser.html">IUser</a>>></td>
|
||||
<td><p>Paged collection of users.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="IMPORTANT"><h5>important</h5><p>
|
||||
The returned collection is an asynchronous enumerable object; one must call
|
||||
<a class="xref" href="Discord.AsyncEnumerableExtensions.html#Discord_AsyncEnumerableExtensions_FlattenAsync__1_System_Collections_Generic_IAsyncEnumerable_System_Collections_Generic_IEnumerable___0___">FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>)</a> to access the individual messages as a
|
||||
collection.
|
||||
</p></div>
|
||||
This method will attempt to fetch all users that is able to view this channel or is currently in this channel.
|
||||
The library will attempt to split up the requests according to and <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a>.
|
||||
In other words, if there are 3000 users, and the <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a> constant
|
||||
is <code>1000</code>, the request will be split into 3 individual requests; thus returning 53individual asynchronous
|
||||
responses, hence the need of flattening.
|
||||
</div>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestChannel_Discord_IChannel_Name.md&value=---%0Auid%3A%20Discord.Rest.RestChannel.Discord%23IChannel%23Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
|
|
@ -351,8 +326,7 @@ responses, hence the need of flattening.
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_Discord_IChannel_Name_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#Name*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_Discord_IChannel_Name" data-uid="Discord.Rest.RestChannel.Discord#IChannel#Name">IChannel.Name</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -369,8 +343,7 @@ responses, hence the need of flattening.
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><p>A string containing the name of this channel.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue