Class RestDMChannel

Represents a REST-based direct-message channel.

Assembly: Discord.Net.Rest.dll

View Source

Declaration

public class RestDMChannel : RestChannel, IUpdateable, IDMChannel, IRestPrivateChannel, IPrivateChannel, IRestMessageChannel, IMessageChannel, IChannel, ISnowflakeEntity, IEntity<ulong>

Properties

CurrentUser

Gets the current logged-in user.

View Source

Declaration

public RestUser CurrentUser { get; }

Recipient

Gets the recipient of the channel.

View Source

Declaration

public RestUser Recipient { get; }

Users

Gets a collection that is the current logged-in user and the recipient.

View Source

Declaration

public IReadOnlyCollection<RestUser> Users { get; }

IDMChannel.Recipient

Gets the recipient of all messages in this channel.

View Source

Declaration

IUser IDMChannel.Recipient { get; }

IRestPrivateChannel.Recipients

Users that can access this channel.

View Source

Declaration

IReadOnlyCollection<RestUser> IRestPrivateChannel.Recipients { get; }

IPrivateChannel.Recipients

Gets the users that can access this channel.

View Source

Declaration

IReadOnlyCollection<IUser> IPrivateChannel.Recipients { get; }

IChannel.Name

Gets the name of this channel.

View Source

Declaration

string IChannel.Name { get; }

Methods

UpdateAsync(RequestOptions)

Updates this object's properties with its current state.

View Source

Declaration

public override async Task UpdateAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

CloseAsync(RequestOptions)

Closes this private channel, removing it from your channel list.

View Source

Declaration

public Task CloseAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous close operation.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

GetUser(UInt64)

Gets a user in this channel from the provided <code data-dev-comment-type="paramref" class="paramref">id</code>.

View Source

Declaration

public RestUser GetUser(ulong id)

Returns

Discord.Rest.RestUser: A Discord.Rest.RestUser object that is a recipient of this channel; otherwise null.

Parameters

Type	Name	Description
System.UInt64	id	The snowflake identifier of the user.

GetMessageAsync(UInt64, RequestOptions)

Gets a message from this message channel.

View Source

Declaration

public Task<RestMessage> GetMessageAsync(ulong id, RequestOptions options = null)

Returns

System.Threading.Tasks.Task<Discord.Rest.RestMessage>: A task that represents an asynchronous get operation for retrieving the message. The task result contains the retrieved message; null if no message is found with the specified identifier.

Parameters

Type	Name	Description
System.UInt64	id	The snowflake identifier of the message.
Discord.RequestOptions	options	The options to be used when sending the request.

GetMessagesAsync(Int32, RequestOptions)

Gets the last N messages from this message channel.

View Source

Declaration

public IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(int limit = 100, RequestOptions options = null)

Returns

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.Rest.RestMessage>>: Paged collection of messages.

Parameters

Type	Name	Description
System.Int32	limit	The numbers of message to be gotten from.
Discord.RequestOptions	options	The options to be used when sending the request.

GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)

Gets a collection of messages in this channel.

View Source

Declaration

public IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(ulong fromMessageId, Direction dir, int limit = 100, RequestOptions options = null)

Returns

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.Rest.RestMessage>>: Paged collection of messages.

Parameters

Type	Name	Description
System.UInt64	fromMessageId	The ID of the starting message to get the messages from.
Discord.Direction	dir	The direction of the messages to be gotten from.
System.Int32	limit	The numbers of message to be gotten from.
Discord.RequestOptions	options	The options to be used when sending the request.

GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)

Gets a collection of messages in this channel.

View Source

Declaration

public IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(IMessage fromMessage, Direction dir, int limit = 100, RequestOptions options = null)

Returns

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.Rest.RestMessage>>: Paged collection of messages.

Parameters

Type	Name	Description
Discord.IMessage	fromMessage	The starting message to get the messages from.
Discord.Direction	dir	The direction of the messages to be gotten from.
System.Int32	limit	The numbers of message to be gotten from.
Discord.RequestOptions	options	The options to be used when sending the request.

GetPinnedMessagesAsync(RequestOptions)

Gets a collection of pinned messages in this channel.

View Source

Declaration

public Task<IReadOnlyCollection<RestMessage>> GetPinnedMessagesAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<Discord.Rest.RestMessage>>: 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.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

