kord-rest/dev.kord.rest.builder.automoderation

Package-level declarations

Types

AllowedKeywordsAutoModerationRuleBuilder

interface AllowedKeywordsAutoModerationRuleBuilder : TypedAutoModerationRuleBuilder

An AutoModerationRuleBuilder for building rules that can have allowedKeywords.

AutoModerationActionBuilder

sealed class AutoModerationActionBuilder : RequestBuilder<DiscordAutoModerationAction>

A RequestBuilder for building actions which will execute whenever a rule is triggered.

AutoModerationRuleBuilder

interface AutoModerationRuleBuilder : AuditBuilder

An AuditBuilder for building Auto Moderation Rules.

AutoModerationRuleCreateBuilder

sealed class AutoModerationRuleCreateBuilder : TypedAutoModerationRuleBuilder, AuditRequestBuilder<AutoModerationRuleCreateRequest>

An AutoModerationRuleBuilder for building AutoModerationRuleCreateRequests.

AutoModerationRuleModifyBuilder

sealed class AutoModerationRuleModifyBuilder : AutoModerationRuleBuilder, AuditRequestBuilder<AutoModerationRuleModifyRequest>

An AutoModerationRuleBuilder for building AutoModerationRuleModifyRequests.

BlockMessageAutoModerationActionBuilder

class BlockMessageAutoModerationActionBuilder : AutoModerationActionBuilder

An AutoModerationActionBuilder for building actions with type BlockMessage.

KeywordAutoModerationRuleBuilder

interface KeywordAutoModerationRuleBuilder : TimeoutAutoModerationRuleBuilder, AllowedKeywordsAutoModerationRuleBuilder

An AutoModerationRuleBuilder for building rules with trigger type Keyword.

KeywordAutoModerationRuleCreateBuilder

class KeywordAutoModerationRuleCreateBuilder(var name: String, var eventType: AutoModerationRuleEventType) : AutoModerationRuleCreateBuilder, KeywordAutoModerationRuleBuilder

A KeywordAutoModerationRuleBuilder for building AutoModerationRuleCreateRequests.

KeywordAutoModerationRuleModifyBuilder

class KeywordAutoModerationRuleModifyBuilder : AutoModerationRuleModifyBuilder, KeywordAutoModerationRuleBuilder

A KeywordAutoModerationRuleBuilder for building AutoModerationRuleModifyRequests.

KeywordPresetAutoModerationRuleBuilder

interface KeywordPresetAutoModerationRuleBuilder : AllowedKeywordsAutoModerationRuleBuilder

An AutoModerationRuleBuilder for building rules with trigger type KeywordPreset.

KeywordPresetAutoModerationRuleCreateBuilder

class KeywordPresetAutoModerationRuleCreateBuilder(var name: String, var eventType: AutoModerationRuleEventType) : AutoModerationRuleCreateBuilder, KeywordPresetAutoModerationRuleBuilder

A KeywordPresetAutoModerationRuleBuilder for building AutoModerationRuleCreateRequests.

KeywordPresetAutoModerationRuleModifyBuilder

class KeywordPresetAutoModerationRuleModifyBuilder : AutoModerationRuleModifyBuilder, KeywordPresetAutoModerationRuleBuilder

A KeywordPresetAutoModerationRuleBuilder for building AutoModerationRuleModifyRequests.

MentionSpamAutoModerationRuleBuilder

interface MentionSpamAutoModerationRuleBuilder : TimeoutAutoModerationRuleBuilder

An AutoModerationRuleBuilder for building rules with trigger type MentionSpam.

MentionSpamAutoModerationRuleCreateBuilder

class MentionSpamAutoModerationRuleCreateBuilder(var name: String, var eventType: AutoModerationRuleEventType, var mentionLimit: Int) : AutoModerationRuleCreateBuilder, MentionSpamAutoModerationRuleBuilder

A MentionSpamAutoModerationRuleBuilder for building AutoModerationRuleCreateRequests.

MentionSpamAutoModerationRuleModifyBuilder

class MentionSpamAutoModerationRuleModifyBuilder : AutoModerationRuleModifyBuilder, MentionSpamAutoModerationRuleBuilder

A MentionSpamAutoModerationRuleBuilder for building AutoModerationRuleModifyRequests.

SendAlertMessageAutoModerationActionBuilder

class SendAlertMessageAutoModerationActionBuilder(var channelId: Snowflake) : AutoModerationActionBuilder

