Package net.dv8tion.jda.api.entities.automod

Interface AutoModExecution

All Known Implementing Classes:

AutoModExecutionEvent

public interface AutoModExecution

Event triggered by an AutoModRule activation.

Method Summary

Modifier and Type	Method	Description
default String	getAlertMessageId()	The id of the alert Message sent to the alert channel.
long	getAlertMessageIdLong()	The id of the alert Message sent to the alert channel.
GuildMessageChannelUnion	getChannel()	The GuildMessageChannelUnion that this execution occurred in.
String	getContent()	The user content that triggered this rule.
Guild	getGuild()	The Guild that this execution occurred in.
String	getMatchedContent()	The substring match of the user content that triggered this rule.
String	getMatchedKeyword()	The keyword that was found in the getContent().
default String	getMessageId()	The id of the Message which triggered the rule.
long	getMessageIdLong()	The id of the Message which triggered the rule.
AutoModResponse	getResponse()	The AutoModResponse that has been triggered by this execution.
default String	getRuleId()	The id of the AutoModRule which has been triggered.
long	getRuleIdLong()	The id of the AutoModRule which has been triggered.
AutoModTriggerType	getTriggerType()	The AutoModTriggerType for the execution.
default String	getUserId()	The id of the user that triggered this execution.
long	getUserIdLong()	The id of the user that triggered this execution.

Method Details

getGuild

@Nonnull
Guild getGuild()

The Guild that this execution occurred in.

Returns:

The Guild

getChannel

@Nullable
GuildMessageChannelUnion getChannel()

The GuildMessageChannelUnion that this execution occurred in.

This might be null if the execution occurred by future event types.

Returns:

The GuildMessageChannelUnion

getResponse

@Nonnull
AutoModResponse getResponse()

The AutoModResponse that has been triggered by this execution.

Returns:

The AutoModResponse

getTriggerType

@Nonnull
AutoModTriggerType getTriggerType()

The AutoModTriggerType for the execution.

Returns:

The AutoModTriggerType

getUserIdLong

long getUserIdLong()

The id of the user that triggered this execution.

Returns:

The id of the user

getUserId

@Nonnull
default String getUserId()

The id of the user that triggered this execution.

Returns:

The id of the user

getRuleIdLong

long getRuleIdLong()

The id of the AutoModRule which has been triggered.

Returns:

The id of the rule

getRuleId

@Nonnull
default String getRuleId()

The id of the AutoModRule which has been triggered.

Returns:

The id of the rule

getMessageIdLong

long getMessageIdLong()

The id of the Message which triggered the rule.

Returns:

The id of the message, or 0 if the message has been blocked

getMessageId

@Nullable
default String getMessageId()

The id of the Message which triggered the rule.

Returns:

The id of the message, or null if the message has been blocked

getAlertMessageIdLong

long getAlertMessageIdLong()

The id of the alert Message sent to the alert channel.

Returns:

The id of the alert message, or 0 if AutoModResponse.getType() is not AutoModResponse.Type.SEND_ALERT_MESSAGE

getAlertMessageId

@Nullable
default String getAlertMessageId()

The id of the alert Message sent to the alert channel.

Returns:

The id of the alert message, or null if AutoModResponse.getType() is not AutoModResponse.Type.SEND_ALERT_MESSAGE

getContent

@Nonnull
String getContent()

The user content that triggered this rule.

This is empty if GatewayIntent.MESSAGE_CONTENT is not enabled. However, you can still use getMatchedKeyword() regardless.

Returns:

The user content

getMatchedContent

@Nullable
String getMatchedContent()

The substring match of the user content that triggered this rule.

This is empty if GatewayIntent.MESSAGE_CONTENT is not enabled. However, you can still use getMatchedKeyword() regardless.

Returns:

The user content substring

getMatchedKeyword

@Nullable
String getMatchedKeyword()

The keyword that was found in the getContent().

Returns:

The keyword that was found in the content