Class AutoModerationRule

Namespace

NetCord

Assembly

NetCord.dll

public class AutoModerationRule : ClientEntity, IEntity, ISpanFormattable, IFormattable, IEquatable<Entity>, IJsonModel<JsonAutoModerationRule>

Inheritance

object

Entity

ClientEntity

AutoModerationRule

Implements

IEntity

ISpanFormattable

IFormattable

IEquatable<Entity>

IJsonModel<JsonAutoModerationRule>

Inherited Members

Entity.Equals(object)

Entity.Equals(Entity)

Entity.GetHashCode()

Entity.ToString()

Entity.ToString(string, IFormatProvider)

Entity.TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider)

Entity.CreatedAt

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

AutoModerationRule(JsonAutoModerationRule, RestClient)

public AutoModerationRule(JsonAutoModerationRule jsonModel, RestClient client)

Parameters

jsonModel JsonAutoModerationRule

client RestClient

Properties

Actions

public IReadOnlyList<AutoModerationAction> Actions { get; }

Property Value

IReadOnlyList<AutoModerationAction>

CreatorId

public ulong CreatorId { get; }

Property Value

ulong

Enabled

public bool Enabled { get; }

Property Value

bool

EventType

public AutoModerationRuleEventType EventType { get; }

Property Value

AutoModerationRuleEventType

ExemptChannels

public IReadOnlyList<ulong> ExemptChannels { get; }

Property Value

IReadOnlyList<ulong>

ExemptRoles

public IReadOnlyList<ulong> ExemptRoles { get; }

Property Value

IReadOnlyList<ulong>

GuildId

public ulong GuildId { get; }

Property Value

ulong

Id

The unique identifier for this object.

public override ulong Id { get; }

Property Value

ulong

Name

public string Name { get; }

Property Value

string

TriggerMetadata

public AutoModerationRuleTriggerMetadata TriggerMetadata { get; }

Property Value

AutoModerationRuleTriggerMetadata

TriggerType

public AutoModerationRuleTriggerType TriggerType { get; }

Property Value

AutoModerationRuleTriggerType

Methods

DeleteAsync(RestRequestProperties?, CancellationToken)

Deletes an auto-moderation rule for a specified guild.

public Task DeleteAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task

GetAsync(RestRequestProperties?, CancellationToken)

Retrieves information about a specific auto-mod's rule configuration, for a specified guild.

public Task<AutoModerationRule> GetAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<AutoModerationRule>

ModifyAsync(Action<AutoModerationRuleOptions>, RestRequestProperties?, CancellationToken)

Modifies a pre-existing auto-moderation rule for a specified guild.

public Task<AutoModerationRule> ModifyAsync(Action<AutoModerationRuleOptions> action, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

action Action<AutoModerationRuleOptions>

An action, representing the modifications to make to the rule.

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<AutoModerationRule>