Renamed new params classes to XXXProperties

This commit is contained in:
RogueException
2016-12-23 15:22:59 -04:00
parent 8326d01f62
commit 572c0e6c6b
45 changed files with 81 additions and 83 deletions

View File

@@ -1,6 +1,6 @@
namespace Discord
{
public class ModifyGuildChannelsParams
public class BulkGuildChannelProperties
{
/// <summary>
/// The id of the channel to apply this position to.
@@ -11,7 +11,7 @@
/// </summary>
public int Position { get; set; }
public ModifyGuildChannelsParams(ulong id, int position)
public BulkGuildChannelProperties(ulong id, int position)
{
Id = id;
Position = position;

View File

@@ -11,7 +11,7 @@
/// });
/// </code>
/// </example>
public class ModifyGuildChannelParams
public class GuildChannelProperties
{
/// <summary>
/// Set the channel to this name

View File

@@ -26,7 +26,7 @@ namespace Discord
Task<IReadOnlyCollection<IInviteMetadata>> GetInvitesAsync(RequestOptions options = null);
/// <summary> Modifies this guild channel. </summary>
Task ModifyAsync(Action<ModifyGuildChannelParams> func, RequestOptions options = null);
Task ModifyAsync(Action<GuildChannelProperties> func, RequestOptions options = null);
/// <summary> Gets the permission overwrite for a specific role, or null if one does not exist. </summary>
OverwritePermissions? GetPermissionOverwrite(IRole role);

View File

@@ -10,6 +10,6 @@ namespace Discord
string Topic { get; }
/// <summary> Modifies this text channel. </summary>
Task ModifyAsync(Action<ModifyTextChannelParams> func, RequestOptions options = null);
Task ModifyAsync(Action<TextChannelProperties> func, RequestOptions options = null);
}
}

View File

@@ -13,7 +13,7 @@ namespace Discord
int UserLimit { get; }
/// <summary> Modifies this voice channel. </summary>
Task ModifyAsync(Action<ModifyVoiceChannelParams> func, RequestOptions options = null);
Task ModifyAsync(Action<VoiceChannelProperties> func, RequestOptions options = null);
/// <summary> Connects to this voice channel. </summary>
Task<IAudioClient> ConnectAsync();
}

View File

@@ -1,7 +1,7 @@
namespace Discord
{
/// <inheritdoc />
public class ModifyTextChannelParams : ModifyGuildChannelParams
public class TextChannelProperties : GuildChannelProperties
{
/// <summary>
/// What the topic of the channel should be set to.

View File

@@ -1,7 +1,7 @@
namespace Discord
{
/// <inheritdoc />
public class ModifyVoiceChannelParams : ModifyGuildChannelParams
public class VoiceChannelProperties : GuildChannelProperties
{
/// <summary>
/// The bitrate of the voice connections in this channel. Must be greater than 8000

View File

@@ -3,7 +3,7 @@
/// <summary>
/// Modify the widget of an IGuild with the specified parameters
/// </summary>
public class ModifyGuildEmbedParams
public class GuildEmbedProperties
{
/// <summary>
/// Should the widget be enabled?

View File

@@ -1,6 +1,6 @@
namespace Discord
{
public class ModifyGuildIntegrationParams
public class GuildIntegrationProperties
{
public Optional<int> ExpireBehavior { get; set; }
public Optional<int> ExpireGracePeriod { get; set; }

View File

@@ -13,7 +13,7 @@
/// </code>
/// </example>
/// <see cref="IGuild"/>
public class ModifyGuildParams
public class GuildProperties
{
public Optional<string> Username { get; set; }
/// <summary>

View File

@@ -53,13 +53,13 @@ namespace Discord
IReadOnlyCollection<IRole> Roles { get; }
/// <summary> Modifies this guild. </summary>
Task ModifyAsync(Action<ModifyGuildParams> func, RequestOptions options = null);
Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null);
/// <summary> Modifies this guild's embed. </summary>
Task ModifyEmbedAsync(Action<ModifyGuildEmbedParams> func, RequestOptions options = null);
Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null);
/// <summary> Bulk modifies the channels of this guild. </summary>
Task ModifyChannelsAsync(IEnumerable<ModifyGuildChannelsParams> args, RequestOptions options = null);
Task ModifyChannelsAsync(IEnumerable<BulkGuildChannelProperties> args, RequestOptions options = null);
/// <summary> Bulk modifies the roles of this guild. </summary>
Task ModifyRolesAsync(IEnumerable<ModifyGuildRolesParams> args, RequestOptions options = null);
Task ModifyRolesAsync(IEnumerable<BulkRoleProperties> args, RequestOptions options = null);
/// <summary> Leaves this guild. If you are the owner, use Delete instead. </summary>
Task LeaveAsync(RequestOptions options = null);

View File

@@ -7,7 +7,7 @@ namespace Discord
public interface IUserMessage : IMessage
{
/// <summary> Modifies this message. </summary>
Task ModifyAsync(Action<ModifyMessageParams> func, RequestOptions options = null);
Task ModifyAsync(Action<MessageProperties> func, RequestOptions options = null);
/// <summary> Adds this message to its channel's pinned messages. </summary>
Task PinAsync(RequestOptions options = null);
/// <summary> Removes this message from its channel's pinned messages. </summary>

View File

@@ -20,7 +20,7 @@
/// });
/// </code>
/// </example>
public class ModifyMessageParams
public class MessageProperties
{
/// <summary>
/// The content of the message

View File

@@ -1,13 +1,13 @@
namespace Discord
{
public class ModifyGuildRolesParams : ModifyGuildRoleParams
public class BulkRoleProperties : RoleProperties
{
/// <summary>
/// The id of the role to be edited
/// </summary>
public ulong Id { get; }
public ModifyGuildRolesParams(ulong id)
public BulkRoleProperties(ulong id)
{
Id = id;
}

View File

@@ -25,6 +25,6 @@ namespace Discord
int Position { get; }
///// <summary> Modifies this role. </summary>
Task ModifyAsync(Action<ModifyGuildRoleParams> func, RequestOptions options = null);
Task ModifyAsync(Action<RoleProperties> func, RequestOptions options = null);
}
}

View File

@@ -13,7 +13,7 @@
/// </code>
/// </example>
/// <seealso cref="IRole"/>
public class ModifyGuildRoleParams
public class RoleProperties
{
/// <summary>
/// The name of the role

View File

@@ -14,7 +14,7 @@ namespace Discord
/// </code>
/// </example>
/// <seealso cref="IGuildUser"/>
public class ModifyGuildMemberParams
public class GuildUserProperties
{
/// <summary>
/// Should the user be guild-muted in a voice channel?
@@ -60,5 +60,12 @@ namespace Discord
/// This user MUST already be in a Voice Channel for this to work.
/// </remarks>
public Optional<IVoiceChannel> Channel { get; set; }
/// <summary>
/// Move a user to a voice channel.
/// </summary>
/// <remarks>
/// This user MUST already be in a Voice Channel for this to work.
/// </remarks>
public Optional<ulong> ChannelId { get; set; }
}
}

View File

@@ -28,6 +28,6 @@ namespace Discord
/// <summary> Kicks this user from this guild. </summary>
Task KickAsync(RequestOptions options = null);
/// <summary> Modifies this user's properties in this guild. </summary>
Task ModifyAsync(Action<ModifyGuildMemberParams> func, RequestOptions options = null);
Task ModifyAsync(Action<GuildUserProperties> func, RequestOptions options = null);
}
}

View File

@@ -1,4 +1,3 @@
using Discord.API.Rest;
using System;
using System.Threading.Tasks;
@@ -13,6 +12,6 @@ namespace Discord
/// <summary> Returns true if this user has enabled MFA on their account. </summary>
bool IsMfaEnabled { get; }
Task ModifyAsync(Action<ModifyCurrentUserParams> func, RequestOptions options = null);
Task ModifyAsync(Action<SelfUserProperties> func, RequestOptions options = null);
}
}

View File

@@ -1,12 +0,0 @@
namespace Discord
{
public class ModifyCurrentUserNickParams
{
public string Nickname { get; }
public ModifyCurrentUserNickParams(string nickname)
{
Nickname = nickname;
}
}
}

View File

@@ -12,7 +12,7 @@
/// </code>
/// </example>
/// <seealso cref="ISelfUser"/>
public class ModifyCurrentUserParams
public class SelfUserProperties
{
/// <summary>
/// Your username