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

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

82
docs/api/Discord.WebSocket.SocketRole.html
View file

@ -132,7 +132,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_Color_" data-uid="Discord.WebSocket.SocketRole.Color*"></a>
<h4 id="Discord_WebSocket_SocketRole_Color" data-uid="Discord.WebSocket.SocketRole.Color">Color</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the color given to users of this role.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -149,7 +150,8 @@
<tbody>
<tr>
<td><a class="xref" href="Discord.Color.html">Color</a></td>
<td></td>
<td><p>A <a class="xref" href="Discord.IRole.html#Discord_IRole_Color">Color</a> struct representing the color of this role.</p>
</td>
</tr>
</tbody>
</table>
@ -162,7 +164,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_CreatedAt_" data-uid="Discord.WebSocket.SocketRole.CreatedAt*"></a>
<h4 id="Discord_WebSocket_SocketRole_CreatedAt" data-uid="Discord.WebSocket.SocketRole.CreatedAt">CreatedAt</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -179,7 +182,8 @@
<tbody>
<tr>
<td><span class="xref">System.DateTimeOffset</span></td>
<td></td>
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
</td>
</tr>
</tbody>
</table>
@ -256,7 +260,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_IsHoisted_" data-uid="Discord.WebSocket.SocketRole.IsHoisted*"></a>
<h4 id="Discord_WebSocket_SocketRole_IsHoisted" data-uid="Discord.WebSocket.SocketRole.IsHoisted">IsHoisted</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role can be separated in the user list.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -273,7 +278,8 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
<td><p><code>true</code> if users of this role are separated in the user list; otherwise <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
@ -286,7 +292,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_IsManaged_" data-uid="Discord.WebSocket.SocketRole.IsManaged*"></a>
<h4 id="Discord_WebSocket_SocketRole_IsManaged" data-uid="Discord.WebSocket.SocketRole.IsManaged">IsManaged</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role is managed by Discord.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -303,7 +310,8 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
<td><p><code>true</code> if this role is automatically managed by Discord; otherwise <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
@ -316,7 +324,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_IsMentionable_" data-uid="Discord.WebSocket.SocketRole.IsMentionable*"></a>
<h4 id="Discord_WebSocket_SocketRole_IsMentionable" data-uid="Discord.WebSocket.SocketRole.IsMentionable">IsMentionable</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role is mentionable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -333,7 +342,8 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
<td><p><code>true</code> if this role may be mentioned in messages; otherwise <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
@ -376,7 +386,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_Mention_" data-uid="Discord.WebSocket.SocketRole.Mention*"></a>
<h4 id="Discord_WebSocket_SocketRole_Mention" data-uid="Discord.WebSocket.SocketRole.Mention">Mention</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Returns a special string used to mention this object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -393,7 +404,8 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
<td><p>A string that is recognized by Discord as a mention (e.g. &lt;@168693960628371456&gt;).</p>
</td>
</tr>
</tbody>
</table>
@ -406,7 +418,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_Name_" data-uid="Discord.WebSocket.SocketRole.Name*"></a>
<h4 id="Discord_WebSocket_SocketRole_Name" data-uid="Discord.WebSocket.SocketRole.Name">Name</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the name of this role.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -423,7 +436,8 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
<td><p>A string containing the name of this role.</p>
</td>
</tr>
</tbody>
</table>
@ -436,7 +450,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_Permissions_" data-uid="Discord.WebSocket.SocketRole.Permissions*"></a>
<h4 id="Discord_WebSocket_SocketRole_Permissions" data-uid="Discord.WebSocket.SocketRole.Permissions">Permissions</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the permissions granted to members of this role.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -453,7 +468,8 @@
<tbody>
<tr>
<td><a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a></td>
<td></td>
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> struct that this role possesses.</p>
</td>
</tr>
</tbody>
</table>
@ -466,7 +482,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_Position_" data-uid="Discord.WebSocket.SocketRole.Position*"></a>
<h4 id="Discord_WebSocket_SocketRole_Position" data-uid="Discord.WebSocket.SocketRole.Position">Position</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets this role's position relative to other roles in the same guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -483,7 +500,8 @@
<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 the role in the role list of the guild.</p>
</td>
</tr>
</tbody>
</table>
@ -545,7 +563,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_DeleteAsync_" data-uid="Discord.WebSocket.SocketRole.DeleteAsync*"></a>
<h4 id="Discord_WebSocket_SocketRole_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketRole.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">
@ -564,7 +583,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>
@ -592,7 +612,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_ModifyAsync_" data-uid="Discord.WebSocket.SocketRole.ModifyAsync*"></a>
<h4 id="Discord_WebSocket_SocketRole_ModifyAsync_System_Action_Discord_RoleProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketRole.ModifyAsync(System.Action{Discord.RoleProperties},Discord.RequestOptions)">ModifyAsync(Action&lt;RoleProperties&gt;, RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Modifies this role.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -611,12 +632,14 @@
<tr>
<td><span class="xref">System.Action</span>&lt;<a class="xref" href="Discord.RoleProperties.html">RoleProperties</a>&gt;</td>
<td><span class="parametername">func</span></td>
<td></td>
<td><p>A delegate containing the properties to modify the role 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>
@ -631,10 +654,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_SocketRole_ModifyAsync_System_Action_Discord_RoleProperties__Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method modifies this role with the specified properties. To see an example of this
method and what properties are available, please refer to <a class="xref" href="Discord.RoleProperties.html">RoleProperties</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_SocketRole_ToString.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketRole.ToString%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>
@ -680,7 +708,8 @@
</span>
<a id="Discord_WebSocket_SocketRole_Discord_IRole_Guild_" data-uid="Discord.WebSocket.SocketRole.Discord#IRole#Guild*"></a>
<h4 id="Discord_WebSocket_SocketRole_Discord_IRole_Guild" data-uid="Discord.WebSocket.SocketRole.Discord#IRole#Guild">IRole.Guild</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the guild that owns this role.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -697,7 +726,8 @@
<tbody>
<tr>
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
<td></td>
<td><p>A guild representing the parent guild of this role.</p>
</td>
</tr>
</tbody>
</table>