| @@ -1,34 +1,40 @@ | |||
| using System; | |||
| using System.Collections.Generic; | |||
| using System.Linq; | |||
| using System.Text; | |||
| using System.Threading.Tasks; | |||
| namespace Discord | |||
| { | |||
| /// <summary> | |||
| /// Represents an entry in an audit log | |||
| /// Represents an entry in an audit log. | |||
| /// </summary> | |||
| public interface IAuditLogEntry : IEntity<ulong> | |||
| { | |||
| /// <summary> | |||
| /// The action which occured to create this entry | |||
| /// Gets the action which occurred to create this entry. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// The type of action for this audit log entry. | |||
| /// </returns> | |||
| ActionType Action { get; } | |||
| /// <summary> | |||
| /// The data for this entry. May be <see cref="null"/> if no data was available. | |||
| /// Gets the data for this entry. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// An <see cref="IAuditLogData" /> for this audit log entry; <c>null</c> if no data is available. | |||
| /// </returns> | |||
| IAuditLogData Data { get; } | |||
| /// <summary> | |||
| /// The user responsible for causing the changes | |||
| /// Gets the user responsible for causing the changes. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A user object. | |||
| /// </returns> | |||
| IUser User { get; } | |||
| /// <summary> | |||
| /// The reason behind the change. May be <see cref="null"/> if no reason was provided. | |||
| /// Gets the reason behind the change. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A string containing the reason for the change; <c>null</c> if none is provided. | |||
| /// </returns> | |||
| string Reason { get; } | |||
| } | |||
| } | |||
| @@ -214,18 +214,20 @@ namespace Discord | |||
| /// Gets a ban object for a banned user. | |||
| /// </summary> | |||
| /// <param name="user">The banned user.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// An awaitable <see cref="Task"/> containing the ban object, which contains the user information and the | |||
| /// reason for the ban; <c>null<c/> if the ban entry cannot be found. | |||
| /// reason for the ban; <c>null</c> if the ban entry cannot be found. | |||
| /// </returns> | |||
| Task<IBan> GetBanAsync(IUser user, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Gets a ban object for a banned user. | |||
| /// </summary> | |||
| /// <param name="userId">The snowflake identifier for the banned user.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// An awaitable <see cref="Task"/> containing the ban object, which contains the user information and the | |||
| /// reason for the ban; <c>null<c/> if the ban entry cannot be found. | |||
| /// reason for the ban; <c>null</c> if the ban entry cannot be found. | |||
| /// </returns> | |||
| Task<IBan> GetBanAsync(ulong userId, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -406,10 +408,12 @@ namespace Discord | |||
| /// <c>null</c> if none is set. | |||
| /// </returns> | |||
| Task<IGuildChannel> GetEmbedChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Creates a new text channel. | |||
| /// </summary> | |||
| /// <param name="name">The new name for the text channel.</param> | |||
| /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// An awaitable <see cref="Task"/> containing the newly created text channel. | |||
| @@ -419,6 +423,7 @@ namespace Discord | |||
| /// Creates a new voice channel. | |||
| /// </summary> | |||
| /// <param name="name">The new name for the voice channel.</param> | |||
| /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// An awaitable <see cref="Task"/> containing the newly created voice channel. | |||
| @@ -428,6 +433,8 @@ namespace Discord | |||
| /// Creates a new channel category. | |||
| /// </summary> | |||
| /// <param name="name">The new name for the category.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// An awaitable <see cref="Task"/> containing the newly created category channel. | |||
| /// </returns> | |||
| Task<ICategoryChannel> CreateCategoryAsync(string name, RequestOptions options = null); | |||
| @@ -30,21 +30,21 @@ namespace Discord | |||
| /// <see cref="File.OpenRead"/>. | |||
| /// </remarks> | |||
| /// <param name="path">The path to the file.</param> | |||
| /// <exception cref="ArgumentException"> | |||
| /// <exception cref="System.ArgumentException"> | |||
| /// <paramref name="path" /> is a zero-length string, contains only white space, or contains one or more invalid | |||
| /// characters as defined by <see cref="Path.GetInvalidPathChars" />. | |||
| /// </exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="path" /> is <c>null</c>.</exception> | |||
| /// <exception cref="System.ArgumentNullException"><paramref name="path" /> is <c>null</c>.</exception> | |||
| /// <exception cref="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. | |||
| /// </exception> | |||
| /// <exception cref="NotSupportedException"><paramref name="path" /> is in an invalid format.</exception> | |||
| /// <exception cref="System.NotSupportedException"><paramref name="path" /> is in an invalid format.</exception> | |||
| /// <exception cref="DirectoryNotFoundException"> | |||
| /// The specified <paramref name="path"/> is invalid, (for example, it is on an unmapped drive). | |||
| /// </exception> | |||
| /// <exception cref="UnauthorizedAccessException"> | |||
| /// <exception cref="System.UnauthorizedAccessException"> | |||
| /// <paramref name="path" /> specified a directory.-or- The caller does not have the required permission. | |||
| /// </exception> | |||
| /// <exception cref="FileNotFoundException">The file specified in <paramref name="path" /> was not found. | |||