@@ -12,7 +12,7 @@ namespace Discord | |||||
public enum AutoModEventType | public enum AutoModEventType | ||||
{ | { | ||||
/// <summary> | /// <summary> | ||||
/// When a member sends or edits a message in the guild | |||||
/// When a member sends or edits a message in the guild. | |||||
/// </summary> | /// </summary> | ||||
MessageSend = 1 | MessageSend = 1 | ||||
} | } | ||||
@@ -32,22 +32,22 @@ namespace Discord | |||||
public string[] KeywordFilter { get; } | public string[] KeywordFilter { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets regex patterns for the rule. | |||||
/// Gets regex patterns for the rule. Empty if the rule has no regexes. | |||||
/// </summary> | /// </summary> | ||||
public string[] RegexPatterns { get; } | public string[] RegexPatterns { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the allow list for the rule. | |||||
/// Gets the allow list for the rule. Empty if the rule has no allowed terms. | |||||
/// </summary> | /// </summary> | ||||
public string[] AllowList { get; } | public string[] AllowList { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets total mention limit for the rule. | |||||
/// Gets total mention limit for the rule. <see langword="null"/> if not provided. | |||||
/// </summary> | /// </summary> | ||||
public int? MentionLimit { get; } | public int? MentionLimit { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the presets for the rule. | |||||
/// Gets the presets for the rule. Empty if the rule has no presets. | |||||
/// </summary> | /// </summary> | ||||
public KeywordPresetTypes[] Presets { get; } | public KeywordPresetTypes[] Presets { get; } | ||||
@@ -62,12 +62,12 @@ namespace Discord | |||||
public bool Enabled { get; } | public bool Enabled { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the exempt roles for the rule. | |||||
/// Gets the exempt roles for the rule. Empty if the rule has no exempt roles. | |||||
/// </summary> | /// </summary> | ||||
public ulong[] ExemptRoles { get; } | public ulong[] ExemptRoles { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the exempt channels for the rule. | |||||
/// Gets the exempt channels for the rule. Empty if the rule has no exempt channels. | |||||
/// </summary> | /// </summary> | ||||
public ulong[] ExemptChannels { get; } | public ulong[] ExemptChannels { get; } | ||||
@@ -17,12 +17,12 @@ namespace Discord | |||||
public AutoModActionType Type { get; } | public AutoModActionType Type { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Get the channel id on which to post alerts. | |||||
/// Get the channel id on which to post alerts. <see langword="null"/> if no channel has been provided. | |||||
/// </summary> | /// </summary> | ||||
public ulong? ChannelId { get; } | public ulong? ChannelId { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the duration of which a user will be timed out for breaking this rule. | |||||
/// Gets the duration of which a user will be timed out for breaking this rule. <see langword="null"/> if no timeout duration has been provided. | |||||
/// </summary> | /// </summary> | ||||
public TimeSpan? TimeoutDuration { get; } | public TimeSpan? TimeoutDuration { get; } | ||||
@@ -47,7 +47,7 @@ namespace Discord | |||||
public Optional<int> MentionLimit { get; set; } | public Optional<int> MentionLimit { get; set; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets or sets the presets for the rule. | |||||
/// Gets or sets the presets for the rule. Empty if the rule has no presets. | |||||
/// </summary> | /// </summary> | ||||
public Optional<KeywordPresetTypes[]> Presets { get; set; } | public Optional<KeywordPresetTypes[]> Presets { get; set; } | ||||
@@ -62,12 +62,12 @@ namespace Discord | |||||
public Optional<bool> Enabled { get; set; } | public Optional<bool> Enabled { get; set; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets or sets the exempt roles for the rule. | |||||
/// Gets or sets the exempt roles for the rule. Empty if the rule has no exempt roles. | |||||
/// </summary> | /// </summary> | ||||
public Optional<ulong[]> ExemptRoles { get; set; } | public Optional<ulong[]> ExemptRoles { get; set; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets or sets the exempt channels for the rule. | |||||
/// Gets or sets the exempt channels for the rule. Empty if the rule has no exempt channels. | |||||
/// </summary> | /// </summary> | ||||
public Optional<ulong[]> ExemptChannels { get; set; } | public Optional<ulong[]> ExemptChannels { get; set; } | ||||
} | } | ||||
@@ -46,7 +46,7 @@ namespace Discord | |||||
public IReadOnlyCollection<string> KeywordFilter { get; } | public IReadOnlyCollection<string> KeywordFilter { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets regex patterns for this rule. | |||||
/// Gets regex patterns for this rule. Empty if the rule has no regexes. | |||||
/// </summary> | /// </summary> | ||||
/// <remarks> | /// <remarks> | ||||
/// This collection will be empty if <see cref="TriggerType"/> is not | /// This collection will be empty if <see cref="TriggerType"/> is not | ||||
@@ -55,7 +55,7 @@ namespace Discord | |||||
public IReadOnlyCollection<string> RegexPatterns { get; } | public IReadOnlyCollection<string> RegexPatterns { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the allow list patterns for this rule. | |||||
/// Gets the allow list patterns for this rule. Empty if the rule has no allowed terms. | |||||
/// </summary> | /// </summary> | ||||
/// <remarks> | /// <remarks> | ||||
/// This collection will be empty if <see cref="TriggerType"/> is not | /// This collection will be empty if <see cref="TriggerType"/> is not | ||||
@@ -64,7 +64,7 @@ namespace Discord | |||||
public IReadOnlyCollection<string> AllowList { get; } | public IReadOnlyCollection<string> AllowList { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the preset keyword types for this rule. | |||||
/// Gets the preset keyword types for this rule. Empty if the rule has no presets. | |||||
/// </summary> | /// </summary> | ||||
/// <remarks> | /// <remarks> | ||||
/// This collection will be empty if <see cref="TriggerType"/> is not | /// This collection will be empty if <see cref="TriggerType"/> is not | ||||
@@ -92,12 +92,12 @@ namespace Discord | |||||
bool Enabled { get; } | bool Enabled { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets a collection of role ids that are exempt from this rule. | |||||
/// Gets a collection of role ids that are exempt from this rule. Empty if the rule has no exempt roles. | |||||
/// </summary> | /// </summary> | ||||
IReadOnlyCollection<ulong> ExemptRoles { get; } | IReadOnlyCollection<ulong> ExemptRoles { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets a collection of channel ids that are exempt from this rule. | |||||
/// Gets a collection of channel ids that are exempt from this rule. Empty if the rule has no exempt channels. | |||||
/// </summary> | /// </summary> | ||||
IReadOnlyCollection<ulong> ExemptChannels { get; } | IReadOnlyCollection<ulong> ExemptChannels { get; } | ||||
@@ -1288,7 +1288,7 @@ namespace Discord | |||||
/// Creates a new auto moderation rule. | /// Creates a new auto moderation rule. | ||||
/// </summary> | /// </summary> | ||||
/// <returns> | /// <returns> | ||||
/// A task that represents the asynchronous creation operation. The task result contains the created <see cref="WelcomeScreen"/>. | |||||
/// A task that represents the asynchronous creation operation. The task result contains the created <see cref="IAutoModRule"/>. | |||||
/// </returns> | /// </returns> | ||||
Task<IAutoModRule> CreateAutoModRuleAsync(AutoModRule props, RequestOptions options = null); | Task<IAutoModRule> CreateAutoModRuleAsync(AutoModRule props, RequestOptions options = null); | ||||
} | } | ||||
@@ -2129,7 +2129,7 @@ namespace Discord.API | |||||
options = RequestOptions.CreateOrClone(options); | options = RequestOptions.CreateOrClone(options); | ||||
return await SendJsonAsync<AutoModerationRule>("POST", () => $"guilds/{guildId}/auto-moderation/rules", args, new BucketIds(guildId), options: options); | |||||
return await SendJsonAsync<AutoModerationRule>("POST", () => $"guilds/{guildId}/auto-moderation/rules", args, new BucketIds(guildId: guildId), options: options); | |||||
} | } | ||||
public async Task<AutoModerationRule> ModifyGuildAutoModRuleAsync(ulong guildId, ulong ruleId, ModifyAutoModRuleParams args, RequestOptions options) | public async Task<AutoModerationRule> ModifyGuildAutoModRuleAsync(ulong guildId, ulong ruleId, ModifyAutoModRuleParams args, RequestOptions options) | ||||
@@ -2139,7 +2139,7 @@ namespace Discord.API | |||||
options = RequestOptions.CreateOrClone(options); | options = RequestOptions.CreateOrClone(options); | ||||
return await SendJsonAsync<AutoModerationRule>("PATCH", () => $"guilds/{guildId}/auto-moderation/rules/{ruleId}", args, new BucketIds(guildId), options: options); | |||||
return await SendJsonAsync<AutoModerationRule>("PATCH", () => $"guilds/{guildId}/auto-moderation/rules/{ruleId}", args, new BucketIds(guildId: guildId), options: options); | |||||
} | } | ||||
public async Task DeleteGuildAutoModRuleAsync(ulong guildId, ulong ruleId, RequestOptions options) | public async Task DeleteGuildAutoModRuleAsync(ulong guildId, ulong ruleId, RequestOptions options) | ||||
@@ -2149,7 +2149,7 @@ namespace Discord.API | |||||
options = RequestOptions.CreateOrClone(options); | options = RequestOptions.CreateOrClone(options); | ||||
await SendAsync("DELETE", () => $"guilds/{guildId}/auto-moderation/rules/{ruleId}", new BucketIds(guildId), options: options); | |||||
await SendAsync("DELETE", () => $"guilds/{guildId}/auto-moderation/rules/{ruleId}", new BucketIds(guildId: guildId), options: options); | |||||
} | } | ||||
#endregion | #endregion | ||||