An AutoModerationActionBuilder for building actions with type SendAlertMessage.

SpamAutoModerationRuleBuilder

interface SpamAutoModerationRuleBuilder : TypedAutoModerationRuleBuilder

An AutoModerationRuleBuilder for building rules with trigger type Spam.

SpamAutoModerationRuleCreateBuilder

class SpamAutoModerationRuleCreateBuilder(var name: String, var eventType: AutoModerationRuleEventType) : AutoModerationRuleCreateBuilder, SpamAutoModerationRuleBuilder

A SpamAutoModerationRuleBuilder for building AutoModerationRuleCreateRequests.

SpamAutoModerationRuleModifyBuilder

class SpamAutoModerationRuleModifyBuilder : AutoModerationRuleModifyBuilder, SpamAutoModerationRuleBuilder

A SpamAutoModerationRuleBuilder for building AutoModerationRuleModifyRequests.

TimeoutAutoModerationActionBuilder

class TimeoutAutoModerationActionBuilder(var duration: Duration) : AutoModerationActionBuilder

An AutoModerationActionBuilder for building actions with type Timeout.

TimeoutAutoModerationRuleBuilder

interface TimeoutAutoModerationRuleBuilder : TypedAutoModerationRuleBuilder

An AutoModerationRuleBuilder for building rules that can have a Timeout action.

TypedAutoModerationRuleBuilder

interface TypedAutoModerationRuleBuilder : AutoModerationRuleBuilder

An AutoModerationRuleBuilder with a non-null triggerType.

UntypedAutoModerationRuleModifyBuilder

class UntypedAutoModerationRuleModifyBuilder : AutoModerationRuleModifyBuilder

An AutoModerationRuleModifyBuilder with an always null triggerType.

Functions

allowAnywhereKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowAnywhereKeyword(keyword: String)

Add a keyword with keyword matching strategy Anywhere to allowedKeywords.

allowKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowKeyword(keyword: String)

Add a keyword to allowedKeywords.

allowPrefixKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowPrefixKeyword(keyword: String)

Add a keyword with keyword matching strategy Prefix to allowedKeywords.

allowSuffixKeyword

fun AllowedKeywordsAutoModerationRuleBuilder.allowSuffixKeyword(keyword: String)

Add a keyword with keyword matching strategy Suffix to allowedKeywords.

anywhereKeyword

fun KeywordAutoModerationRuleBuilder.anywhereKeyword(keyword: String)

Add a keyword with keyword matching strategy Anywhere to keywords (maximum of 1000).

blockMessage

inline fun AutoModerationRuleBuilder.blockMessage(builder: BlockMessageAutoModerationActionBuilder.() -> Unit = {})

Add a BlockMessage action which will execute whenever the rule is triggered.

exemptChannel

fun AutoModerationRuleBuilder.exemptChannel(channelId: Snowflake)

Exempt a channel from being affected by the rule (maximum of 50).

exemptRole

fun AutoModerationRuleBuilder.exemptRole(roleId: Snowflake)

Exempt a role from being affected by the rule (maximum of 20).

keyword

fun KeywordAutoModerationRuleBuilder.keyword(keyword: String)

Add a keyword to keywords (maximum of 1000).

prefixKeyword

fun KeywordAutoModerationRuleBuilder.prefixKeyword(keyword: String)

Add a keyword with keyword matching strategy Prefix to keywords (maximum of 1000).

preset

fun KeywordPresetAutoModerationRuleBuilder.preset(preset: AutoModerationRuleKeywordPresetType)

Add a preset to presets.

regexPattern

fun KeywordAutoModerationRuleBuilder.regexPattern(pattern: String)

Add a pattern to regexPatterns (maximum of 10).

sendAlertMessage

inline fun AutoModerationRuleBuilder.sendAlertMessage(channelId: Snowflake, builder: SendAlertMessageAutoModerationActionBuilder.() -> Unit = {})

Add a SendAlertMessage action which will execute whenever the rule is triggered.

suffixKeyword

fun KeywordAutoModerationRuleBuilder.suffixKeyword(keyword: String)

Add a keyword with keyword matching strategy Suffix to keywords (maximum of 1000).

timeout

inline fun TimeoutAutoModerationRuleBuilder.timeout(duration: Duration, builder: TimeoutAutoModerationActionBuilder.() -> Unit = {})

Add a Timeout action which will execute whenever the rule is triggered.