Browse Source

Documented two more types

pull/1161/head
sarcasmloading 7 years ago
parent
commit
541b473d59
2 changed files with 47 additions and 1 deletions
  1. +29
    -1
      src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs
  2. +18
    -0
      src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs

+ 29
- 1
src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/OverwriteUpdateAuditLogData.cs View File

@@ -5,6 +5,9 @@ using EntryModel = Discord.API.AuditLogEntry;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Contains audit log data related to the update of a permission overwrite.
/// </summary>
public class OverwriteUpdateAuditLogData : IAuditLogData public class OverwriteUpdateAuditLogData : IAuditLogData
{ {
private OverwriteUpdateAuditLogData(OverwritePermissions before, OverwritePermissions after, ulong targetId, PermissionTarget targetType) 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); return new OverwriteUpdateAuditLogData(beforePermissions, afterPermissions, entry.Options.OverwriteTargetId.Value, target);
} }


/// <summary>
/// Gets the overwrite permissions before the changes.
/// </summary>
/// <returns>
/// An overwrite permissions object representing the overwrite permissions that the overwrite had before
/// the changes were made.
/// </returns>
public OverwritePermissions OldPermissions { get; } public OverwritePermissions OldPermissions { get; }
/// <summary>
/// Gets the overwrite permissions after the changes.
/// </summary>
/// <returns>
/// An overwrite permissions object representing the overwrite permissions that the overwrite now has after
/// the changes.
/// </returns>
public OverwritePermissions NewPermissions { get; } public OverwritePermissions NewPermissions { get; }

/// <summary>
/// Gets the snowflake ID of the overwrite that has been updated.
/// </summary>
/// <returns>
/// A <see cref="ulong"/> representing the snowflake identifier of the overwrite that has been updated.
/// </returns>
public ulong OverwriteTargetId { get; } public ulong OverwriteTargetId { get; }
/// <summary>
/// Gets the target of the updated permission overwrite.
/// </summary>
/// <returns>
/// The target of the updated permission overwrite.
/// </returns>
public PermissionTarget OverwriteType { get; } public PermissionTarget OverwriteType { get; }
} }
} }

+ 18
- 0
src/Discord.Net.Rest/Entities/AuditLogs/DataTypes/PruneAuditLogData.cs View File

@@ -3,6 +3,9 @@ using EntryModel = Discord.API.AuditLogEntry;


namespace Discord.Rest namespace Discord.Rest
{ {
/// <summary>
/// Contains audit log data related to a guild prune.
/// </summary>
public class PruneAuditLogData : IAuditLogData public class PruneAuditLogData : IAuditLogData
{ {
private PruneAuditLogData(int pruneDays, int membersRemoved) private PruneAuditLogData(int pruneDays, int membersRemoved)
@@ -16,7 +19,22 @@ namespace Discord.Rest
return new PruneAuditLogData(entry.Options.PruneDeleteMemberDays.Value, entry.Options.PruneMembersRemoved.Value); return new PruneAuditLogData(entry.Options.PruneDeleteMemberDays.Value, entry.Options.PruneMembersRemoved.Value);
} }


/// <summary>
/// Gets the threshold for a guild member to not be kicked.
/// </summary>
/// <returns>
/// An <see cref="int"/> 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 PruneDays, they will be
/// kicked from the server)
/// </returns>
public int PruneDays { get; } public int PruneDays { get; }
/// <summary>
/// Gets the number of members that were kicked during the purge.
/// </summary>
/// <returns>
/// An <see cref="int"/> representing the number of members that were removed from this guild for having
/// not been seen within PruneDays.
/// </returns>
public int MembersRemoved { get; } public int MembersRemoved { get; }
} }
} }

Loading…
Cancel
Save