diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/BanAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/BanAuditLogData.cs index 2e5331d59..fc807cac0 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/BanAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/BanAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to a ban. + /// Contains a piece of audit log data related to a ban. /// public class BanAuditLogData : IAuditLogData { diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs index ffd620e04..ae081b1cc 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelCreateAuditLogData.cs @@ -7,7 +7,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to a channel creation. + /// Contains a piece of audit log data related to a channel creation. /// public class ChannelCreateAuditLogData : IAuditLogData { @@ -50,7 +50,7 @@ namespace Discord.Rest /// Gets the snowflake ID of the created channel. /// /// - /// An representing the snowflake identifier for the created channel. + /// A representing the snowflake identifier for the created channel. /// public ulong ChannelId { get; } /// @@ -71,7 +71,8 @@ namespace Discord.Rest /// Gets a collection of permission overwrites that was assigned to the created channel. /// /// - /// A collection of permission . + /// A collection of permission , containing the permission overwrites that were + /// assigned to the created channel. /// public IReadOnlyCollection Overwrites { get; } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs index c56bf6d32..ea03f4aef 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelDeleteAuditLogData.cs @@ -7,7 +7,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to a channel deletion. + /// Contains a piece of audit log data related to a channel deletion. /// public class ChannelDeleteAuditLogData : IAuditLogData { @@ -41,7 +41,7 @@ namespace Discord.Rest /// Gets the snowflake ID of the deleted channel. /// /// - /// An representing the snowflake identifier for the deleted channel. + /// A representing the snowflake identifier for the deleted channel. /// public ulong ChannelId { get; } /// diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelUpdateAuditLogData.cs index 7cad9eff7..c9e0e9d8b 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/ChannelUpdateAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to a channel update. + /// Contains a piece of audit log data related to a channel update. /// public class ChannelUpdateAuditLogData : IAuditLogData { @@ -45,10 +45,22 @@ namespace Discord.Rest /// Gets the snowflake ID of the updated channel. /// /// - /// An representing the snowflake identifier for the updated channel. + /// A representing the snowflake identifier for the updated channel. /// public ulong ChannelId { get; } + /// + /// Gets the channel information before the changes. + /// + /// + /// An information object containing the original channel information before the changes were made. + /// public ChannelInfo Before { get; } + /// + /// Gets the channel information after the changes. + /// + /// + /// An information object containing the channel information after the changes were made. + /// public ChannelInfo After { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteCreateAuditLogData.cs index a114548cc..ac41d7f58 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteCreateAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to an emoji creation. + /// Contains a piece of audit log data related to an emoji creation. /// public class EmoteCreateAuditLogData : IAuditLogData { @@ -28,7 +28,7 @@ namespace Discord.Rest /// Gets the snowflake ID of the created emoji. /// /// - /// An representing the snowflake identifier for the created emoji. + /// A representing the snowflake identifier for the created emoji. /// public ulong EmoteId { get; } /// diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteDeleteAuditLogData.cs index e522b0ee2..b76192d1d 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteDeleteAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to an emoji deletion. + /// Contains a piece of audit log data related to an emoji deletion. /// public class EmoteDeleteAuditLogData : IAuditLogData { @@ -29,7 +29,7 @@ namespace Discord.Rest /// Gets the snowflake ID of the deleted emoji. /// /// - /// An representing the snowflake identifier for the deleted emoji. + /// A representing the snowflake identifier for the deleted emoji. /// public ulong EmoteId { get; } /// diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteUpdateAuditLogData.cs index e8cd76513..d6474e7b2 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/EmoteUpdateAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to an emoji update. + /// Contains a piece of audit log data related to an emoji update. /// public class EmoteUpdateAuditLogData : IAuditLogData { @@ -31,7 +31,7 @@ namespace Discord.Rest /// Gets the snowflake ID of the updated emoji. /// /// - /// An representing the snowflake identifier of the updated emoji. + /// A representing the snowflake identifier of the updated emoji. /// public ulong EmoteId { get; } /// diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs index 494aac133..df63251d8 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildInfo.cs @@ -38,7 +38,7 @@ namespace Discord.Rest /// Gets the ID of the AFK voice channel for this guild. /// /// - /// An representing the snowflake identifier of the AFK voice channel; null if + /// A representing the snowflake identifier of the AFK voice channel; null if /// none is set. /// public ulong? AfkChannelId { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildUpdateAuditLogData.cs index b4ffd3bf1..012919727 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/GuildUpdateAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to a guild update. + /// Contains a piece of audit log data related to a guild update. /// public class GuildUpdateAuditLogData : IAuditLogData { diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs index df95d13b6..c210d72f0 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteCreateAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to an invite creation. + /// Contains a piece of audit log data related to an invite creation. /// public class InviteCreateAuditLogData : IAuditLogData { @@ -66,7 +66,7 @@ namespace Discord.Rest /// when the user logs off). /// /// - /// true if users accepting this invite will be removed from the guild when they log off; otherwise + /// true if users accepting this invite will be removed from the guild when they log off; otherwise /// false. /// public bool Temporary { get; } @@ -81,14 +81,14 @@ namespace Discord.Rest /// Gets the ID of the channel this invite is linked to. /// /// - /// An representing the channel snowflake identifier that the invite points to. + /// A representing the channel snowflake identifier that the invite points to. /// public ulong ChannelId { get; } /// /// Gets the number of times this invite has been used. /// /// - /// An representing the number of times this invite has been used. + /// An representing the number of times this invite was used. /// public int Uses { get; } /// diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs index 472f227c0..956598a86 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteDeleteAuditLogData.cs @@ -6,7 +6,7 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { /// - /// Represents a piece of audit log data related to an invite removal. + /// Contains a piece of audit log data related to an invite removal. /// public class InviteDeleteAuditLogData : IAuditLogData { @@ -66,7 +66,7 @@ namespace Discord.Rest /// when the user logs off). /// /// - /// true if users accepting this invite will be removed from the guild when they log off; otherwise + /// true if users accepting this invite will be removed from the guild when they log off; otherwise /// false. /// public bool Temporary { get; } @@ -81,7 +81,7 @@ namespace Discord.Rest /// Gets the ID of the channel this invite is linked to. /// /// - /// An representing the channel snowflake identifier that the invite points to. + /// A representing the channel snowflake identifier that the invite points to. /// public ulong ChannelId { get; } /// diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs index 54026dbf3..35f8937c2 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteInfo.cs @@ -42,7 +42,7 @@ namespace Discord.Rest /// Gets the ID of the channel this invite is linked to. /// /// - /// An representing the channel snowflake identifier that the invite points to; + /// A representing the channel snowflake identifier that the invite points to; /// null if not specified. /// public ulong? ChannelId { get; } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteUpdateAuditLogData.cs index b932cfbfc..7ba65e232 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/InviteUpdateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data relating to an invite update. + /// public class InviteUpdateAuditLogData : IAuditLogData { private InviteUpdateAuditLogData(InviteInfo before, InviteInfo after) @@ -40,7 +43,19 @@ namespace Discord.Rest return new InviteUpdateAuditLogData(before, after); } + /// + /// Gets the invite information before the changes. + /// + /// + /// An information object containing the original invite information before the changes were made. + /// public InviteInfo Before { get; } + /// + /// Gets the invite information after the changes. + /// + /// + /// An information object containing the invite information after the changes were made. + /// public InviteInfo After { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/KickAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/KickAuditLogData.cs index 41b5526b8..dceb73d0a 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/KickAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/KickAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a kick. + /// public class KickAuditLogData : IAuditLogData { private KickAuditLogData(RestUser user) @@ -18,6 +21,12 @@ namespace Discord.Rest return new KickAuditLogData(RestUser.Create(discord, userInfo)); } + /// + /// Gets the user that was kicked. + /// + /// + /// A user object representing the kicked user. + /// public IUser Target { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs index 0d9a2a708..cbba6c83b 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleAuditLogData.cs @@ -6,6 +6,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a change in a guild member's roles. + /// public class MemberRoleAuditLogData : IAuditLogData { private MemberRoleAuditLogData(IReadOnlyCollection roles, IUser target) @@ -29,7 +32,20 @@ namespace Discord.Rest return new MemberRoleAuditLogData(roleInfos.ToReadOnlyCollection(), user); } + /// + /// Gets a collection of role changes that were performed on the member. + /// + /// + /// A read-only collection of , containing the roles that were changed on + /// the member. + /// public IReadOnlyCollection Roles { get; } + /// + /// Gets the user that the roles changes were performed on. + /// + /// + /// A user object representing the user that the role changes were performed on. + /// public IUser Target { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs index 4838b75c9..9fc402b0d 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberRoleEditInfo.cs @@ -1,5 +1,8 @@ namespace Discord.Rest { + /// + /// An information object representing a change in one of a guild member's roles. + /// public struct MemberRoleEditInfo { internal MemberRoleEditInfo(string name, ulong roleId, bool added) @@ -9,8 +12,26 @@ namespace Discord.Rest Added = added; } + /// + /// Gets the name of the role that was changed. + /// + /// + /// A string containing the name of the role that was changed. + /// public string Name { get; } + /// + /// Gets the ID of the role that was changed. + /// + /// + /// A representing the snowflake identifier of the role that was changed. + /// public ulong RoleId { get; } + /// + /// Determines whether the role was added to the user. + /// + /// + /// true if the role was added to the user; otherwise false. + /// public bool Added { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs index 7d3d3dba0..394759a57 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MemberUpdateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a change in a guild member. + /// public class MemberUpdateAuditLogData : IAuditLogData { private MemberUpdateAuditLogData(IUser target, string newNick, string oldNick) @@ -27,8 +30,26 @@ namespace Discord.Rest return new MemberUpdateAuditLogData(user, newNick, oldNick); } + /// + /// Gets the user that the changes were performed on. + /// + /// + /// A user object representing the user who the changes were performed on. + /// public IUser Target { get; } + /// + /// Gets the new nickname of the user. + /// + /// + /// A string containing the new nickname of the user; null if the user no longer had a nickname. + /// public string NewNick { get; } + /// + /// Gets the old nickname of the user. + /// + /// + /// A string containing the old nickname of the user; null if the user did not have a nickname. + /// public string OldNick { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs index 3949cdd68..b12f990c8 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/MessageDeleteAuditLogData.cs @@ -3,6 +3,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to message deletion(s). + /// public class MessageDeleteAuditLogData : IAuditLogData { private MessageDeleteAuditLogData(ulong channelId, int count) @@ -16,7 +19,20 @@ namespace Discord.Rest return new MessageDeleteAuditLogData(entry.Options.MessageDeleteChannelId.Value, entry.Options.MessageDeleteCount.Value); } + /// + /// Gets the number of messages that were deleted. + /// + /// + /// An representing the number of messages that were deleted from the channel. + /// public int MessageCount { get; } + /// + /// Gets the ID of the channel that the messages were deleted from. + /// + /// + /// A representing the snowflake identifer for the channel that the messages were + /// deleted from. + /// public ulong ChannelId { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs index d58488136..59403d207 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteCreateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data for a permissions overwrite creation. + /// public class OverwriteCreateAuditLogData : IAuditLogData { private OverwriteCreateAuditLogData(Overwrite overwrite) @@ -32,6 +35,12 @@ namespace Discord.Rest return new OverwriteCreateAuditLogData(new Overwrite(id, target, permissions)); } + /// + /// Gets the permission overwrite object that was created. + /// + /// + /// An object representing the overwrite that was created. + /// public Overwrite Overwrite { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs index dc2f4a6f0..60e63b9db 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteDeleteAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to the deletion of a permission overwrite. + /// public class OverwriteDeleteAuditLogData : IAuditLogData { private OverwriteDeleteAuditLogData(Overwrite deletedOverwrite) @@ -31,6 +34,12 @@ namespace Discord.Rest return new OverwriteDeleteAuditLogData(new Overwrite(id, target, new OverwritePermissions(allow, deny))); } + /// + /// Gets the permission overwrite object that was deleted. + /// + /// + /// An object representing the overwrite that was deleted. + /// public Overwrite Overwrite { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs index d000146c3..15b7b8c0e 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to the update of a permission overwrite. + /// public class OverwriteUpdateAuditLogData : IAuditLogData { private OverwriteUpdateAuditLogData(OverwritePermissions before, OverwritePermissions after, ulong targetId, PermissionTarget targetType) @@ -35,10 +38,35 @@ namespace Discord.Rest return new OverwriteUpdateAuditLogData(beforePermissions, afterPermissions, entry.Options.OverwriteTargetId.Value, target); } + /// + /// Gets the overwrite permissions before the changes. + /// + /// + /// An overwrite permissions object representing the overwrite permissions that the overwrite had before + /// the changes were made. + /// public OverwritePermissions OldPermissions { get; } + /// + /// Gets the overwrite permissions after the changes. + /// + /// + /// An overwrite permissions object representing the overwrite permissions that the overwrite had after the + /// changes. + /// public OverwritePermissions NewPermissions { get; } - + /// + /// Gets the ID of the overwrite that was updated. + /// + /// + /// A representing the snowflake identifier of the overwrite that was updated. + /// public ulong OverwriteTargetId { get; } + /// + /// Gets the target of the updated permission overwrite. + /// + /// + /// The target of the updated permission overwrite. + /// public PermissionTarget OverwriteType { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs index 0005e304d..c32d12b3f 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs @@ -3,6 +3,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a guild prune. + /// public class PruneAuditLogData : IAuditLogData { private PruneAuditLogData(int pruneDays, int membersRemoved) @@ -16,7 +19,22 @@ namespace Discord.Rest return new PruneAuditLogData(entry.Options.PruneDeleteMemberDays.Value, entry.Options.PruneMembersRemoved.Value); } + /// + /// Gets the threshold for a guild member to not be kicked. + /// + /// + /// An representing the amount of days that a member must have been seen in the server, + /// to avoid being kicked. (i.e. If a user has not been seen for more than , they will be + /// kicked from the server) + /// public int PruneDays { get; } + /// + /// Gets the number of members that were kicked during the purge. + /// + /// + /// An representing the number of members that were removed from this guild for having + /// not been seen within . + /// public int MembersRemoved { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleCreateAuditLogData.cs index dcc1c6ab6..cb87af1ea 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleCreateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a role creation. + /// public class RoleCreateAuditLogData : IAuditLogData { private RoleCreateAuditLogData(ulong id, RoleEditInfo props) @@ -41,7 +44,19 @@ namespace Discord.Rest new RoleEditInfo(color, mentionable, hoist, name, permissions)); } + /// + /// Gets the ID of the role that was created. + /// + /// + /// A representing the snowflake identifer to the role that was created. + /// public ulong RoleId { get; } + /// + /// Gets the role information that was created. + /// + /// + /// An information object representing the properties of the role that was created. + /// public RoleEditInfo Properties { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleDeleteAuditLogData.cs index 263909daf..8fbbd12b9 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleDeleteAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data relating to a role deletion. + /// public class RoleDeleteAuditLogData : IAuditLogData { private RoleDeleteAuditLogData(ulong id, RoleEditInfo props) @@ -41,7 +44,19 @@ namespace Discord.Rest new RoleEditInfo(color, mentionable, hoist, name, permissions)); } + /// + /// Gets the ID of the role that was deleted. + /// + /// + /// A representing the snowflake identifer to the role that was deleted. + /// public ulong RoleId { get; } + /// + /// Gets the role information that was deleted. + /// + /// + /// An information object representing the properties of the role that was deleted. + /// public RoleEditInfo Properties { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs index 186ea8d11..07bc9abf5 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleEditInfo.cs @@ -1,5 +1,8 @@ namespace Discord.Rest { + /// + /// Represents information for a role edit. + /// public struct RoleEditInfo { internal RoleEditInfo(Color? color, bool? mentionable, bool? hoist, string name, @@ -12,10 +15,44 @@ namespace Discord.Rest Permissions = permissions; } + /// + /// Gets the color of this role. + /// + /// + /// A color object representing the color assigned to this role; null if this role does not have a + /// color. + /// public Color? Color { get; } + /// + /// Determines whether this role is mentionable (i.e. it can be mentioned in a text channel). + /// + /// + /// true if other members can mention this role in a text channel; otherwise false. + /// public bool? Mentionable { get; } + /// + /// Determines whether this role is hoisted (i.e its members will appear in a seperate section on the user + /// list). + /// + /// + /// true if this role's members will appear in a seperate section in the user list; otherwise + /// false. + /// public bool? Hoist { get; } + /// + /// Gets the name of this role. + /// + /// + /// A string containing the name of this role. + /// public string Name { get; } + /// + /// Gets the permissions assigned to this role. + /// + /// + /// A guild permissions object representing the permissions that have been assigned to this role; null + /// if no permissions have been assigned. + /// public GuildPermissions? Permissions { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleUpdateAuditLogData.cs index b645ef7ae..a23a735b4 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/RoleUpdateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a role update. + /// public class RoleUpdateAuditLogData : IAuditLogData { private RoleUpdateAuditLogData(ulong id, RoleEditInfo oldProps, RoleEditInfo newProps) @@ -55,8 +58,26 @@ namespace Discord.Rest return new RoleUpdateAuditLogData(entry.TargetId.Value, oldProps, newProps); } + /// + /// Gets the ID of the role that was changed. + /// + /// + /// A representing the snowflake identifier of the role that was changed. + /// public ulong RoleId { get; } + /// + /// Gets the role information before the changes. + /// + /// + /// A role information object containing the role information before the changes were made. + /// public RoleEditInfo Before { get; } + /// + /// Gets the role information after the changes. + /// + /// + /// A role information object containing the role information after the changes were made. + /// public RoleEditInfo After { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/UnbanAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/UnbanAuditLogData.cs index c94f18271..bc7e7fd4f 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/UnbanAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/UnbanAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to an unban. + /// public class UnbanAuditLogData : IAuditLogData { private UnbanAuditLogData(IUser user) @@ -18,6 +21,12 @@ namespace Discord.Rest return new UnbanAuditLogData(RestUser.Create(discord, userInfo)); } + /// + /// Gets the user that was unbanned. + /// + /// + /// A user object representing the user that was unbanned. + /// public IUser Target { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs index 1ae45fb8c..05ba0f920 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookCreateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a webhook creation. + /// public class WebhookCreateAuditLogData : IAuditLogData { private WebhookCreateAuditLogData(IWebhook webhook, WebhookType type, string name, ulong channelId) @@ -33,12 +36,40 @@ namespace Discord.Rest return new WebhookCreateAuditLogData(webhook, type, name, channelId); } - //Corresponds to the *current* data + // Doc Note: Corresponds to the *current* data + + /// + /// Gets the webhook that was created. + /// + /// + /// A webhook object representing the webhook that was created. + /// public IWebhook Webhook { get; } - //Corresponds to the *audit log* data + // Doc Note: Corresponds to the *audit log* data + + /// + /// Gets the type of webhook that was created. + /// + /// + /// The type of webhook that was created. + /// public WebhookType Type { get; } + + /// + /// Gets the name of the webhook. + /// + /// + /// A string containing the name of the webhook. + /// public string Name { get; } + /// + /// Gets the ID of the channel that the webhook could send to. + /// + /// + /// A representing the snowflake identifier of the channel that the webhook could send + /// to. + /// public ulong ChannelId { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookDeleteAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookDeleteAuditLogData.cs index 2d536d868..ec17e872c 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookDeleteAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookDeleteAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a webhook deletion. + /// public class WebhookDeleteAuditLogData : IAuditLogData { private WebhookDeleteAuditLogData(ulong id, ulong channel, WebhookType type, string name, string avatar) @@ -33,10 +36,41 @@ namespace Discord.Rest return new WebhookDeleteAuditLogData(entry.TargetId.Value, channelId, type, name, avatarHash); } + /// + /// Gets the ID of the webhook that was deleted. + /// + /// + /// A representing the snowflake identifier of the webhook that was deleted. + /// public ulong WebhookId { get; } + /// + /// Gets the ID of the channel that the webhook could send to. + /// + /// + /// A representing the snowflake identifier of the channel that the webhook could send + /// to. + /// public ulong ChannelId { get; } + /// + /// Gets the type of the webhook that was deleted. + /// + /// + /// The type of webhook that was deleted. + /// public WebhookType Type { get; } + /// + /// Gets the name of the webhook that was deleted. + /// + /// + /// A string containing the name of the webhook that was deleted. + /// public string Name { get; } + /// + /// Gets the hash value of the webhook's avatar. + /// + /// + /// A string containing the hash of the webhook's avatar. + /// public string Avatar { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookInfo.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookInfo.cs index 26975cc7c..e60157b1a 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookInfo.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookInfo.cs @@ -1,5 +1,8 @@ namespace Discord.Rest { + /// + /// Represents information for a webhook. + /// public struct WebhookInfo { internal WebhookInfo(string name, ulong? channelId, string avatar) @@ -9,8 +12,27 @@ namespace Discord.Rest Avatar = avatar; } + /// + /// Gets the name of this webhook. + /// + /// + /// A string containing the name of this webhook. + /// public string Name { get; } + /// + /// Gets the ID of the channel that this webhook sends to. + /// + /// + /// A representing the snowflake identifier of the channel that this webhook can send + /// to. + /// public ulong? ChannelId { get; } + /// + /// Gets the hash value of this webhook's avatar. + /// + /// + /// A string containing the hash of this webhook's avatar. + /// public string Avatar { get; } } } diff --git a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookUpdateAuditLogData.cs b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookUpdateAuditLogData.cs index 7db7aee36..d72bc7b71 100644 --- a/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookUpdateAuditLogData.cs +++ b/src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/WebhookUpdateAuditLogData.cs @@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry; namespace Discord.Rest { + /// + /// Contains a piece of audit log data related to a webhook update. + /// public class WebhookUpdateAuditLogData : IAuditLogData { private WebhookUpdateAuditLogData(IWebhook webhook, WebhookInfo before, WebhookInfo after) @@ -38,11 +41,28 @@ namespace Discord.Rest return new WebhookUpdateAuditLogData(webhook, before, after); } - //Again, the *current* data + /// + /// Gets the webhook that was updated. + /// + /// + /// A webhook objet representing the webhook that was updated. + /// public IWebhook Webhook { get; } - //And the *audit log* data + /// + /// Gets the webhook information before the changes. + /// + /// + /// A webhook information object representing the webhook before the changes were made. + /// public WebhookInfo Before { get; } + + /// + /// Gets the webhook information after the changes. + /// + /// + /// A webhook information object representing the webhook after the changes were made. + /// public WebhookInfo After { get; } } }