Package discord4j.core.object.automod

Class AutoModRuleAction.AutoModRuleActionMetaData

java.lang.Object

discord4j.core.object.automod.AutoModRuleAction.AutoModRuleActionMetaData

All Implemented Interfaces:

DiscordObject

Enclosing class:

AutoModRuleAction

public static class AutoModRuleAction.AutoModRuleActionMetaData
extends Object
implements DiscordObject

An Auto Moderation Rule Action MetaData

See Also:

Auto Moderation Rule Action MetaData

Constructor Summary

Constructors

Constructor	Description
AutoModRuleActionMetaData(GatewayDiscordClient gateway, discord4j.discordjson.json.AutoModActionMetaData data)

Method Summary

Modifier and Type	Method	Description
Optional<Snowflake>	getChannelId()	Gets the channel´s id to which user content should be logged.
GatewayDiscordClient	getClient()	Returns the GatewayDiscordClient that created this object.
Optional<String>	getCustomMessage()	Gets the custom message to show when the action is executed.
Optional<Integer>	getDurationTimeout()	Gets the timeout duration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoModRuleActionMetaData

public AutoModRuleActionMetaData(GatewayDiscordClient gateway,
                                 discord4j.discordjson.json.AutoModActionMetaData data)

Method Detail

getChannelId

public Optional<Snowflake> getChannelId()

Gets the channel´s id to which user content should be logged.
Note: This is mostly present the action is of type AutoModRuleAction.Type.SEND_ALERT_MESSAGE.

Returns:

The ID of the channel involved, if present.

getDurationTimeout

public Optional<Integer> getDurationTimeout()

Gets the timeout duration.
Note: This is mostly present the action is of type AutoModRuleAction.Type.TIMEOUT.

Returns:

The duration in seconds, if present.

getCustomMessage

public Optional<String> getCustomMessage()

Gets the custom message to show when the action is executed.
Note: This is mostly present the action is of type AutoModRuleAction.Type.BLOCK_MESSAGE.

Returns:

The custom message, if present.

getClient

public GatewayDiscordClient getClient()

Description copied from interface: DiscordObject

Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.

Specified by:

getClient in interface DiscordObject

Returns:

The GatewayDiscordClient associated to this object.