SendMessageAsync(String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a message to this message channel.

View Source

Declaration

public Task<RestUserMessage> SendMessageAsync(string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent component = null, ISticker[] stickers = null, Embed[] embeds = null)

Returns

System.Threading.Tasks.Task<Discord.Rest.RestUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
System.String	text	The message to be sent.
System.Boolean	isTTS	Determines whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the message. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a file to this message channel with an optional caption.

View Source

Declaration

public Task<RestUserMessage> SendFileAsync(string filePath, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent component = null, ISticker[] stickers = null, Embed[] embeds = null)

Returns

System.Threading.Tasks.Task<Discord.Rest.RestUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
System.String	filePath	The file path of the file.
System.String	text	The message to be sent.
System.Boolean	isTTS	Whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
System.Boolean	isSpoiler	Whether the message attachment should be hidden as a spoiler.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the message. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a file to this message channel with an optional caption.

View Source

Declaration

public Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent component = null, ISticker[] stickers = null, Embed[] embeds = null)

Returns

System.Threading.Tasks.Task<Discord.Rest.RestUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
System.IO.Stream	stream	The System.IO.Stream of the file to be sent.
System.String	filename	The name of the attachment.
System.String	text	The message to be sent.
System.Boolean	isTTS	Whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
System.Boolean	isSpoiler	Whether the message attachment should be hidden as a spoiler.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the message. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

SendFileAsync(FileAttachment, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

View Source

Declaration

public Task<RestUserMessage> SendFileAsync(FileAttachment attachment, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent component = null, ISticker[] stickers = null, Embed[] embeds = null)

Returns

System.Threading.Tasks.Task<Discord.Rest.RestUserMessage>

Parameters

Type	Name
Discord.FileAttachment	attachment
System.String	text
System.Boolean	isTTS
Discord.Embed	embed
Discord.RequestOptions	options
Discord.AllowedMentions	allowedMentions
Discord.MessageReference	messageReference
Discord.MessageComponent	component
Discord.ISticker[]	stickers
Discord.Embed[]	embeds

SendFilesAsync(IEnumerable<FileAttachment>, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

View Source

Declaration

public Task<RestUserMessage> SendFilesAsync(IEnumerable<FileAttachment> attachments, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent component = null, ISticker[] stickers = null, Embed[] embeds = null)

Returns

System.Threading.Tasks.Task<Discord.Rest.RestUserMessage>

Parameters

Type	Name
System.Collections.Generic.IEnumerable<Discord.FileAttachment>	attachments
System.String	text
System.Boolean	isTTS
Discord.Embed	embed
Discord.RequestOptions	options
Discord.AllowedMentions	allowedMentions
Discord.MessageReference	messageReference
Discord.MessageComponent	component
Discord.ISticker[]	stickers
Discord.Embed[]	embeds

DeleteMessageAsync(UInt64, RequestOptions)

Deletes a message.

View Source

Declaration

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous removal operation.

Parameters

Type	Name	Description
System.UInt64	messageId	The snowflake identifier of the message that would be removed.
Discord.RequestOptions	options	The options to be used when sending the request.

DeleteMessageAsync(IMessage, RequestOptions)

Deletes a message based on the provided message in this channel.

View Source

Declaration

public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous removal operation.

Parameters

Type	Name	Description
Discord.IMessage	message	The message that would be removed.
Discord.RequestOptions	options	The options to be used when sending the request.

ModifyMessageAsync(UInt64, Action<MessageProperties>, RequestOptions)

Modifies a message.

View Source

Declaration

public async Task<IUserMessage> ModifyMessageAsync(ulong messageId, Action<MessageProperties> func, RequestOptions options = null)

Returns

System.Threading.Tasks.Task<Discord.IUserMessage>: A task that represents the asynchronous modification operation.

Parameters

Type	Name	Description
System.UInt64	messageId	The snowflake identifier of the message that would be changed.
System.Action<Discord.MessageProperties>	func	A delegate containing the properties to modify the message with.
Discord.RequestOptions	options	The options to be used when sending the request.

TriggerTypingAsync(RequestOptions)

Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.

View Source

Declaration

public Task TriggerTypingAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous operation that triggers the broadcast.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

EnterTypingState(RequestOptions)

Continuously broadcasts the "user is typing" message to all users in this channel until the returned object is disposed.

View Source

Declaration

public IDisposable EnterTypingState(RequestOptions options = null)

Returns

System.IDisposable: A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in this channel.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

ToString()

Gets a string that represents the Username#Discriminator of the recipient.

View Source

Declaration

public override string ToString()

Returns

System.String: A string that resolves to the Recipient of this channel.

IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)

Gets a message from this message channel.

View Source

Declaration

async Task<IMessage> IMessageChannel.GetMessageAsync(ulong id, CacheMode mode, RequestOptions options)

Returns

System.Threading.Tasks.Task<Discord.IMessage>: A task that represents an asynchronous get operation for retrieving the message. The task result contains the retrieved message; null if no message is found with the specified identifier.

Parameters

Type	Name	Description
System.UInt64	id	The snowflake identifier of the message.
Discord.CacheMode	mode	The Discord.CacheMode that determines whether the object should be fetched from cache.
Discord.RequestOptions	options	The options to be used when sending the request.

IMessageChannel.GetMessagesAsync(Int32, CacheMode, RequestOptions)

Gets the last N messages from this message channel.

View Source

Declaration

IAsyncEnumerable<IReadOnlyCollection<IMessage>> IMessageChannel.GetMessagesAsync(int limit, CacheMode mode, RequestOptions options)

Returns

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.IMessage>>: Paged collection of messages.

Parameters

Type	Name	Description
System.Int32	limit	The numbers of message to be gotten from.
Discord.CacheMode	mode	The Discord.CacheMode that determines whether the object should be fetched from
cache.
Discord.RequestOptions	options	The options to be used when sending the request.

IMessageChannel.GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions)

Gets a collection of messages in this channel.

View Source

Declaration

IAsyncEnumerable<IReadOnlyCollection<IMessage>> IMessageChannel.GetMessagesAsync(ulong fromMessageId, Direction dir, int limit, CacheMode mode, RequestOptions options)

Returns

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.IMessage>>: Paged collection of messages.

Parameters

Type	Name	Description
System.UInt64	fromMessageId	The ID of the starting message to get the messages from.
Discord.Direction	dir	The direction of the messages to be gotten from.
System.Int32	limit	The numbers of message to be gotten from.
Discord.CacheMode	mode	The Discord.CacheMode that determines whether the object should be fetched from
cache.
Discord.RequestOptions	options	The options to be used when sending the request.

IMessageChannel.GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions)

Gets a collection of messages in this channel.

View Source

Declaration

IAsyncEnumerable<IReadOnlyCollection<IMessage>> IMessageChannel.GetMessagesAsync(IMessage fromMessage, Direction dir, int limit, CacheMode mode, RequestOptions options)

Returns

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.IMessage>>: Paged collection of messages.

Parameters

Type	Name	Description
Discord.IMessage	fromMessage	The starting message to get the messages from.
Discord.Direction	dir	The direction of the messages to be gotten from.
System.Int32	limit	The numbers of message to be gotten from.
Discord.CacheMode	mode	The Discord.CacheMode that determines whether the object should be fetched from
cache.
Discord.RequestOptions	options	The options to be used when sending the request.

IMessageChannel.GetPinnedMessagesAsync(RequestOptions)

Gets a collection of pinned messages in this channel.

View Source

Declaration

async Task<IReadOnlyCollection<IMessage>> IMessageChannel.GetPinnedMessagesAsync(RequestOptions options)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<Discord.IMessage>>: 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.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a file to this message channel with an optional caption.

View Source

Declaration

async Task<IUserMessage> IMessageChannel.SendFileAsync(string filePath, string text, bool isTTS, Embed embed, RequestOptions options, bool isSpoiler, AllowedMentions allowedMentions, MessageReference messageReference, MessageComponent component, ISticker[] stickers, Embed[] embeds)

Returns

System.Threading.Tasks.Task<Discord.IUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
System.String	filePath	The file path of the file.
System.String	text	The message to be sent.
System.Boolean	isTTS	Whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
System.Boolean	isSpoiler	Whether the message attachment should be hidden as a spoiler.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the file. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a file to this message channel with an optional caption.

View Source

Declaration

async Task<IUserMessage> IMessageChannel.SendFileAsync(Stream stream, string filename, string text, bool isTTS, Embed embed, RequestOptions options, bool isSpoiler, AllowedMentions allowedMentions, MessageReference messageReference, MessageComponent component, ISticker[] stickers, Embed[] embeds)

Returns

System.Threading.Tasks.Task<Discord.IUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
System.IO.Stream	stream	The System.IO.Stream of the file to be sent.
System.String	filename	The name of the attachment.
System.String	text	The message to be sent.
System.Boolean	isTTS	Whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
System.Boolean	isSpoiler	Whether the message attachment should be hidden as a spoiler.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the file. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

IMessageChannel.SendFileAsync(FileAttachment, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a file to this message channel with an optional caption.

View Source

Declaration

async Task<IUserMessage> IMessageChannel.SendFileAsync(FileAttachment attachment, string text, bool isTTS, Embed embed, RequestOptions options, AllowedMentions allowedMentions, MessageReference messageReference, MessageComponent component, ISticker[] stickers, Embed[] embeds)

Returns

System.Threading.Tasks.Task<Discord.IUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
Discord.FileAttachment	attachment	The attachment containing the file and description.
System.String	text	The message to be sent.
System.Boolean	isTTS	Whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the file. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

IMessageChannel.SendFilesAsync(IEnumerable<FileAttachment>, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a collection of files to this message channel.

View Source

Declaration

async Task<IUserMessage> IMessageChannel.SendFilesAsync(IEnumerable<FileAttachment> attachments, string text, bool isTTS, Embed embed, RequestOptions options, AllowedMentions allowedMentions, MessageReference messageReference, MessageComponent component, ISticker[] stickers, Embed[] embeds)

Returns

System.Threading.Tasks.Task<Discord.IUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<Discord.FileAttachment>	attachments	A collection of attachments to upload.
System.String	text	The message to be sent.
System.Boolean	isTTS	Whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the file. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[])

Sends a message to this message channel.

View Source

Declaration

async Task<IUserMessage> IMessageChannel.SendMessageAsync(string text, bool isTTS, Embed embed, RequestOptions options, AllowedMentions allowedMentions, MessageReference messageReference, MessageComponent component, ISticker[] stickers, Embed[] embeds)

Returns

System.Threading.Tasks.Task<Discord.IUserMessage>: A task that represents an asynchronous send operation for delivering the message. The task result contains the sent message.

Parameters

Type	Name	Description
System.String	text	The message to be sent.
System.Boolean	isTTS	Determines whether the message should be read aloud by Discord or not.
Discord.Embed	embed	The Discord.EmbedType.Rich Discord.Embed to be sent.
Discord.RequestOptions	options	The options to be used when sending the request.
Discord.AllowedMentions	allowedMentions

Specifies if notifications are sent for mentioned users and roles in the message <code data-dev-comment-type="paramref" class="paramref">text</code>. If null, all mentioned roles and users will be notified. | | Discord.MessageReference | messageReference | The message references to be included. Used to reply to specific messages. | | Discord.MessageComponent | component | The message components to be included with this message. Used for interactions. | | Discord.ISticker[] | stickers | A collection of stickers to send with the message. | | Discord.Embed[] | embeds | A array of Discord.Embeds to send with this response. Max 10. |

IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

Gets a user in this channel.

View Source

Declaration

Task<IUser> IChannel.GetUserAsync(ulong id, CacheMode mode, RequestOptions options)

Returns

System.Threading.Tasks.Task<Discord.IUser>: A task that represents the asynchronous get operation. The task result contains a user object that represents the found user; null if none is found.

Parameters

Type	Name	Description
System.UInt64	id	The snowflake identifier of the user (e.g. 168693960628371456).
Discord.CacheMode	mode	The Discord.CacheMode that determines whether the object should be fetched from cache.
Discord.RequestOptions	options	The options to be used when sending the request.

IChannel.GetUsersAsync(CacheMode, RequestOptions)

Gets a collection of users that are able to view the channel or are currently in this channel.

View Source

Declaration

IAsyncEnumerable<IReadOnlyCollection<IUser>> IChannel.GetUsersAsync(CacheMode mode, RequestOptions options)

Returns

System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.IUser>>: Paged collection of users.

Parameters

Type	Name	Description
Discord.CacheMode	mode	The Discord.CacheMode that determines whether the object should be fetched from cache.
Discord.RequestOptions	options	The options to be used when sending the request.

Implements

• Discord.IUpdateable
• Discord.IDMChannel
• Discord.Rest.IRestPrivateChannel
• Discord.IPrivateChannel
• Discord.Rest.IRestMessageChannel
• Discord.IMessageChannel
• Discord.IChannel
• Discord.ISnowflakeEntity
• Discord.IEntity<TId>