TriggerMetadata

Implementation of a discord auto moderation trigger metadata object as a luau builder.

Summary

Properties

TriggerMetadata.keywordFilter :: {string}TriggerMetadata.regexPatterns :: {string}TriggerMetadata.presets :: {api_types.KeywordPresetType}TriggerMetadata.allowList :: {string}TriggerMetadata.mentionTotalLimit :: numberTriggerMetadata.mentionRaidProtectionEnabled :: boolean

Methods

TriggerMetadata:setKeywordFilter(keywordFilter: { string }) → TriggerMetadataTriggerMetadata:setRegexPatterns(regexPatterns: { string }) → TriggerMetadataTriggerMetadata:setPresets(presets: { apiTypes.KeywordPresetType }) → TriggerMetadataTriggerMetadata:setAllowList(allowList: { string }) → TriggerMetadataTriggerMetadata:setMentionTotalLimit(mentionTotalLimit: number) → TriggerMetadataTriggerMetadata:setMentionRaidProtectionEnabled(mentionRaidProtectionEnabled: boolean) → TriggerMetadataTriggerMetadata:build() → JSON

Functions

TriggerMetadata.new(resource: { keywordFilter: { string }?, regexPatterns: { string }?, presets: { apiTypes.KeywordPresetType }?, allowList: { string }?, mentionTotalLimit: number?, mentionRaidProtectionEnabled: boolean?, }?) → TriggerMetadata

Properties

keywordFilter

TriggerMetadata.keywordFilter  :: {string}

---

Array of strings that represent keywords that will trigger the rule.

regexPatterns

TriggerMetadata.regexPatterns  :: {string}

---

Array of strings that represent regex patterns that will trigger the rule.

presets

TriggerMetadata.presets  :: KeywordPresetType}

---

Array of preset keyword types that will trigger the rule.

allowList

TriggerMetadata.allowList  :: {string}

---

Array of strings that represent keywords that should not trigger the rule.

mentionTotalLimit

TriggerMetadata.mentionTotalLimit  :: number

---

Total number of unique role and user mentions allowed per message.

mentionRaidProtectionEnabled

TriggerMetadata.mentionRaidProtectionEnabled  :: boolean

---

Whether to automatically detect mention raids and remove them.

Methods

setKeywordFilter

TriggerMetadata : setKeywordFilter ( keywordFilter )  -> TriggerMetadata

Sets the list of keywords to match.

Parameters

keywordFilter: { string }

Returns

TriggerMetadata

setRegexPatterns

TriggerMetadata : setRegexPatterns ( regexPatterns )  -> TriggerMetadata

Sets the list of regular expressions to match.

Parameters

regexPatterns: { string }

Returns

TriggerMetadata

setPresets

TriggerMetadata : setPresets ( presets )  -> TriggerMetadata

Sets the list of preset keywords to match.

Parameters

presets: KeywordPresetType }

Returns

TriggerMetadata

setAllowList

TriggerMetadata : setAllowList ( allowList )  -> TriggerMetadata

Sets the list of allowed keywords.

Parameters

allowList: { string }

Returns

TriggerMetadata

setMentionTotalLimit

TriggerMetadata : setMentionTotalLimit ( mentionTotalLimit )  -> TriggerMetadata

Sets the maximum number of mentions allowed.

Parameters

mentionTotalLimit: number

Returns

TriggerMetadata

setMentionRaidProtectionEnabled

TriggerMetadata : setMentionRaidProtectionEnabled ( mentionRaidProtectionEnabled )  -> TriggerMetadata

Sets whether raid protection is enabled.

Parameters

mentionRaidProtectionEnabled: boolean

Returns

TriggerMetadata

build

TriggerMetadata : build ( )  -> JSON

Builds the trigger metadata object.

Returns

JSON

Functions

new

TriggerMetadata . new ( resource )  -> TriggerMetadata

Responsible for creating a new TriggerMetadata.

local metadata = TriggerMetadata.new({
  keywordFilter = {"bad", "words"},
  mentionTotalLimit = 5
})

Parameters

resource: { { keywordFilter: { string } }

Returns

TriggerMetadata