Browse Source

Add documentation for new INestedChannel

pull/1161/head
Still Hsu 7 years ago
parent
commit
180b20dd02
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
1 changed files with 16 additions and 4 deletions
  1. +16
    -4
      src/Discord.Net.Core/Entities/Channels/INestedChannel.cs

+ 16
- 4
src/Discord.Net.Core/Entities/Channels/INestedChannel.cs View File

@@ -3,14 +3,26 @@ using System.Threading.Tasks;
namespace Discord namespace Discord
{ {
/// <summary> /// <summary>
/// A type of guild channel that can be nested within a category.
/// Contains a CategoryId that is set to the parent category, if it is set.
/// Represents a type of guild channel that can be nested within a category.
/// </summary> /// </summary>
public interface INestedChannel : IGuildChannel public interface INestedChannel : IGuildChannel
{ {
/// <summary> Gets the parentid (category) of this channel in the guild's channel list. </summary>
/// <summary>
/// Gets the parent (category) ID of this channel in the guild's channel list.
/// </summary>
/// <returns>
/// An <see cref="System.UInt64"/> representing the snowflake identifier of the parent of this channel;
/// <c>null</c> if none is set.
/// </returns>
ulong? CategoryId { get; } ulong? CategoryId { get; }
/// <summary> Gets the parent channel (category) of this channel, if it is set. If unset, returns null.</summary>
/// <summary>
/// Gets the parent (category) channel of this channel.
/// </summary>
/// <param name="mode">The <see cref="CacheMode"/> that determines whether the object should be fetched from cache.</param>
/// <param name="options">The options to be used when sending the request.</param>
/// <remarks>
/// A generic category channel representing the parent of this channel; <c>null</c> if none is set.
/// </remarks>
Task<ICategoryChannel> GetCategoryAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); Task<ICategoryChannel> GetCategoryAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);
} }
} }

Loading…
Cancel
Save