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-05-14 22:49:06 +02:00
parent 39a7afa4b6
commit 94571bb41b
71 changed files with 3254 additions and 7339 deletions
Download patch file Download diff file Expand all files Collapse all files

124
docs/api/Discord.WebSocket.SocketUserMessage.html
View file

@ -207,8 +207,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_Attachments_" data-uid="Discord.WebSocket.SocketUserMessage.Attachments*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_Attachments" data-uid="Discord.WebSocket.SocketUserMessage.Attachments">Attachments</h4>
<div class="markdown level1 summary"><p>Returns all attachments included in this message.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -225,8 +224,7 @@
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.Attachment.html">Attachment</a>&gt;</td>
<td><p>Collection of attachments.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -241,8 +239,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_EditedTimestamp_" data-uid="Discord.WebSocket.SocketUserMessage.EditedTimestamp*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_EditedTimestamp" data-uid="Discord.WebSocket.SocketUserMessage.EditedTimestamp">EditedTimestamp</h4>
<div class="markdown level1 summary"><p>Gets the time of this message's last edit.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -259,8 +256,7 @@
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTimeOffset</span>&gt;</td>
<td><p>Time of when the message was last edited; <code>null</code> if the message is never edited.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -275,8 +271,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_Embeds_" data-uid="Discord.WebSocket.SocketUserMessage.Embeds*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_Embeds" data-uid="Discord.WebSocket.SocketUserMessage.Embeds">Embeds</h4>
<div class="markdown level1 summary"><p>Returns all embeds included in this message.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -293,8 +288,7 @@
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.Embed.html">Embed</a>&gt;</td>
<td><p>Collection of embed objects.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -309,8 +303,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_IsPinned_" data-uid="Discord.WebSocket.SocketUserMessage.IsPinned*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_IsPinned" data-uid="Discord.WebSocket.SocketUserMessage.IsPinned">IsPinned</h4>
<div class="markdown level1 summary"><p>Gets the value that indicates whether this message is pinned.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -327,8 +320,7 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if this message was added to its channel's pinned messages; otherwise <code>false</code>.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -343,8 +335,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_IsSuppressed_" data-uid="Discord.WebSocket.SocketUserMessage.IsSuppressed*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_IsSuppressed" data-uid="Discord.WebSocket.SocketUserMessage.IsSuppressed">IsSuppressed</h4>
<div class="markdown level1 summary"><p>Gets the value that indicates whether or not this message's embeds are suppressed.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -361,8 +352,7 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the embeds in this message have been suppressed (made invisible); otherwise <code>false</code>.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -377,8 +367,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_IsTTS_" data-uid="Discord.WebSocket.SocketUserMessage.IsTTS*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_IsTTS" data-uid="Discord.WebSocket.SocketUserMessage.IsTTS">IsTTS</h4>
<div class="markdown level1 summary"><p>Gets the value that indicates whether this message was meant to be read-aloud by Discord.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -395,8 +384,7 @@
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if this message was sent as a text-to-speech message; otherwise <code>false</code>.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -411,8 +399,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_MentionedChannels_" data-uid="Discord.WebSocket.SocketUserMessage.MentionedChannels*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_MentionedChannels" data-uid="Discord.WebSocket.SocketUserMessage.MentionedChannels">MentionedChannels</h4>
<div class="markdown level1 summary"><p>Returns the channels mentioned in this message.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -429,8 +416,7 @@
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html">SocketGuildChannel</a>&gt;</td>
<td><p>Collection of WebSocket-based guild channels.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -445,8 +431,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_MentionedRoles_" data-uid="Discord.WebSocket.SocketUserMessage.MentionedRoles*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_MentionedRoles" data-uid="Discord.WebSocket.SocketUserMessage.MentionedRoles">MentionedRoles</h4>
<div class="markdown level1 summary"><p>Returns the roles mentioned in this message.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -463,8 +448,7 @@
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.SocketRole.html">SocketRole</a>&gt;</td>
<td><p>Collection of WebSocket-based roles.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -479,8 +463,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_MentionedUsers_" data-uid="Discord.WebSocket.SocketUserMessage.MentionedUsers*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_MentionedUsers" data-uid="Discord.WebSocket.SocketUserMessage.MentionedUsers">MentionedUsers</h4>
<div class="markdown level1 summary"><p>Returns the users mentioned in this message.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -497,8 +480,7 @@
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a>&gt;</td>
<td><p>Collection of WebSocket-based users.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -513,8 +495,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_Tags_" data-uid="Discord.WebSocket.SocketUserMessage.Tags*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_Tags" data-uid="Discord.WebSocket.SocketUserMessage.Tags">Tags</h4>
<div class="markdown level1 summary"><p>Gets all tags included in this message's content.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -548,8 +529,7 @@
</span>
<a id="Discord_WebSocket_SocketUserMessage_ModifyAsync_" data-uid="Discord.WebSocket.SocketUserMessage.ModifyAsync*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_ModifyAsync_System_Action_Discord_MessageProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.ModifyAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">ModifyAsync(Action&lt;MessageProperties&gt;, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Modifies this message.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -568,14 +548,12 @@
<tr>
<td><span class="xref">System.Action</span>&lt;<a class="xref" href="Discord.MessageProperties.html">MessageProperties</a>&gt;</td>
<td><span class="parametername">func</span></td>
<td><p>A delegate containing the properties to modify the message with.</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>
@ -590,15 +568,10 @@
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous modification operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketUserMessage_ModifyAsync_System_Action_Discord_MessageProperties__Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method modifies this message with the specified properties. To see an example of this
method and what properties are available, please refer to <a class="xref" href="Discord.MessageProperties.html">MessageProperties</a>.</p>
</div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
@ -629,8 +602,7 @@ method and what properties are available, please refer to <a class="xref" href="
</span>
<a id="Discord_WebSocket_SocketUserMessage_ModifySuppressionAsync_" data-uid="Discord.WebSocket.SocketUserMessage.ModifySuppressionAsync*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_ModifySuppressionAsync_System_Boolean_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.ModifySuppressionAsync(System.Boolean,Discord.RequestOptions)">ModifySuppressionAsync(Boolean, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Modifies the suppression of this message.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -649,14 +621,12 @@ method and what properties are available, please refer to <a class="xref" href="
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">suppressEmbeds</span></td>
<td><p>Whether or not embeds in this message should be suppressed.</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>
@ -671,14 +641,10 @@ method and what properties are available, please refer to <a class="xref" href="
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous modification operation.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketUserMessage_ModifySuppressionAsync_System_Boolean_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method modifies whether or not embeds in this message are suppressed (hidden).</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_SocketUserMessage_PinAsync_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketUserMessage.PinAsync(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>
@ -688,8 +654,7 @@ method and what properties are available, please refer to <a class="xref" href="
</span>
<a id="Discord_WebSocket_SocketUserMessage_PinAsync_" data-uid="Discord.WebSocket.SocketUserMessage.PinAsync*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_PinAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.PinAsync(Discord.RequestOptions)">PinAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Adds this message to its channel's pinned messages.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -708,8 +673,7 @@ method and what properties are available, please refer to <a class="xref" href="
<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>
@ -724,8 +688,7 @@ method and what properties are available, please refer to <a class="xref" href="
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous operation for pinning this message.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -738,8 +701,7 @@ method and what properties are available, please refer to <a class="xref" href="
</span>
<a id="Discord_WebSocket_SocketUserMessage_Resolve_" data-uid="Discord.WebSocket.SocketUserMessage.Resolve*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_Resolve_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_" data-uid="Discord.WebSocket.SocketUserMessage.Resolve(Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling)">Resolve(TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)</h4>
<div class="markdown level1 summary"><p>Transforms this message's text into a human-readable form by resolving its tags.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -758,32 +720,27 @@ method and what properties are available, please refer to <a class="xref" href="
<tr>
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
<td><span class="parametername">userHandling</span></td>
<td><p>Determines how the user tag should be handled.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
<td><span class="parametername">channelHandling</span></td>
<td><p>Determines how the channel tag should be handled.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
<td><span class="parametername">roleHandling</span></td>
<td><p>Determines how the role tag should be handled.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
<td><span class="parametername">everyoneHandling</span></td>
<td><p>Determines how the @everyone tag should be handled.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
<td><span class="parametername">emojiHandling</span></td>
<td><p>Determines how the emoji tag should be handled.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
@ -883,8 +840,7 @@ method and what properties are available, please refer to <a class="xref" href="
</span>
<a id="Discord_WebSocket_SocketUserMessage_UnpinAsync_" data-uid="Discord.WebSocket.SocketUserMessage.UnpinAsync*"></a>
<h4 id="Discord_WebSocket_SocketUserMessage_UnpinAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.UnpinAsync(Discord.RequestOptions)">UnpinAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Removes this message from its channel's pinned messages.</p>
</div>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -903,8 +859,7 @@ method and what properties are available, please refer to <a class="xref" href="
<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>
@ -919,8 +874,7 @@ method and what properties are available, please refer to <a class="xref" href="
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous operation for unpinning this message.</p>
</td>
<td></td>
</tr>
</tbody>
</table>