Rule

Implementation of a discord automoderation rule object as a luau builder.

https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object

Summary

Properties

Rule.name :: stringRule.eventType :: Builders.EventTypesRule.triggerType :: Builders.TriggerTypesRule.triggerMetadata :: Builders.AutoModeration.TriggerMetadataRule.actions :: {Builders.AutoModeration.Action}Rule.enabled :: booleanRule.exemptRoles :: {string}Rule.exemptChannels :: {string}

Methods

Rule:setName(name: string) → AutomoderationRuleRule:setEventType(eventType: apiTypes.EventTypes) → AutomoderationRuleRule:setTriggerType(triggerType: apiTypes.TriggerTypes) → AutomoderationRuleRule:setTriggerMetadata(triggerMetadata: triggerMetadata.JSON) → AutomoderationRuleRule:setActions(actions: { action.JSON }) → AutomoderationRuleRule:setEnabled(enabled: boolean) → AutomoderationRuleRule:setExemptRoles(exemptRoles: { apiTypes.Snowflake }) → AutomoderationRuleRule:setExemptChannels(exemptChannels: { apiTypes.Snowflake }) → AutomoderationRuleRule:build() → JSON

Functions

Rule.new(resource: { name: string?, eventType: apiTypes.EventTypes?, triggerType: apiTypes.TriggerTypes?, triggerMetadata: triggerMetadata.JSON?, actions: { action.JSON }?, enabled: boolean?, exemptRoles: { apiTypes.Snowflake }?, exemptChannels: { apiTypes.Snowflake }?, }?) → AutomoderationRule

Properties

name

Rule.name  :: string

---

The name of the automoderation rule.

eventType

Rule.eventType  :: EventTypes

---

The event type that will trigger the rule.

triggerType

Rule.triggerType  :: TriggerTypes

---

The type of content which can trigger the rule.

triggerMetadata

Rule.triggerMetadata  :: TriggerMetadata

---

The trigger metadata for the rule.

actions

Rule.actions  :: Action}

---

The actions which will execute when the rule is triggered.

enabled

Rule.enabled  :: boolean

---

Whether the rule is enabled.

exemptRoles

Rule.exemptRoles  :: {string}

---

The role ids that should not be affected by the rule.

exemptChannels

Rule.exemptChannels  :: {string}

---

The channel ids that should not be affected by the rule.

Methods

setName

Rule : setName ( name )  -> AutomoderationRule

Sets the name of the automoderation rule.

Parameters

name: string

Returns

AutomoderationRule

setEventType

Rule : setEventType ( eventType )  -> AutomoderationRule

Sets the event type for the automoderation rule.

Parameters

eventType: EventTypes

Returns

AutomoderationRule

setTriggerType

Rule : setTriggerType ( triggerType )  -> AutomoderationRule

Sets the trigger type for the automoderation rule.

Parameters

triggerType: TriggerTypes

Returns

AutomoderationRule

setTriggerMetadata

Rule : setTriggerMetadata ( triggerMetadata )  -> AutomoderationRule

Sets the trigger metadata for the automoderation rule.

Parameters

triggerMetadata: JSON

Returns

AutomoderationRule

setActions

Rule : setActions ( actions )  -> AutomoderationRule

Sets the actions for the automoderation rule.

Parameters

actions: JSON }

Returns

AutomoderationRule

setEnabled

Rule : setEnabled ( enabled )  -> AutomoderationRule

Sets whether the automoderation rule is enabled.

Parameters

enabled: boolean

Returns

AutomoderationRule

setExemptRoles

Rule : setExemptRoles ( exemptRoles )  -> AutomoderationRule

Sets the exempt roles for the automoderation rule.

Parameters

exemptRoles: Snowflake }

Returns

AutomoderationRule

setExemptChannels

Rule : setExemptChannels ( exemptChannels )  -> AutomoderationRule

Sets the exempt channels for the automoderation rule.

Parameters

exemptChannels: Snowflake }

Returns

AutomoderationRule

build

Rule : build ( )  -> JSON

Builds the automoderation rule object.

Returns

JSON

Functions

new

Rule . new ( resource )  -> AutomoderationRule

Constructs a new automoderation rule builder.

local rule = AutomoderationRule.new({
  name = "My Rule",
  eventType = "MESSAGE_SEND",
  triggerType = "KEYWORD",
  actions = {
    {
      type = "BLOCK_MESSAGE",
      metadata = {}
    }
  }
})

Parameters

resource: { name: string?, eventType: apiTypes.EventTypes?, triggerType: apiTypes.TriggerTypes?, triggerMetadata: triggerMetadata.JSON?, actions: { action.JSON, }

Returns

AutomoderationRule