From 44c526298e03cd71c9454378b26349b360503410 Mon Sep 17 00:00:00 2001 From: Casino Boyale Date: Thu, 12 Jul 2018 02:22:18 +0100 Subject: [PATCH] Added RestTextChannel documentation --- .../Entities/Channels/RestTextChannel.cs | 35 ++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs b/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs index f1a282dc9..b7409c180 100644 --- a/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs +++ b/src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs @@ -49,8 +49,25 @@ namespace Discord.Rest Update(model); } + /// + /// Gets a user that is able to view this channel from the associate . + /// + /// The snowflake identifier of the user you want to get. + /// The options to be used when sending the request. + /// + /// An awaitable containing a . + /// public Task GetUserAsync(ulong id, RequestOptions options = null) => ChannelHelper.GetUserAsync(this, Guild, Discord, id, options); + + /// + /// Gets the collection of users that can view this channel. + /// + /// The options to be used when sending the request. + /// + /// Paged collection of users. Flattening the paginated response into a collection of + /// with is required if you wish to access the users. + /// public IAsyncEnumerable> GetUsersAsync(RequestOptions options = null) => ChannelHelper.GetUsersAsync(this, Guild, Discord, null, null, options); @@ -128,7 +145,16 @@ namespace Discord.Rest /// public IDisposable EnterTypingState(RequestOptions options = null) => ChannelHelper.EnterTypingState(this, Discord, options); - + + /// + /// Creates a webhook for this channel. + /// + /// The name you want to give the webhook. + /// The avatar that you want the webook to have. + /// The options to be used when sending the request. + /// + /// An awaitable containing a . + /// public Task CreateWebhookAsync(string name, Stream avatar = null, RequestOptions options = null) => ChannelHelper.CreateWebhookAsync(this, Discord, name, avatar, options); public Task GetWebhookAsync(ulong id, RequestOptions options = null) @@ -136,6 +162,13 @@ namespace Discord.Rest public Task> GetWebhooksAsync(RequestOptions options = null) => ChannelHelper.GetWebhooksAsync(this, Discord, options); + /// + /// Gets the parent category of this channel. + /// + /// The options to be used when sending the request. + /// + /// An awaitable containing an . + /// public Task GetCategoryAsync(RequestOptions options = null) => ChannelHelper.GetCategoryAsync(this, Discord, options);