diff --git a/src/Discord.Net.Core/Entities/Channels/IChannel.cs b/src/Discord.Net.Core/Entities/Channels/IChannel.cs
index ea930e112..ce1d859a9 100644
--- a/src/Discord.Net.Core/Entities/Channels/IChannel.cs
+++ b/src/Discord.Net.Core/Entities/Channels/IChannel.cs
@@ -1,8 +1,9 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
using System.Threading.Tasks;
namespace Discord
{
+ /// Represents a generic Discord channel.
public interface IChannel : ISnowflakeEntity
{
/// Gets the name of this channel.
diff --git a/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs
index c9841cb15..e502d2287 100644
--- a/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs
+++ b/src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs
@@ -1,9 +1,10 @@
-using System;
+using System;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace Discord
{
+ /// Represents a guild channel. This includes a text channel, voice channel, and category channel.
public interface IGuildChannel : IChannel, IDeletable
{
/// Gets the position of this channel in the guild's channel list, relative to others of the same type.
@@ -49,4 +50,4 @@ namespace Discord
/// Gets a user in this channel with the provided id.
new Task GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
}
-}
\ No newline at end of file
+}
diff --git a/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs
index ec7615b55..8b5e9bb17 100644
--- a/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs
+++ b/src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs
@@ -15,13 +15,18 @@ namespace Discord.WebSocket
{
private readonly MessageCache _messages;
+ ///
public string Topic { get; private set; }
private bool _nsfw;
+ ///
public bool IsNsfw => _nsfw || ChannelHelper.IsNsfw(this);
+ ///
public string Mention => MentionUtils.MentionChannel(Id);
+ ///
public IReadOnlyCollection CachedMessages => _messages?.Messages ?? ImmutableArray.Create();
+ ///
public override IReadOnlyCollection Users
=> Guild.Users.Where(x => Permissions.GetValue(
Permissions.ResolveChannel(Guild, x, this, Permissions.ResolveGuild(Guild, x)),
@@ -47,10 +52,12 @@ namespace Discord.WebSocket
_nsfw = model.Nsfw.GetValueOrDefault();
}
+ ///
public Task ModifyAsync(Action func, RequestOptions options = null)
=> ChannelHelper.ModifyAsync(this, Discord, func, options);
//Messages
+ ///
public SocketMessage GetCachedMessage(ulong id)
=> _messages?.Get(id);
public async Task GetMessageAsync(ulong id, RequestOptions options = null)
@@ -100,6 +107,7 @@ namespace Discord.WebSocket
=> _messages?.Remove(id);
//Users
+ ///
public override SocketGuildUser GetUser(ulong id)
{
var user = Guild.GetUser(id);