ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2026-02-02 05:54:36 +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

98
docs/api/Discord.WebSocket.SocketUser.html
View file

@ -136,7 +136,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_ActiveClients_" data-uid="Discord.WebSocket.SocketUser.ActiveClients*"></a>
<h4 id="Discord_WebSocket_SocketUser_ActiveClients" data-uid="Discord.WebSocket.SocketUser.ActiveClients">ActiveClients</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the set of clients where this user is currently active.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -166,7 +167,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_Activity_" data-uid="Discord.WebSocket.SocketUser.Activity*"></a>
<h4 id="Discord_WebSocket_SocketUser_Activity" data-uid="Discord.WebSocket.SocketUser.Activity">Activity</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the activity this user is currently doing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -196,7 +198,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_AvatarId_" data-uid="Discord.WebSocket.SocketUser.AvatarId*"></a>
<h4 id="Discord_WebSocket_SocketUser_AvatarId" data-uid="Discord.WebSocket.SocketUser.AvatarId">AvatarId</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -226,7 +229,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_CreatedAt_" data-uid="Discord.WebSocket.SocketUser.CreatedAt*"></a>
<h4 id="Discord_WebSocket_SocketUser_CreatedAt" data-uid="Discord.WebSocket.SocketUser.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">
@ -243,7 +247,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 +261,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_Discriminator_" data-uid="Discord.WebSocket.SocketUser.Discriminator*"></a>
<h4 id="Discord_WebSocket_SocketUser_Discriminator" data-uid="Discord.WebSocket.SocketUser.Discriminator">Discriminator</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -286,7 +292,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketUser.DiscriminatorValue*"></a>
<h4 id="Discord_WebSocket_SocketUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketUser.DiscriminatorValue">DiscriminatorValue</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -316,7 +323,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_IsBot_" data-uid="Discord.WebSocket.SocketUser.IsBot*"></a>
<h4 id="Discord_WebSocket_SocketUser_IsBot" data-uid="Discord.WebSocket.SocketUser.IsBot">IsBot</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -333,10 +341,15 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketUser_IsBot_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
(indicated by the blue BOT tag within the official chat client).</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_SocketUser_IsWebhook.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketUser.IsWebhook%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>
@ -346,7 +359,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_IsWebhook_" data-uid="Discord.WebSocket.SocketUser.IsWebhook*"></a>
<h4 id="Discord_WebSocket_SocketUser_IsWebhook" data-uid="Discord.WebSocket.SocketUser.IsWebhook">IsWebhook</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -363,7 +377,8 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
@ -376,7 +391,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_Mention_" data-uid="Discord.WebSocket.SocketUser.Mention*"></a>
<h4 id="Discord_WebSocket_SocketUser_Mention" data-uid="Discord.WebSocket.SocketUser.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 +409,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>
@ -437,7 +454,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_Status_" data-uid="Discord.WebSocket.SocketUser.Status*"></a>
<h4 id="Discord_WebSocket_SocketUser_Status" data-uid="Discord.WebSocket.SocketUser.Status">Status</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the current status of this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -467,7 +485,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_Username_" data-uid="Discord.WebSocket.SocketUser.Username*"></a>
<h4 id="Discord_WebSocket_SocketUser_Username" data-uid="Discord.WebSocket.SocketUser.Username">Username</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -499,7 +518,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_GetAvatarUrl_" data-uid="Discord.WebSocket.SocketUser.GetAvatarUrl*"></a>
<h4 id="Discord_WebSocket_SocketUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16_" data-uid="Discord.WebSocket.SocketUser.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">GetAvatarUrl(ImageFormat, UInt16)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the avatar URL for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -518,12 +538,14 @@
<tr>
<td><a class="xref" href="Discord.ImageFormat.html">ImageFormat</a></td>
<td><span class="parametername">format</span></td>
<td></td>
<td><p>The format to return.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt16</span></td>
<td><span class="parametername">size</span></td>
<td></td>
<td><p>The size of the image to return in. This can be any power of two between 16 and 2048.</p>
</td>
</tr>
</tbody>
</table>
@ -538,10 +560,17 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
<td><p>A string representing the user's avatar URL; <code>null</code> if the user does not have an avatar in place.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's avatar. In event that the user does not have a valid avatar
(i.e. their avatar identifier is not set), this property will return <code>null</code>. If you wish to
retrieve the default avatar for this user, consider using <a class="xref" href="Discord.IUser.html#Discord_IUser_GetDefaultAvatarUrl">GetDefaultAvatarUrl()</a> (see
example).</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_SocketUser_GetDefaultAvatarUrl.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketUser.GetDefaultAvatarUrl%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>
@ -551,7 +580,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_GetDefaultAvatarUrl_" data-uid="Discord.WebSocket.SocketUser.GetDefaultAvatarUrl*"></a>
<h4 id="Discord_WebSocket_SocketUser_GetDefaultAvatarUrl" data-uid="Discord.WebSocket.SocketUser.GetDefaultAvatarUrl">GetDefaultAvatarUrl()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the default avatar URL for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -568,10 +598,16 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
<td><p>A string representing the user's avatar URL.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketUser_GetDefaultAvatarUrl_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's default avatar generated by Discord (Discord logo followed
by a random color as its background). This property will always return a value as it is calculated based
on the user's <a class="xref" href="Discord.IUser.html#Discord_IUser_DiscriminatorValue">DiscriminatorValue</a> (<code>discriminator % 5</code>).</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_SocketUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketUser.GetOrCreateDMChannelAsync(Discord.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>
@ -581,7 +617,8 @@
</span>
<a id="Discord_WebSocket_SocketUser_GetOrCreateDMChannelAsync_" data-uid="Discord.WebSocket.SocketUser.GetOrCreateDMChannelAsync*"></a>
<h4 id="Discord_WebSocket_SocketUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUser.GetOrCreateDMChannelAsync(Discord.RequestOptions)">GetOrCreateDMChannelAsync(RequestOptions)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the direct message channel of this user, or create one if it does not already exist.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -600,7 +637,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,10 +653,22 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Discord.IDMChannel.html">IDMChannel</a>&gt;</td>
<td></td>
<td><p>A task that represents the asynchronous operation for getting or creating a DM channel. The task result
contains the DM channel associated with this user.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketUser_GetOrCreateDMChannelAsync_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method is used to obtain or create a channel used to send a direct message.</p>
<div class="WARNING"><h5>warning</h5><p>
In event that the current user cannot send a message to the target user, a channel can and will
still be created by Discord. However, attempting to send a message will yield a
<span class="xref">Discord.Net.HttpException</span> with a 403 as its
<span class="xref">Discord.Net.HttpException.HttpCode</span>. There are currently no official workarounds by
Discord.
</p></div>
</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_SocketUser_ToString.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketUser.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>