LogoAntiRaid

@discord-types/builders/automoderation/trigger/metadata

API reference for @discord-types/builders/automoderation/trigger/metadata

@discord-types/builders/automoderation/trigger/metadata

Types

TriggerMetadata

Raw Type
type TriggerMetadata = TriggerMetadata.Prototype, & {
	keywordFilter: {string},

	regexPatterns: {string},

	presets: {apiTypes.AutomoderationRuleKeywordPresetType},

	allowList: {string},

	mentionTotalLimit: number,

	mentionRaidProtectionEnabled: boolean
}

Intersection with variants:

Variant 2
PropTypeDescription
keywordFilter
-
regexPatterns
-
presets
-
allowList
-
mentionTotalLimit
-
mentionRaidProtectionEnabled
-

JSON

Raw Type
type JSON = TriggerMetadata.Prototype.build(nil :: any),

Functions

TriggerMetadata.Prototype.setKeywordFilter

[[ Sets the list of keywords to match. ]]

Function Signature
--[[
 	Sets the list of keywords to match.
 ]]
function TriggerMetadata.Prototype.setKeywordFilter(self: TriggerMetadata, keywordFilter: {string}) -> TriggerMetadata end

Arguments

keywordFilter

{string}

Returns

ret1

TriggerMetadata

TriggerMetadata.Prototype.setRegexPatterns

[[ Sets the list of regular expressions to match. ]]

Function Signature
--[[
 	Sets the list of regular expressions to match.
 ]]
function TriggerMetadata.Prototype.setRegexPatterns(self: TriggerMetadata, regexPatterns: {string}) -> TriggerMetadata end

Arguments

regexPatterns

{string}

Returns

ret1

TriggerMetadata

TriggerMetadata.Prototype.setPresets

[[ Sets the list of preset keywords to match. ]]

Function Signature
--[[
 	Sets the list of preset keywords to match.
 ]]
function TriggerMetadata.Prototype.setPresets(self: TriggerMetadata, presets: {apiTypes.AutomoderationRuleKeywordPresetType}) -> TriggerMetadata end

Arguments

presets

{apiTypes.AutomoderationRuleKeywordPresetType}

Returns

ret1

TriggerMetadata

TriggerMetadata.Prototype.setAllowList

[[ Sets the list of allowed keywords. ]]

Function Signature
--[[
 	Sets the list of allowed keywords.
 ]]
function TriggerMetadata.Prototype.setAllowList(self: TriggerMetadata, allowList: {string}) -> TriggerMetadata end

Arguments

allowList

{string}

Returns

ret1

TriggerMetadata

TriggerMetadata.Prototype.setMentionTotalLimit

[[ Sets the maximum number of mentions allowed. ]]

Function Signature
--[[
 	Sets the maximum number of mentions allowed.
 ]]
function TriggerMetadata.Prototype.setMentionTotalLimit(self: TriggerMetadata, mentionTotalLimit: number) -> TriggerMetadata end

Arguments

mentionTotalLimit

number

Returns

ret1

TriggerMetadata

TriggerMetadata.Prototype.setMentionRaidProtectionEnabled

[[ Sets whether raid protection is enabled. ]]

Function Signature
--[[
 	Sets whether raid protection is enabled.
 ]]
function TriggerMetadata.Prototype.setMentionRaidProtectionEnabled(self: TriggerMetadata, mentionRaidProtectionEnabled: boolean) -> TriggerMetadata end

Arguments

mentionRaidProtectionEnabled

boolean

Returns

ret1

TriggerMetadata

TriggerMetadata.Prototype.build

[[ Builds the trigger metadata object. ]]

Function Signature
--[[
 	Builds the trigger metadata object.
 ]]
function TriggerMetadata.Prototype.build(self: TriggerMetadata) -> JSON end

Returns

ret1

JSON

TriggerMetadata.Interface.new

[[ Responsible for creating a new TriggerMetadata.

```lua

``` ]]

Function Signature
--[[
 	Responsible for creating a new TriggerMetadata.
 
 	\`\`\`lua
 	
 	\`\`\`
 ]]
function TriggerMetadata.Interface.new(resource: {
		keywordFilter: {string}?,

		regexPatterns: {string}?,

		presets: {apiTypes.AutomoderationRuleKeywordPresetType}?,

		allowList: {string}?,

		mentionTotalLimit: number?,

		mentionRaidProtectionEnabled: boolean?
	}?) -> TriggerMetadata end

Arguments

resource

This field is optional and may not be specified

{keywordFilter: {string}?, regexPatterns: {string}?, presets: {apiTypes.AutomoderationRuleKeywordPresetType}?, allowList: {string}?, mentionTotalLimit: number?, mentionRaidProtectionEnabled: boolean?}?

Returns

ret1

TriggerMetadata

Last updated on