From 8dc6f2efad96017d14ec0ea562819ab310ac03f0 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 21:42:23 -0700 Subject: [PATCH 01/21] Added minimal descriptions from the API documentation for Integration types --- .../Entities/Guilds/IGuildIntegration.cs | 29 ++++++++++++++++++- .../Entities/Guilds/IntegrationAccount.cs | 8 ++++- 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index 225ce05d6f..f1b62ee240 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -1,17 +1,44 @@ -using System; +using System; namespace Discord { public interface IGuildIntegration { + /// + /// The integration ID. + /// ulong Id { get; } + /// + /// The integration name. + /// string Name { get; } + /// + /// The integration type (twich, youtube, etc). + /// string Type { get; } + /// + /// Is this integration enabled? + /// bool IsEnabled { get; } + /// + /// Is this integration syncing? + /// bool IsSyncing { get; } + /// + /// ID that this integration uses for "subscribers". + /// ulong ExpireBehavior { get; } + /// + /// The grace period before expiring subscribers. + /// ulong ExpireGracePeriod { get; } + /// + /// When this integration was last synced. + /// DateTimeOffset SyncedAt { get; } + /// + /// Integration account information. See . + /// IntegrationAccount Account { get; } IGuild Guild { get; } diff --git a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs index 71bcf10edd..9c83939e38 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs @@ -1,11 +1,17 @@ -using System.Diagnostics; +using System.Diagnostics; namespace Discord { [DebuggerDisplay("{DebuggerDisplay,nq}")] public struct IntegrationAccount { + /// + /// ID of the account. + /// public string Id { get; } + /// + /// Name of the account. + /// public string Name { get; private set; } public override string ToString() => Name; From 6c3f85db7e7ec363a4a5f01a44cd89b13a3a4434 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 21:51:31 -0700 Subject: [PATCH 02/21] Added obsolete mention to the ReadMessages flag. --- src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs b/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs index d683bd36b8..6811ad5623 100644 --- a/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs +++ b/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs @@ -22,7 +22,7 @@ public enum ChannelPermission : ulong /// AddReactions = 0x00_00_00_40, /// - /// Allows for reading of message. + /// Allows for reading of messages. This flag is obsolete, use instead. /// [Obsolete("Use ViewChannel instead.")] ReadMessages = ViewChannel, From d64f670f2b224eaf9945a022684d40c0e8d36287 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 21:54:23 -0700 Subject: [PATCH 03/21] Added remarks about 2FA requirement for guild permissions --- .../Entities/Permissions/GuildPermission.cs | 46 +++++++++++++++++-- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs b/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs index f2724778f1..bfe0c4797e 100644 --- a/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs +++ b/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs @@ -14,23 +14,43 @@ public enum GuildPermission : ulong /// /// Allows kicking members. /// + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// KickMembers = 0x00_00_00_02, /// /// Allows banning members. /// - BanMembers = 0x00_00_00_04, + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// + BanMembers = 0x00_00_00_04, /// /// Allows all permissions and bypasses channel permission overwrites. /// - Administrator = 0x00_00_00_08, + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// + Administrator = 0x00_00_00_08, /// /// Allows management and editing of channels. /// - ManageChannels = 0x00_00_00_10, + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// + ManageChannels = 0x00_00_00_10, /// /// Allows management and editing of the guild. /// - ManageGuild = 0x00_00_00_20, + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// + ManageGuild = 0x00_00_00_20, // Text /// @@ -52,7 +72,11 @@ public enum GuildPermission : ulong /// /// Allows for deletion of other users messages. /// - ManageMessages = 0x00_00_20_00, + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// + ManageMessages = 0x00_00_20_00, /// /// Allows links sent by users with this permission will be auto-embedded. /// @@ -114,14 +138,26 @@ public enum GuildPermission : ulong /// /// Allows management and editing of roles. /// + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// ManageRoles = 0x10_00_00_00, /// /// Allows management and editing of webhooks. /// + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// ManageWebhooks = 0x20_00_00_00, /// /// Allows management and editing of emojis. /// + /// + /// This permission requires the owner account to use two-factor + /// authentication when used on a guild that has server-wide 2FA enabled. + /// ManageEmojis = 0x40_00_00_00 } } From 677e7153529554089917a39acaf8d6303b6e44e9 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 21:58:05 -0700 Subject: [PATCH 04/21] Added xmldoc for GuildPermission methods --- .../Entities/Permissions/GuildPermissions.cs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs b/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs index bac14a5c86..39a77573de 100644 --- a/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs +++ b/src/Discord.Net.Core/Entities/Permissions/GuildPermissions.cs @@ -244,8 +244,19 @@ public GuildPermissions Modify( readMessageHistory, mentionEveryone, useExternalEmojis, connect, speak, muteMembers, deafenMembers, moveMembers, useVoiceActivation, changeNickname, manageNicknames, manageRoles, manageWebhooks, manageEmojis); + /// + /// Returns a value that indicates if a specific is enabled + /// in these permissions. + /// + /// The permission value to check for. + /// true if the permission is enabled, false otherwise. public bool Has(GuildPermission permission) => Permissions.GetValue(RawValue, permission); + /// + /// Returns a containing all of the + /// flags that are enabled. + /// + /// A containing flags. Empty if none are enabled. public List ToList() { var perms = new List(); From 14b645a29be5c97b8098640591627ea997345e1d Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:00:25 -0700 Subject: [PATCH 05/21] Added xml doc for ToAllowList and ToDenyList --- .../Entities/Permissions/OverwritePermissions.cs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs b/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs index 0af2fba9a6..04bb2f668d 100644 --- a/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs +++ b/src/Discord.Net.Core/Entities/Permissions/OverwritePermissions.cs @@ -193,6 +193,10 @@ public OverwritePermissions Modify( embedLinks, attachFiles, readMessageHistory, mentionEveryone, useExternalEmojis, connect, speak, muteMembers, deafenMembers, moveMembers, useVoiceActivation, manageRoles, manageWebhooks); + /// + /// Creates a of all the values that are allowed. + /// + /// A of all allowed flags. If none, the list will be empty. public List ToAllowList() { var perms = new List(); @@ -205,6 +209,11 @@ public List ToAllowList() } return perms; } + + /// + /// Creates a of all the values that are denied. + /// + /// A of all denied flags. If none, the list will be empty. public List ToDenyList() { var perms = new List(); From e8b3b493b0f20e6f93fe1fd1dab2d36e07e717be Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:03:54 -0700 Subject: [PATCH 06/21] Added specification of how the bits of the color raw value are packed --- src/Discord.Net.Core/Entities/Roles/Color.cs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Discord.Net.Core/Entities/Roles/Color.cs b/src/Discord.Net.Core/Entities/Roles/Color.cs index a8917ec075..1da86a71f1 100644 --- a/src/Discord.Net.Core/Entities/Roles/Color.cs +++ b/src/Discord.Net.Core/Entities/Roles/Color.cs @@ -75,6 +75,10 @@ public struct Color public static readonly Color DarkerGrey = new Color(0x546E7A); /// Gets the encoded value for this color. + /// + /// This value is encoded as an unsigned integer value. The most-significant 8 bits contain the red value, + /// the middle 8 bits contain the green value, and the least-significant 8 bits contain the blue value. + /// public uint RawValue { get; } /// Gets the red component for this color. From c572a98dc73dcfc9697b5668f7d90f743c765981 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:06:10 -0700 Subject: [PATCH 07/21] Added discord API documentation to IConnection interface --- .../Entities/Users/IConnection.cs | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Users/IConnection.cs b/src/Discord.Net.Core/Entities/Users/IConnection.cs index cc981ccf0d..f555de1300 100644 --- a/src/Discord.Net.Core/Entities/Users/IConnection.cs +++ b/src/Discord.Net.Core/Entities/Users/IConnection.cs @@ -1,14 +1,29 @@ -using System.Collections.Generic; +using System.Collections.Generic; namespace Discord { public interface IConnection { + /// + /// ID of the connection account. + /// string Id { get; } + /// + /// The service of the connection (twich, youtube). + /// string Type { get; } + /// + /// The username of the connection account. + /// string Name { get; } + /// + /// Wheter the connection is revoked. + /// bool IsRevoked { get; } + /// + /// A of integration IDs. + /// IReadOnlyCollection IntegrationIds { get; } } } From 981e2eb18f1991a8dbc26a82ba34d3990aafc9cc Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:10:57 -0700 Subject: [PATCH 08/21] I can spell :^) --- src/Discord.Net.Core/Entities/Users/IConnection.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Users/IConnection.cs b/src/Discord.Net.Core/Entities/Users/IConnection.cs index f555de1300..96d271bd43 100644 --- a/src/Discord.Net.Core/Entities/Users/IConnection.cs +++ b/src/Discord.Net.Core/Entities/Users/IConnection.cs @@ -17,7 +17,7 @@ public interface IConnection /// string Name { get; } /// - /// Wheter the connection is revoked. + /// Whether the connection is revoked. /// bool IsRevoked { get; } From 9fcea887f0c79899733fad3394d88b789c036f7e Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:17:01 -0700 Subject: [PATCH 09/21] Fix whitespace in ChannelPermission --- src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs b/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs index 6811ad5623..6729fdc394 100644 --- a/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs +++ b/src/Discord.Net.Core/Entities/Permissions/ChannelPermission.cs @@ -22,7 +22,7 @@ public enum ChannelPermission : ulong /// AddReactions = 0x00_00_00_40, /// - /// Allows for reading of messages. This flag is obsolete, use instead. + /// Allows for reading of messages. This flag is obsolete, use instead. /// [Obsolete("Use ViewChannel instead.")] ReadMessages = ViewChannel, From a46910ced77c1937d5a6311e86b08b8b3eff2b43 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:19:32 -0700 Subject: [PATCH 10/21] fix spacing of values in guildpermission --- src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs b/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs index bfe0c4797e..2e335947e4 100644 --- a/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs +++ b/src/Discord.Net.Core/Entities/Permissions/GuildPermission.cs @@ -26,7 +26,7 @@ public enum GuildPermission : ulong /// This permission requires the owner account to use two-factor /// authentication when used on a guild that has server-wide 2FA enabled. /// - BanMembers = 0x00_00_00_04, + BanMembers = 0x00_00_00_04, /// /// Allows all permissions and bypasses channel permission overwrites. /// From 3d8e08219b28d1dc9cfe4eac8c2379fc38ba575a Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:41:05 -0700 Subject: [PATCH 11/21] Made changes to get field descriptions from feedback, added returns tag to IConnection --- .../Entities/Users/IConnection.cs | 26 +++++++------------ 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Users/IConnection.cs b/src/Discord.Net.Core/Entities/Users/IConnection.cs index 96d271bd43..b518ab35a8 100644 --- a/src/Discord.Net.Core/Entities/Users/IConnection.cs +++ b/src/Discord.Net.Core/Entities/Users/IConnection.cs @@ -4,26 +4,20 @@ namespace Discord { public interface IConnection { - /// - /// ID of the connection account. - /// + /// Gets the ID of the connection account. + /// Gets the ID of the connection account. string Id { get; } - /// - /// The service of the connection (twich, youtube). - /// + /// Gets the service of the connection (twitch, youtube). + /// Gets the service of the connection (twitch, youtube). string Type { get; } - /// - /// The username of the connection account. - /// + /// Gets the username of the connection account. + /// Gets the username of the connection account. string Name { get; } - /// - /// Whether the connection is revoked. - /// + /// Gets whether the connection is revoked. + /// Gets whether the connection is revoked. bool IsRevoked { get; } - - /// - /// A of integration IDs. - /// + /// Gets a of integration IDs. + /// Gets a of integration IDs. IReadOnlyCollection IntegrationIds { get; } } } From 9185853db1d3ed753833ec21dea7f92c52e20c32 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:43:16 -0700 Subject: [PATCH 12/21] Added property get standard for IntegrationAccount --- .../Entities/Guilds/IntegrationAccount.cs | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs index 9c83939e38..2b7fdbf7ca 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs @@ -5,13 +5,11 @@ namespace Discord [DebuggerDisplay("{DebuggerDisplay,nq}")] public struct IntegrationAccount { - /// - /// ID of the account. - /// + /// Gets the ID of the account. + /// Gets the ID of the account. public string Id { get; } - /// - /// Name of the account. - /// + /// Gets the name of the account. + /// Gets the name of the account. public string Name { get; private set; } public override string ToString() => Name; From 9bbf5805426623902f691ef2b7e44d1240cef9dc Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Mon, 30 Jul 2018 22:48:48 -0700 Subject: [PATCH 13/21] Added property get pattern to xml docs and identical returns tag. --- .../Entities/Guilds/IGuildIntegration.cs | 45 +++++++++---------- 1 file changed, 20 insertions(+), 25 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index f1b62ee240..63db5ac316 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -4,41 +4,36 @@ namespace Discord { public interface IGuildIntegration { - /// - /// The integration ID. - /// + /// Gets the integration ID. + /// Gets the integration ID. ulong Id { get; } - /// - /// The integration name. - /// + /// Gets the integration name. + /// Gets the integration name. string Name { get; } - /// - /// The integration type (twich, youtube, etc). - /// + /// Gets the integration type (twitch, youtube, etc). + /// Gets the integration type (twitch, youtube, etc). string Type { get; } - /// - /// Is this integration enabled? - /// + /// Gets if this integration is enabled or not. + /// Gets if this integration is enabled or not. bool IsEnabled { get; } - /// - /// Is this integration syncing? - /// + /// Gets if this integration is syncing or not. + /// Gets if this integration is syncing or not. bool IsSyncing { get; } - /// - /// ID that this integration uses for "subscribers". - /// + /// Gets the ID that this integration uses for "subscribers". + /// Gets the ID that this integration uses for "subscribers". ulong ExpireBehavior { get; } - /// - /// The grace period before expiring subscribers. - /// + /// Gets the grace period before expiring subscribers. + /// Gets the grace period before expiring subscribers. ulong ExpireGracePeriod { get; } - /// - /// When this integration was last synced. - /// + /// Gets when this integration was last synced. + /// Gets when this integration was last synced. DateTimeOffset SyncedAt { get; } /// - /// Integration account information. See . + /// Gets integration account information. See . /// + /// + /// Gets integration account information. See . + /// IntegrationAccount Account { get; } IGuild Guild { get; } From c8bc452c68a7fc94e594b7be5b168e0549f96cfd Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Tue, 31 Jul 2018 22:52:27 -0700 Subject: [PATCH 14/21] Rewrote the returns tags in IGuildIntegration, removed the ones I was unsure about. --- .../Entities/Guilds/IGuildIntegration.cs | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index 63db5ac316..8dfce11d55 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -5,35 +5,30 @@ namespace Discord public interface IGuildIntegration { /// Gets the integration ID. - /// Gets the integration ID. + /// A unique identifier value of this integration. ulong Id { get; } /// Gets the integration name. - /// Gets the integration name. + /// A string containing the name of this integration. string Name { get; } /// Gets the integration type (twitch, youtube, etc). - /// Gets the integration type (twitch, youtube, etc). + /// A string containing the name of the type of integration. string Type { get; } /// Gets if this integration is enabled or not. - /// Gets if this integration is enabled or not. + /// A value indicating if this integration is enabled. bool IsEnabled { get; } /// Gets if this integration is syncing or not. - /// Gets if this integration is syncing or not. + /// A value indicating if this integration is syncing. bool IsSyncing { get; } /// Gets the ID that this integration uses for "subscribers". - /// Gets the ID that this integration uses for "subscribers". ulong ExpireBehavior { get; } /// Gets the grace period before expiring subscribers. - /// Gets the grace period before expiring subscribers. ulong ExpireGracePeriod { get; } /// Gets when this integration was last synced. - /// Gets when this integration was last synced. + /// A containing a date and time of day when the integration was last synced. DateTimeOffset SyncedAt { get; } /// /// Gets integration account information. See . /// - /// - /// Gets integration account information. See . - /// IntegrationAccount Account { get; } IGuild Guild { get; } From 1d20132104d9ffd8ab871e245766160b36b882de Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Tue, 31 Jul 2018 22:58:48 -0700 Subject: [PATCH 15/21] Rewrote the rest of the returns tags --- .../Entities/Guilds/IGuildIntegration.cs | 2 +- .../Entities/Guilds/IntegrationAccount.cs | 4 ++-- src/Discord.Net.Core/Entities/Users/IConnection.cs | 10 +++++----- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index 8dfce11d55..74d3683bbc 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -5,7 +5,7 @@ namespace Discord public interface IGuildIntegration { /// Gets the integration ID. - /// A unique identifier value of this integration. + /// The unique identifier value of this integration. ulong Id { get; } /// Gets the integration name. /// A string containing the name of this integration. diff --git a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs index 2b7fdbf7ca..361cd39624 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs @@ -6,10 +6,10 @@ namespace Discord public struct IntegrationAccount { /// Gets the ID of the account. - /// Gets the ID of the account. + /// The unique identifier of this integration account. public string Id { get; } /// Gets the name of the account. - /// Gets the name of the account. + /// A string containing the name of this integration account. public string Name { get; private set; } public override string ToString() => Name; diff --git a/src/Discord.Net.Core/Entities/Users/IConnection.cs b/src/Discord.Net.Core/Entities/Users/IConnection.cs index b518ab35a8..446c74e8ab 100644 --- a/src/Discord.Net.Core/Entities/Users/IConnection.cs +++ b/src/Discord.Net.Core/Entities/Users/IConnection.cs @@ -5,19 +5,19 @@ namespace Discord public interface IConnection { /// Gets the ID of the connection account. - /// Gets the ID of the connection account. + /// The unique idenitifer of this connection. string Id { get; } /// Gets the service of the connection (twitch, youtube). - /// Gets the service of the connection (twitch, youtube). + /// A string containing the name of this type of connection. string Type { get; } /// Gets the username of the connection account. - /// Gets the username of the connection account. + /// A string containing the name of this connection. string Name { get; } /// Gets whether the connection is revoked. - /// Gets whether the connection is revoked. + /// A value which if true indicates that this connection has been revoked, otherwise false. bool IsRevoked { get; } /// Gets a of integration IDs. - /// Gets a of integration IDs. + /// An containing the unique identifier values of integrations. IReadOnlyCollection IntegrationIds { get; } } } From d9e186467e1cda3bbce3b3cd4106121e2cf6e760 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Thu, 2 Aug 2018 14:20:51 -0700 Subject: [PATCH 16/21] Added types to tags where missing --- src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs | 2 +- src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs | 2 +- src/Discord.Net.Core/Entities/Users/IConnection.cs | 7 +++++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index 74d3683bbc..4d6100d982 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -5,7 +5,7 @@ namespace Discord public interface IGuildIntegration { /// Gets the integration ID. - /// The unique identifier value of this integration. + /// An representing the unique identifier value of this integration. ulong Id { get; } /// Gets the integration name. /// A string containing the name of this integration. diff --git a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs index 361cd39624..637bf969b7 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs @@ -6,7 +6,7 @@ namespace Discord public struct IntegrationAccount { /// Gets the ID of the account. - /// The unique identifier of this integration account. + /// A unique identifier of this integration account. public string Id { get; } /// Gets the name of the account. /// A string containing the name of this integration account. diff --git a/src/Discord.Net.Core/Entities/Users/IConnection.cs b/src/Discord.Net.Core/Entities/Users/IConnection.cs index 446c74e8ab..f0fea75ad5 100644 --- a/src/Discord.Net.Core/Entities/Users/IConnection.cs +++ b/src/Discord.Net.Core/Entities/Users/IConnection.cs @@ -5,7 +5,7 @@ namespace Discord public interface IConnection { /// Gets the ID of the connection account. - /// The unique idenitifer of this connection. + /// A representing the unique identifier value of this connection. string Id { get; } /// Gets the service of the connection (twitch, youtube). /// A string containing the name of this type of connection. @@ -17,7 +17,10 @@ public interface IConnection /// A value which if true indicates that this connection has been revoked, otherwise false. bool IsRevoked { get; } /// Gets a of integration IDs. - /// An containing the unique identifier values of integrations. + /// + /// An containing + /// representations of unique identifier values of integrations. + /// IReadOnlyCollection IntegrationIds { get; } } } From e41136c955de998f4fa6ea66d3d4be3d2414991c Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Thu, 9 Aug 2018 21:06:44 -0700 Subject: [PATCH 17/21] restored the removed line break --- src/Discord.Net.Core/Entities/Users/IConnection.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Discord.Net.Core/Entities/Users/IConnection.cs b/src/Discord.Net.Core/Entities/Users/IConnection.cs index f0fea75ad5..1e65d971fd 100644 --- a/src/Discord.Net.Core/Entities/Users/IConnection.cs +++ b/src/Discord.Net.Core/Entities/Users/IConnection.cs @@ -16,6 +16,7 @@ public interface IConnection /// Gets whether the connection is revoked. /// A value which if true indicates that this connection has been revoked, otherwise false. bool IsRevoked { get; } + /// Gets a of integration IDs. /// /// An containing From 25c208cccda31a986191495a23a53debc102d494 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Thu, 9 Aug 2018 21:07:31 -0700 Subject: [PATCH 18/21] Removed unnecessary see tag --- src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index 4d6100d982..ffe5c7cf38 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -27,7 +27,7 @@ public interface IGuildIntegration /// A containing a date and time of day when the integration was last synced. DateTimeOffset SyncedAt { get; } /// - /// Gets integration account information. See . + /// Gets integration account information. /// IntegrationAccount Account { get; } From cee15227b2cf34e4849ea5465dfdf6597008bc0e Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Thu, 9 Aug 2018 21:22:36 -0700 Subject: [PATCH 19/21] Use consistent quotation marks around subscribers, the name for these users are dependant on the source of where they are integrated from (youtube or twitch), so we should not use a name that is specific to one platform --- src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index ffe5c7cf38..d4ded04fd7 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -21,7 +21,7 @@ public interface IGuildIntegration bool IsSyncing { get; } /// Gets the ID that this integration uses for "subscribers". ulong ExpireBehavior { get; } - /// Gets the grace period before expiring subscribers. + /// Gets the grace period before expiring "subscribers". ulong ExpireGracePeriod { get; } /// Gets when this integration was last synced. /// A containing a date and time of day when the integration was last synced. From 6e80cef06e2835bd6f7ec084e66e6fe53fc40d95 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Thu, 9 Aug 2018 21:36:10 -0700 Subject: [PATCH 20/21] Add tag to the IGuildIntegration xmldocs --- src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index d4ded04fd7..392f42db3d 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -18,6 +18,12 @@ public interface IGuildIntegration bool IsEnabled { get; } /// Gets if this integration is syncing or not. /// A value indicating if this integration is syncing. + /// + /// An integration with syncing enabled will update it's "subscribers" on + /// an interval, while one with syncing disabled will not. + /// A user must manually choose when sync the integration + /// if syncing is disabled. + /// bool IsSyncing { get; } /// Gets the ID that this integration uses for "subscribers". ulong ExpireBehavior { get; } From 3ad948d44b52c640c11e776b1eaf64cb394c7db2 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Fri, 10 Aug 2018 07:21:07 -0700 Subject: [PATCH 21/21] Fix grammar issue --- src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs index 392f42db3d..4ca57a55fa 100644 --- a/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs +++ b/src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs @@ -19,7 +19,7 @@ public interface IGuildIntegration /// Gets if this integration is syncing or not. /// A value indicating if this integration is syncing. /// - /// An integration with syncing enabled will update it's "subscribers" on + /// An integration with syncing enabled will update its "subscribers" on /// an interval, while one with syncing disabled will not. /// A user must manually choose when sync the integration /// if syncing is disabled.