Class SocketAutoModRuleInfo

Namespace

Discord.WebSocket

Assembly

Discord.Net.WebSocket.dll

Represents information for an auto moderation rule.

public class SocketAutoModRuleInfo

Inheritance

object

SocketAutoModRuleInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Actions

Gets a collection of actions that will be preformed if a user breaks this rule.

public IReadOnlyCollection<AutoModRuleAction> Actions { get; }

Property Value

IReadOnlyCollection<AutoModRuleAction>

Remarks

null if this property is not mentioned in this entry.

AllowList

Gets the allow list patterns for this rule. Empty if the rule has no allowed terms.

public IReadOnlyCollection<string> AllowList { get; }

Property Value

IReadOnlyCollection<string>

Remarks

This collection will be empty if TriggerType is not Keyword.

Enabled

Gets whether or not this rule is enabled.

public bool? Enabled { get; set; }

Property Value

bool?

Remarks

null if this property is not mentioned in this entry.

EventType

Gets the event type on which this rule is triggered.

public AutoModEventType? EventType { get; set; }

Property Value

AutoModEventType?

Remarks

null if this property is not mentioned in this entry.

ExemptChannels

Gets a collection of channel ids that are exempt from this rule. Empty if the rule has no exempt channels.

public IReadOnlyCollection<ulong> ExemptChannels { get; set; }

Property Value

IReadOnlyCollection<ulong>

Remarks

null if this property is not mentioned in this entry.

ExemptRoles

Gets a collection of role ids that are exempt from this rule. Empty if the rule has no exempt roles.

public IReadOnlyCollection<ulong> ExemptRoles { get; set; }

Property Value

IReadOnlyCollection<ulong>

Remarks

null if this property is not mentioned in this entry.

KeywordFilter

Gets the keyword filter for this rule.

public IReadOnlyCollection<string> KeywordFilter { get; }

Property Value

IReadOnlyCollection<string>

Remarks

This collection will be empty if TriggerType is not Keyword.

MentionTotalLimit

Gets the total mention limit for this rule.

public int? MentionTotalLimit { get; }

Property Value

int?

Remarks

This property will be null if TriggerType is not MentionSpam.

Name

Get the name of this rule.

public string Name { get; set; }

Property Value

string

Remarks

null if this property is not mentioned in this entry.

Presets

Gets the preset keyword types for this rule. Empty if the rule has no presets.

public IReadOnlyCollection<KeywordPresetTypes> Presets { get; }

Property Value

IReadOnlyCollection<KeywordPresetTypes>

Remarks

This collection will be empty if TriggerType is not KeywordPreset.

RegexPatterns

Gets regex patterns for this rule. Empty if the rule has no regexes.

public IReadOnlyCollection<string> RegexPatterns { get; }

Property Value

IReadOnlyCollection<string>

Remarks

This collection will be empty if TriggerType is not Keyword.

TriggerType

Gets the trigger type on which this rule executes.

public AutoModTriggerType? TriggerType { get; set; }

Property Value

AutoModTriggerType?

Remarks

null if this property is not mentioned in this entry.