Package net.dv8tion.jda.api.events.automod

Class AutoModExecutionEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.automod.AutoModExecutionEvent

All Implemented Interfaces:

AutoModExecution, GenericEvent

public class AutoModExecutionEvent
extends Event
implements AutoModExecution

Indicates that an automated AutoModResponse has been triggered through an AutoModRule.

Requirements
This event requires the AUTO_MODERATION_EXECUTION intent to be enabled.
This event will only fire for guilds where the bot has the MANAGE_SERVER permission. Additionally, access to getContent() and getMatchedContent() requires the MESSAGE_CONTENT intent to be enabled.

Constructor Summary

Constructors

Constructor	Description
AutoModExecutionEvent(JDA api, long responseNumber, AutoModExecution execution)

Method Summary

Modifier and Type	Method	Description
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 AutoModExecution.getContent().
long	getMessageIdLong()	The id of the Message which triggered the rule.
AutoModResponse	getResponse()	The AutoModResponse that has been triggered by this execution.
long	getRuleIdLong()	The id of the AutoModRule which has been triggered.
AutoModTriggerType	getTriggerType()	The AutoModTriggerType for the execution.
long	getUserIdLong()	The id of the user that triggered this execution.

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.automod.AutoModExecution

getAlertMessageId, getMessageId, getRuleId, getUserId

Constructor Details

AutoModExecutionEvent

public AutoModExecutionEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 AutoModExecution execution)

Method Details

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: AutoModExecution

The Guild that this execution occurred in.

Specified by:

getGuild in interface AutoModExecution

Returns:

The Guild

getChannel

@Nullable
public GuildMessageChannelUnion getChannel()

Description copied from interface: AutoModExecution

The GuildMessageChannelUnion that this execution occurred in.

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

Specified by:

getChannel in interface AutoModExecution

Returns:

The GuildMessageChannelUnion

getResponse

@Nonnull
public AutoModResponse getResponse()

Description copied from interface: AutoModExecution

The AutoModResponse that has been triggered by this execution.

Specified by:

getResponse in interface AutoModExecution

Returns:

The AutoModResponse

getTriggerType

@Nonnull
public AutoModTriggerType getTriggerType()

Description copied from interface: AutoModExecution

The AutoModTriggerType for the execution.

Specified by:

getTriggerType in interface AutoModExecution

Returns:

The AutoModTriggerType

getUserIdLong

public long getUserIdLong()

Description copied from interface: AutoModExecution

The id of the user that triggered this execution.

Specified by:

getUserIdLong in interface AutoModExecution

Returns:

The id of the user

getRuleIdLong

public long getRuleIdLong()

Description copied from interface: AutoModExecution

The id of the AutoModRule which has been triggered.

Specified by:

getRuleIdLong in interface AutoModExecution

Returns:

The id of the rule

getMessageIdLong

public long getMessageIdLong()

Description copied from interface: AutoModExecution

The id of the Message which triggered the rule.

Specified by:

getMessageIdLong in interface AutoModExecution

Returns:

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

getAlertMessageIdLong

public long getAlertMessageIdLong()

Description copied from interface: AutoModExecution

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

Specified by:

getAlertMessageIdLong in interface AutoModExecution

Returns:

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

getContent

@Nonnull
public String getContent()

Description copied from interface: AutoModExecution

The user content that triggered this rule.

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

Specified by:

getContent in interface AutoModExecution

Returns:

The user content

getMatchedContent

@Nullable
public String getMatchedContent()

Description copied from interface: AutoModExecution

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 AutoModExecution.getMatchedKeyword() regardless.

Specified by:

getMatchedContent in interface AutoModExecution

Returns:

The user content substring

getMatchedKeyword

@Nullable
public String getMatchedKeyword()

Description copied from interface: AutoModExecution

The keyword that was found in the AutoModExecution.getContent().

Specified by:

getMatchedKeyword in interface AutoModExecution

Returns:

The keyword that was found in the content