mirror of
https://github.com/goatcorp/Dalamud.git
synced 2026-01-03 14:23:40 +01:00
docs: regenerate
This commit is contained in:
parent
39a7afa4b6
commit
94571bb41b
71 changed files with 3254 additions and 7339 deletions
|
|
@ -138,8 +138,7 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_CachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.CachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_CachedMessages" data-uid="Discord.WebSocket.SocketDMChannel.CachedMessages">CachedMessages</h4>
|
||||
<div class="markdown level1 summary"><p>Gets all messages in this channel's cache.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -156,8 +155,7 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -234,8 +232,7 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_CloseAsync_" data-uid="Discord.WebSocket.SocketDMChannel.CloseAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_CloseAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.CloseAsync(Discord.RequestOptions)">CloseAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Closes this private channel, removing it from your channel list.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -254,8 +251,7 @@
|
|||
<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>
|
||||
|
|
@ -270,8 +266,7 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td><p>A task that represents the asynchronous close operation.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -284,8 +279,7 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_Discord_IMessage_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">DeleteMessageAsync(IMessage, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Deletes a message based on the provided message 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">
|
||||
|
|
@ -304,14 +298,12 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IMessage.html">IMessage</a></td>
|
||||
<td><span class="parametername">message</span></td>
|
||||
<td><p>The message that would be removed.</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>
|
||||
|
|
@ -326,8 +318,7 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -340,8 +331,7 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_System_UInt64_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">DeleteMessageAsync(UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Deletes a message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -360,14 +350,12 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">messageId</span></td>
|
||||
<td><p>The snowflake identifier of the message that would be removed.</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>
|
||||
|
|
@ -382,8 +370,7 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -396,9 +383,7 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_EnterTypingState_" data-uid="Discord.WebSocket.SocketDMChannel.EnterTypingState*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_EnterTypingState_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.EnterTypingState(Discord.RequestOptions)">EnterTypingState(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Continuously broadcasts the "user is typing" message to all users in this channel until the returned
|
||||
object is disposed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -417,8 +402,7 @@ object is disposed.</p>
|
|||
<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>
|
||||
|
|
@ -433,9 +417,7 @@ object is disposed.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.IDisposable</span></td>
|
||||
<td><p>A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in
|
||||
this channel.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -448,8 +430,7 @@ this channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessage_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessage*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessage_System_UInt64_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessage(System.UInt64)">GetCachedMessage(UInt64)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a cached message from this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -468,8 +449,7 @@ this channel.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td><p>The snowflake identifier of the message.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -484,23 +464,10 @@ this channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a></td>
|
||||
<td><p>A WebSocket-based message object; <code>null</code> if it does not exist in the cache or if caching is not
|
||||
enabled.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessage_System_UInt64__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return <code>null</code>. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This message may be a message that has been deleted.
|
||||
</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_SocketDMChannel_GetCachedMessages_Discord_IMessage_Discord_Direction_System_Int32_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetCachedMessages(Discord.IMessage%2CDiscord.Direction%2CSystem.Int32)%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>
|
||||
|
|
@ -510,8 +477,7 @@ enabled.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_Discord_IMessage_Discord_Direction_System_Int32_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages(Discord.IMessage,Discord.Direction,System.Int32)">GetCachedMessages(IMessage, Direction, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the last N cached messages starting from a certain message in this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -530,20 +496,17 @@ enabled.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IMessage.html">IMessage</a></td>
|
||||
<td><span class="parametername">fromMessage</span></td>
|
||||
<td><p>The message to start the fetching from.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Direction.html">Direction</a></td>
|
||||
<td><span class="parametername">dir</span></td>
|
||||
<td><p>The direction of which the message should be gotten from.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td><p>The number of messages to get.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -558,24 +521,10 @@ enabled.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_Discord_IMessage_Discord_Direction_System_Int32__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return an empty collection. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message(s) from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This read-only collection may include messages that have been deleted. The
|
||||
maximum number of messages that can be retrieved from this method depends on the
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> set.
|
||||
</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_SocketDMChannel_GetCachedMessages_System_Int32_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.Int32)%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>
|
||||
|
|
@ -585,8 +534,7 @@ enabled.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_Int32_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.Int32)">GetCachedMessages(Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the last N cached messages from this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -605,8 +553,7 @@ enabled.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td><p>The number of messages to get.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -621,24 +568,10 @@ enabled.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_Int32__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return an empty collection. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message(s) from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This read-only collection may include messages that have been deleted. The
|
||||
maximum number of messages that can be retrieved from this method depends on the
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> set.
|
||||
</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_SocketDMChannel_GetCachedMessages_System_UInt64_Discord_Direction_System_Int32_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.UInt64%2CDiscord.Direction%2CSystem.Int32)%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>
|
||||
|
|
@ -648,8 +581,7 @@ enabled.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_UInt64_Discord_Direction_System_Int32_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.UInt64,Discord.Direction,System.Int32)">GetCachedMessages(UInt64, Direction, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the last N cached messages starting from a certain message in this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -668,20 +600,17 @@ enabled.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">fromMessageId</span></td>
|
||||
<td><p>The message ID to start the fetching from.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Direction.html">Direction</a></td>
|
||||
<td><span class="parametername">dir</span></td>
|
||||
<td><p>The direction of which the message should be gotten from.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td><p>The number of messages to get.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -696,24 +625,10 @@ enabled.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_UInt64_Discord_Direction_System_Int32__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return an empty collection. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message(s) from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This read-only collection may include messages that have been deleted. The
|
||||
maximum number of messages that can be retrieved from this method depends on the
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> set.
|
||||
</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_SocketDMChannel_GetMessageAsync_System_UInt64_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetMessageAsync(System.UInt64%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>
|
||||
|
|
@ -983,8 +898,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetPinnedMessagesAsync_" data-uid="Discord.WebSocket.SocketDMChannel.GetPinnedMessagesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetPinnedMessagesAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">GetPinnedMessagesAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a read-only collection of pinned messages 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">
|
||||
|
|
@ -1003,8 +917,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
<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>
|
||||
|
|
@ -1019,16 +932,10 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a>>></td>
|
||||
<td><p>A task that represents the asynchronous get operation for retrieving pinned messages in this channel.
|
||||
The task result contains a read-only collection of messages found in the pinned messages.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetPinnedMessagesAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_GetPinnedMessagesAsync_Discord_RequestOptions_">GetPinnedMessagesAsync(RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_SocketDMChannel_GetUser_System_UInt64_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetUser(System.UInt64)%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>
|
||||
|
|
@ -1088,8 +995,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1108,44 +1014,37 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">stream</span></td>
|
||||
<td><p>The <span class="xref">System.IO.Stream</span> of the file to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filename</span></td>
|
||||
<td><p>The name of the attachment.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</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>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1160,16 +1059,10 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_">SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</a>.
|
||||
Please visit its documentation for more details on this method.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -1195,8 +1088,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1215,38 +1107,32 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filePath</span></td>
|
||||
<td><p>The file path of the file.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</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>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1261,16 +1147,10 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_">SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</a>.
|
||||
Please visit its documentation for more details on this method.</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_SocketDMChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.SendMessageAsync(System.String%2CSystem.Boolean%2CDiscord.Embed%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>
|
||||
|
|
@ -1280,8 +1160,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_SendMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.SendMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions)">SendMessageAsync(String, Boolean, Embed, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends a message to this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1300,26 +1179,22 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td><p>Determines whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</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>
|
||||
|
|
@ -1334,16 +1209,10 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_">SendMessageAsync(String, Boolean, Embed, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -1402,8 +1271,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_TriggerTypingAsync_" data-uid="Discord.WebSocket.SocketDMChannel.TriggerTypingAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_TriggerTypingAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.TriggerTypingAsync(Discord.RequestOptions)">TriggerTypingAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1422,8 +1290,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
<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>
|
||||
|
|
@ -1438,8 +1305,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td><p>A task that represents the asynchronous operation that triggers the broadcast.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1454,8 +1320,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.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">
|
||||
|
|
@ -1474,20 +1339,17 @@ Please visit its documentation for more details on this method.</p>
|
|||
<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>
|
||||
|
|
@ -1502,9 +1364,7 @@ Please visit its documentation for more details on this method.</p>
|
|||
<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>
|
||||
|
|
@ -1517,8 +1377,7 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_Name_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IChannel#Name*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_Name" data-uid="Discord.WebSocket.SocketDMChannel.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">
|
||||
|
|
@ -1535,8 +1394,7 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
<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>
|
||||
|
|
@ -1549,8 +1407,7 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IDMChannel_Recipient_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IDMChannel#Recipient*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IDMChannel_Recipient" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IDMChannel#Recipient">IDMChannel.Recipient</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the recipient of all messages 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">
|
||||
|
|
@ -1567,8 +1424,7 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><p>A user object that represents the other user in this channel.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1581,8 +1437,7 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetMessageAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a message from this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1601,20 +1456,17 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td><p>The snowflake identifier of the message.</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>
|
||||
|
|
@ -1629,9 +1481,7 @@ represents the found user; <code>null</code> if none is found.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IMessage.html">IMessage</a>></td>
|
||||
<td><p>A task that represents an asynchronous get operation for retrieving the message. The task result contains
|
||||
the retrieved message; <code>null</code> if no message is found with the specified identifier.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1644,8 +1494,7 @@ the retrieved message; <code>null</code> if no message is found with the specifi
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetPinnedMessagesAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetPinnedMessagesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetPinnedMessagesAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetPinnedMessagesAsync(Discord.RequestOptions)">IMessageChannel.GetPinnedMessagesAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of pinned messages 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">
|
||||
|
|
@ -1664,8 +1513,7 @@ the retrieved message; <code>null</code> if no message is found with the specifi
|
|||
<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>
|
||||
|
|
@ -1680,9 +1528,7 @@ the retrieved message; <code>null</code> if no message is found with the specifi
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IMessage.html">IMessage</a>>></td>
|
||||
<td><p>A task that represents the asynchronous get operation for retrieving pinned messages in this channel.
|
||||
The task result contains a collection of messages found in the pinned messages.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1695,8 +1541,7 @@ The task result contains a collection of messages found in the pinned messages.<
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1715,44 +1560,37 @@ The task result contains a collection of messages found in the pinned messages.<
|
|||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">stream</span></td>
|
||||
<td><p>The <span class="xref">System.IO.Stream</span> of the file to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filename</span></td>
|
||||
<td><p>The name of the attachment.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</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>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1767,20 +1605,10 @@ The task result contains a collection of messages found in the pinned messages.<
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method sends a file as if you are uploading an attachment directly from your Discord client.</p>
|
||||
<div class="NOTE"><h5>note</h5><p>
|
||||
If you wish to upload an image and have it embedded in a <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> embed,
|
||||
you may upload the file and refer to the file with "attachment://filename.ext" in the
|
||||
<a class="xref" href="Discord.EmbedBuilder.html#Discord_EmbedBuilder_ImageUrl">ImageUrl</a>. See the example section for its usage.
|
||||
</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_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.Discord%23IMessageChannel%23SendFileAsync(System.String%2CSystem.String%2CSystem.Boolean%2CDiscord.Embed%2CDiscord.RequestOptions%2CSystem.Boolean)%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>
|
||||
|
|
@ -1790,8 +1618,7 @@ contains the sent message.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1810,38 +1637,32 @@ contains the sent message.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filePath</span></td>
|
||||
<td><p>The file path of the file.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</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>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1856,20 +1677,10 @@ contains the sent message.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method sends a file as if you are uploading an attachment directly from your Discord client.</p>
|
||||
<div class="NOTE"><h5>note</h5><p>
|
||||
If you wish to upload an image and have it embedded in a <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> embed,
|
||||
you may upload the file and refer to the file with "attachment://filename.ext" in the
|
||||
<a class="xref" href="Discord.EmbedBuilder.html#Discord_EmbedBuilder_ImageUrl">ImageUrl</a>. See the example section for its usage.
|
||||
</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_SocketDMChannel_Discord_IMessageChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.Discord%23IMessageChannel%23SendMessageAsync(System.String%2CSystem.Boolean%2CDiscord.Embed%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>
|
||||
|
|
@ -1879,8 +1690,7 @@ contains the sent message.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions)">IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"><p>Sends a message to this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1899,26 +1709,22 @@ contains the sent message.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td><p>Determines whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</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>
|
||||
|
|
@ -1933,9 +1739,7 @@ contains the sent message.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1948,8 +1752,7 @@ contains the sent message.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IPrivateChannel_Recipients_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IPrivateChannel#Recipients*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IPrivateChannel_Recipients" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IPrivateChannel#Recipients">IPrivateChannel.Recipients</h4>
|
||||
<div class="markdown level1 summary"><p>Gets the users that can access this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1966,8 +1769,7 @@ contains the sent message.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td><p>A read-only collection of users that can access this channel.</p>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue