Class RestTextChannel

Represents a REST-based channel in a guild that can send and receive messages.

Inheritance

System.Object

RestEntity<System.UInt64>

RestChannel

RestGuildChannel

RestTextChannel

RestNewsChannel

Implements

IUpdateable

IRestMessageChannel

ITextChannel

IMessageChannel

IMentionable

INestedChannel

IGuildChannel

IChannel

ISnowflakeEntity

IEntity<System.UInt64>

IDeletable

Inherited Members

RestGuildChannel.PermissionOverwrites

RestGuildChannel.Name

RestGuildChannel.Position

RestGuildChannel.GuildId

RestGuildChannel.UpdateAsync(RequestOptions)

RestGuildChannel.ModifyAsync(Action<GuildChannelProperties>, RequestOptions)

RestGuildChannel.DeleteAsync(RequestOptions)

RestGuildChannel.GetPermissionOverwrite(IUser)

RestGuildChannel.GetPermissionOverwrite(IRole)

RestGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)

RestGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)

RestGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)

RestGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)

RestGuildChannel.ToString()

RestGuildChannel.IGuildChannel.Guild

RestGuildChannel.IGuildChannel.GetPermissionOverwrite(IRole)

RestGuildChannel.IGuildChannel.GetPermissionOverwrite(IUser)

RestGuildChannel.IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)

RestGuildChannel.IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)

RestGuildChannel.IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)

RestGuildChannel.IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)

RestChannel.CreatedAt

RestChannel.IChannel.Name

RestEntity<UInt64>.Id

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Discord.Rest

Assembly: Discord.Net.Rest.dll

Syntax

public class RestTextChannel : RestGuildChannel, IUpdateable, IRestMessageChannel, ITextChannel, IMessageChannel, IMentionable, INestedChannel, IGuildChannel, IChannel, ISnowflakeEntity, IEntity<ulong>, IDeletable

Properties

CategoryId

Declaration

public ulong? CategoryId { get; }

Property Value

Type	Description
System.Nullable<System.UInt64>

IsNsfw

Declaration

public bool IsNsfw { get; }

Property Value

Type	Description
System.Boolean

Mention

Declaration

public string Mention { get; }

Property Value

Type	Description
System.String

SlowModeInterval

Declaration

public virtual int SlowModeInterval { get; }

Property Value

Type	Description
System.Int32

Topic

Declaration

public string Topic { get; }

Property Value

Type	Description
System.String

Methods

CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

Declaration

public Task<IInviteMetadata> CreateInviteAsync(int? maxAge, int? maxUses = default(int? ), bool isTemporary = false, bool isUnique = false, RequestOptions options = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	maxAge
System.Nullable<System.Int32>	maxUses
System.Boolean	isTemporary
System.Boolean	isUnique
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<IInviteMetadata>

CreateWebhookAsync(String, Stream, RequestOptions)

Creates a webhook in this text channel.

Declaration

public Task<RestWebhook> CreateWebhookAsync(string name, Stream avatar = null, RequestOptions options = null)

Parameters

Type	Name	Description
System.String	name	The name of the webhook.
System.IO.Stream	avatar	The avatar of the webhook.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
System.Threading.Tasks.Task<RestWebhook>	A task that represents the asynchronous creation operation. The task result contains the newly created webhook.

DeleteMessageAsync(IMessage, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
IMessage	message
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task

DeleteMessageAsync(UInt64, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
System.UInt64	messageId
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task

DeleteMessagesAsync(IEnumerable<IMessage>, RequestOptions)

Declaration

public Task DeleteMessagesAsync(IEnumerable<IMessage> messages, RequestOptions options = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IMessage>	messages
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task

DeleteMessagesAsync(IEnumerable<UInt64>, RequestOptions)

Declaration

public Task DeleteMessagesAsync(IEnumerable<ulong> messageIds, RequestOptions options = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.UInt64>	messageIds
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task

EnterTypingState(RequestOptions)

Declaration

public IDisposable EnterTypingState(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
System.IDisposable

GetCategoryAsync(RequestOptions)

Gets the parent (category) channel of this channel.

Declaration

public Task<ICategoryChannel> GetCategoryAsync(RequestOptions options = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<ICategoryChannel>	A task that represents the asynchronous get operation. The task result contains the category channel representing the parent of this channel; null if none is set.

GetInvitesAsync(RequestOptions)

Declaration

public Task<IReadOnlyCollection<IInviteMetadata>> GetInvitesAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>>

GetMessageAsync(UInt64, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
System.UInt64	id
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<RestMessage>

GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
IMessage	fromMessage
Direction	dir
System.Int32	limit
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>>

GetMessagesAsync(Int32, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
System.Int32	limit
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>>

GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
System.UInt64	fromMessageId
Direction	dir
System.Int32	limit
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>>

GetPinnedMessagesAsync(RequestOptions)

Declaration

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

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestMessage>>

GetUserAsync(UInt64, RequestOptions)

Gets a user in this channel.

Declaration

public Task<RestGuildUser> GetUserAsync(ulong id, RequestOptions options = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestGuildUser>	A task representing the asynchronous get operation. The task result contains a guild user object that represents the user; null if none is found.

Exceptions

Type	Condition
System.InvalidOperationException	Resolving permissions requires the parent guild to be downloaded.

GetUsersAsync(RequestOptions)

Gets a collection of users that are able to view the channel.

Declaration

public IAsyncEnumerable<IReadOnlyCollection<RestGuildUser>> GetUsersAsync(RequestOptions options = null)

Parameters

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

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestGuildUser>>	A paged collection containing a collection of guild users that can access this channel. Flattening the paginated response into a collection of users with FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) is required if you wish to access the users.

Exceptions

Type	Condition
System.InvalidOperationException	Resolving permissions requires the parent guild to be downloaded.

GetWebhookAsync(UInt64, RequestOptions)

Gets a webhook available in this text channel.

Declaration

public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestWebhook>	A task that represents the asynchronous get operation. The task result contains a webhook associated with the identifier; null if the webhook is not found.

GetWebhooksAsync(RequestOptions)

Gets the webhooks available in this text channel.

Declaration

public Task<IReadOnlyCollection<RestWebhook>> GetWebhooksAsync(RequestOptions options = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestWebhook>>	A task that represents the asynchronous get operation. The task result contains a read-only collection of webhooks that is available in this channel.

ModifyAsync(Action<TextChannelProperties>, RequestOptions)

Declaration

public Task ModifyAsync(Action<TextChannelProperties> func, RequestOptions options = null)

Parameters

Type	Name	Description
System.Action<TextChannelProperties>	func
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task

SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

Declaration

public Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false)

Parameters

Type	Name	Description
System.IO.Stream	stream
System.String	filename
System.String	text
System.Boolean	isTTS
Embed	embed
RequestOptions	options
System.Boolean	isSpoiler

Returns

Type	Description
System.Threading.Tasks.Task<RestUserMessage>

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Message content is too long, length must be less or equal to MaxMessageSize.

SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

Declaration

public Task<RestUserMessage> SendFileAsync(string filePath, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false)

Parameters

Type	Name	Description
System.String	filePath
System.String	text
System.Boolean	isTTS
Embed	embed
RequestOptions	options
System.Boolean	isSpoiler

Returns

Type	Description
System.Threading.Tasks.Task<RestUserMessage>

Exceptions

Type	Condition
System.ArgumentException	filePath is a zero-length string, contains only white space, or contains one or more invalid characters as defined by System.IO.Path.GetInvalidPathChars.
System.ArgumentNullException	filePath is null.
System.IO.PathTooLongException	The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
System.IO.DirectoryNotFoundException	The specified path is invalid, (for example, it is on an unmapped drive).
System.UnauthorizedAccessException	filePath specified a directory.-or- The caller does not have the required permission.
System.IO.FileNotFoundException	The file specified in filePath was not found.
System.NotSupportedException	filePath is in an invalid format.
System.IO.IOException	An I/O error occurred while opening the file.
System.ArgumentOutOfRangeException	Message content is too long, length must be less or equal to MaxMessageSize.

SendMessageAsync(String, Boolean, Embed, RequestOptions)

Declaration

public Task<RestUserMessage> SendMessageAsync(string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null)

Parameters

Type	Name	Description
System.String	text
System.Boolean	isTTS
Embed	embed
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<RestUserMessage>

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Message content is too long, length must be less or equal to MaxMessageSize.

SyncPermissionsAsync(RequestOptions)

Declaration

public Task SyncPermissionsAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task

TriggerTypingAsync(RequestOptions)

Declaration

public Task TriggerTypingAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task

Explicit Interface Implementations

IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
System.UInt64	id
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<IUser>

IChannel.GetUsersAsync(CacheMode, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>>

IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

Declaration

Task<IGuildUser> IGuildChannel.GetUserAsync(ulong id, CacheMode mode, RequestOptions options)

Parameters

Type	Name	Description
System.UInt64	id
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<IGuildUser>

IGuildChannel.GetUsersAsync(CacheMode, RequestOptions)

Declaration

IAsyncEnumerable<IReadOnlyCollection<IGuildUser>> IGuildChannel.GetUsersAsync(CacheMode mode, RequestOptions options)

Parameters

Type	Name	Description
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IGuildUser>>

IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
System.UInt64	id
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<IMessage>

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

Declaration

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

Parameters

Type	Name	Description
IMessage	fromMessage
Direction	dir
System.Int32	limit
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>>

IMessageChannel.GetMessagesAsync(Int32, CacheMode, RequestOptions)

Declaration

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

Parameters

Type	Name	Description
System.Int32	limit
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>>

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

Declaration

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

Parameters

Type	Name	Description
System.UInt64	fromMessageId
Direction	dir
System.Int32	limit
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>>

IMessageChannel.GetPinnedMessagesAsync(RequestOptions)

Declaration

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

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IMessage>>

IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

Declaration

Task<IUserMessage> IMessageChannel.SendFileAsync(Stream stream, string filename, string text, bool isTTS, Embed embed, RequestOptions options, bool isSpoiler)

Parameters

Type	Name	Description
System.IO.Stream	stream
System.String	filename
System.String	text
System.Boolean	isTTS
Embed	embed
RequestOptions	options
System.Boolean	isSpoiler

Returns

Type	Description
System.Threading.Tasks.Task<IUserMessage>

IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

Declaration

Task<IUserMessage> IMessageChannel.SendFileAsync(string filePath, string text, bool isTTS, Embed embed, RequestOptions options, bool isSpoiler)

Parameters

Type	Name	Description
System.String	filePath
System.String	text
System.Boolean	isTTS
Embed	embed
RequestOptions	options
System.Boolean	isSpoiler

Returns

Type	Description
System.Threading.Tasks.Task<IUserMessage>

IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)

Declaration

Task<IUserMessage> IMessageChannel.SendMessageAsync(string text, bool isTTS, Embed embed, RequestOptions options)

Parameters

Type	Name	Description
System.String	text
System.Boolean	isTTS
Embed	embed
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<IUserMessage>

INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)

Declaration

Task<ICategoryChannel> INestedChannel.GetCategoryAsync(CacheMode mode, RequestOptions options)

Parameters

Type	Name	Description
CacheMode	mode
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<ICategoryChannel>

ITextChannel.CreateWebhookAsync(String, Stream, RequestOptions)

Declaration

Task<IWebhook> ITextChannel.CreateWebhookAsync(string name, Stream avatar, RequestOptions options)

Parameters

Type	Name	Description
System.String	name
System.IO.Stream	avatar
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<IWebhook>

ITextChannel.GetWebhookAsync(UInt64, RequestOptions)

Declaration

Task<IWebhook> ITextChannel.GetWebhookAsync(ulong id, RequestOptions options)

Parameters

Type	Name	Description
System.UInt64	id
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<IWebhook>

ITextChannel.GetWebhooksAsync(RequestOptions)

Declaration

Task<IReadOnlyCollection<IWebhook>> ITextChannel.GetWebhooksAsync(RequestOptions options)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IWebhook>>

Implements

IUpdateable

IRestMessageChannel

ITextChannel

IMessageChannel

IMentionable

INestedChannel

IGuildChannel

IChannel

ISnowflakeEntity

IEntity<TId>

IDeletable