ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-13 12:14:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: regenerate

Browse source
This commit is contained in:
goat 2020-06-05 16:12:48 +02:00
parent 3479919ab6
commit 31af5d8d77
88 changed files with 9028 additions and 3189 deletions
Download patch file Download diff file Expand all files Collapse all files

159
docs/api/Discord.WebSocket.SocketGuildChannel.html
View file

@ -173,7 +173,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Name_" data-uid="Discord.WebSocket.SocketGuildChannel.Name*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Name" data-uid="Discord.WebSocket.SocketGuildChannel.Name">Name</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -190,7 +191,8 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
<td><p>A string containing the name of this channel.</p>
</td>
</tr>
</tbody>
</table>
@ -203,7 +205,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_PermissionOverwrites_" data-uid="Discord.WebSocket.SocketGuildChannel.PermissionOverwrites*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_PermissionOverwrites" data-uid="Discord.WebSocket.SocketGuildChannel.PermissionOverwrites">PermissionOverwrites</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a collection of permission overwrites for this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -220,7 +223,8 @@
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.Overwrite.html">Overwrite</a>&gt;</td>
<td></td>
<td><p>A collection of overwrites associated with this channel.</p>
</td>
</tr>
</tbody>
</table>
@ -233,7 +237,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Position_" data-uid="Discord.WebSocket.SocketGuildChannel.Position*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Position" data-uid="Discord.WebSocket.SocketGuildChannel.Position">Position</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the position of this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -250,7 +255,9 @@
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
<td><p>An <span class="xref">System.Int32</span> representing the position of this channel in the guild's channel list relative to
others of the same type.</p>
</td>
</tr>
</tbody>
</table>
@ -421,7 +428,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_DeleteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.DeleteAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -440,7 +448,8 @@
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -615,7 +624,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_ModifyAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.ModifyAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.ModifyAsync(System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">ModifyAsync(Action&lt;GuildChannelProperties&gt;, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Modifies this guild channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -634,12 +644,14 @@
<tr>
<td><span class="xref">System.Action</span>&lt;<a class="xref" href="Discord.GuildChannelProperties.html">GuildChannelProperties</a>&gt;</td>
<td><span class="parametername">func</span></td>
<td></td>
<td><p>The delegate containing the properties to modify the channel with.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -654,10 +666,15 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
<td><p>A task that represents the asynchronous modification operation.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method modifies the current guild channel with the specified properties. To see an example of this
method and what properties are available, please refer to <a class="xref" href="Discord.GuildChannelProperties.html">GuildChannelProperties</a>.</p>
</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_WebSocket_SocketGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildChannel.RemovePermissionOverwriteAsync(Discord.IRole%2CDiscord.RequestOptions)%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>
@ -815,7 +832,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IChannel#GetUserAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -834,17 +852,20 @@
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td></td>
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td></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>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -859,7 +880,9 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IUser.html">IUser</a>&gt;</td>
<td></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>
</tr>
</tbody>
</table>
@ -872,7 +895,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IRole_Discord_OverwritePermissions_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Adds or updates the permission overwrite for the given role.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -891,17 +915,20 @@
<tr>
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
<td><span class="parametername">role</span></td>
<td></td>
<td><p>The role to add the overwrite to.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a></td>
<td><span class="parametername">permissions</span></td>
<td></td>
<td><p>The overwrite to add to the role.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -916,7 +943,9 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
<td><p>A task representing the asynchronous permission operation for adding the specified permissions to the
channel.</p>
</td>
</tr>
</tbody>
</table>
@ -929,7 +958,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IUser_Discord_OverwritePermissions_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Adds or updates the permission overwrite for the given user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -948,17 +978,20 @@
<tr>
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
<td><span class="parametername">user</span></td>
<td></td>
<td><p>The user to add the overwrite to.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a></td>
<td><span class="parametername">permissions</span></td>
<td></td>
<td><p>The overwrite to add to the user.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -973,7 +1006,8 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
<td><p>A task representing the asynchronous permission operation for adding the specified permissions to the channel.</p>
</td>
</tr>
</tbody>
</table>
@ -986,7 +1020,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IRole_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IRole)">IGuildChannel.GetPermissionOverwrite(IRole)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the permission overwrite for a specific role.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1005,7 +1040,8 @@
<tr>
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
<td><span class="parametername">role</span></td>
<td></td>
<td><p>The role to get the overwrite from.</p>
</td>
</tr>
</tbody>
</table>
@ -1020,7 +1056,8 @@
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a>&gt;</td>
<td></td>
<td><p>An overwrite object for the targeted role; <code>null</code> if none is set.</p>
</td>
</tr>
</tbody>
</table>
@ -1033,7 +1070,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IUser_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IUser)">IGuildChannel.GetPermissionOverwrite(IUser)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the permission overwrite for a specific user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1052,7 +1090,8 @@
<tr>
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
<td><span class="parametername">user</span></td>
<td></td>
<td><p>The user to get the overwrite from.</p>
</td>
</tr>
</tbody>
</table>
@ -1067,7 +1106,8 @@
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a>&gt;</td>
<td></td>
<td><p>An overwrite object for the targeted user; <code>null</code> if none is set.</p>
</td>
</tr>
</tbody>
</table>
@ -1080,7 +1120,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetUserAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1099,17 +1140,20 @@
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td></td>
<td><p>The snowflake identifier of the user.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td></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>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -1124,7 +1168,9 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>&gt;</td>
<td></td>
<td><p>A task representing the asynchronous get operation. The task result contains a guild user object that
represents the user; <code>null</code> if none is found.</p>
</td>
</tr>
</tbody>
</table>
@ -1137,7 +1183,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_Guild_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#Guild*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_Guild" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#Guild">IGuildChannel.Guild</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the guild associated with this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1154,7 +1201,8 @@
<tbody>
<tr>
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
<td></td>
<td><p>A guild object that this channel belongs to.</p>
</td>
</tr>
</tbody>
</table>
@ -1167,7 +1215,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GuildId_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GuildId*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GuildId" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GuildId">IGuildChannel.GuildId</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the guild ID associated with this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1184,7 +1233,9 @@
<tbody>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td></td>
<td><p>An <span class="xref">System.UInt64</span> representing the guild snowflake identifier for the guild that this channel
belongs to.</p>
</td>
</tr>
</tbody>
</table>
@ -1197,7 +1248,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Removes the permission overwrite for the given role, if one exists.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1216,12 +1268,14 @@
<tr>
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
<td><span class="parametername">role</span></td>
<td></td>
<td><p>The role to remove the overwrite from.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -1236,7 +1290,8 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
<td><p>A task representing the asynchronous operation for removing the specified permissions from the channel.</p>
</td>
</tr>
</tbody>
</table>
@ -1249,7 +1304,8 @@
</span>
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IUser_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Removes the permission overwrite for the given user, if one exists.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -1268,12 +1324,14 @@
<tr>
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
<td><span class="parametername">user</span></td>
<td></td>
<td><p>The user to remove the overwrite from.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
@ -1288,7 +1346,8 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
<td><p>A task representing the asynchronous operation for removing the specified permissions from the channel.</p>
</td>
</tr>
</tbody>
</table>