Package xyz.dynxsty.dih4jda

Class DIH4JDA

java.lang.Object

net.dv8tion.jda.api.hooks.ListenerAdapter

xyz.dynxsty.dih4jda.DIH4JDA

All Implemented Interfaces:

net.dv8tion.jda.api.hooks.EventListener

public class DIH4JDA
extends net.dv8tion.jda.api.hooks.ListenerAdapter

Getting Started

Creating a new DIH4JDA instance is fairly easy:

 DIH4JDA dih4jda = DIH4JDABuilder
         .setJDA(jda) // Your JDA instance
         .build();
 

Now, you get to decide how you want your commands to be registered:

Manual Command Registration

To manually register commands, use the following methods, AFTER you've .build(); your DIH4JDA instance, like that:

 DIH4JDA dih4jda = DIH4JDABuilder
         .setJDA(jda) // Your JDA instance
         .build();
 dih4jda.addSlashCommands(new PingCommand(), new HelloWorldCommand());
 dih4jda.addContextMenus(new PingUserContext(), new HelloWorldMessageContext());
 

Automatic Command Registration

Alternatively, you can specify packages on the DIH4JDABuilder instance which will be scanned for all classes that extend one of the following classes:

• SlashCommand
• ContextCommand.User
• ContextCommand.Message

 DIH4JDA dih4jda = DIH4JDABuilder
         .setJDA(jda) // Your JDA instance
         .setCommandPackages("xyz.dynxsty.bot.commands") // OPTIONAL: The package(s) that contains all your commands
         .build();
 

Upon calling .build();, the bot will register all commands that are in the specified package(s).

Constructor Summary

Constructors

Constructor	Description
DIH4JDA(DIH4JDAConfig config)	Constructs a new DIH4JDA instance using the specified DIH4JDAConfig.

Method Summary

Modifier and Type	Method	Description
final void	addButtonMappings(IdMapping<ButtonHandler>... mappings)	Binds all ButtonHandlers to their id using IdMapping
void	addContextCommands(ContextCommand<?>... commands)	Manually registers ContextCommands.
final void	addEntitySelectMenuMappings(IdMapping<EntitySelectMenuHandler>... mappings)	Binds all EntitySelectMenuHandlers to their id,
void	addEventListener(Object... classes)	Allows to register event listener classes.
final void	addModalMappings(IdMapping<ModalHandler>... mappings)	Binds all ModalHandlers to their id.
void	addSlashCommands(SlashCommand... commands)	Manually registers SlashCommands.
final void	addStringSelectMenuMappings(IdMapping<StringSelectMenuHandler>... mappings)	Binds all StringSelectMenuHandlers to their id.
net.dv8tion.jda.api.JDA	getJDA()	Gets the JDA instance DIH4JDA uses.
void	onReady(net.dv8tion.jda.api.events.session.ReadyEvent event)	Ran once the JDA instance fires the ReadyEvent.
void	registerInteractions()	Registers all Interactions and replaces the old ones.
static void	setDefaultRegistrationType(RegistrationType type)	Sets the default RegistrationType for all Application Commands.

Methods inherited from class net.dv8tion.jda.api.hooks.ListenerAdapter

onApplicationCommandUpdatePrivileges, onApplicationUpdatePrivileges, onAutoModExecution, onAutoModRuleCreate, onAutoModRuleDelete, onAutoModRuleUpdate, onButtonInteraction, onChannelCreate, onChannelDelete, onChannelUpdateAppliedTags, onChannelUpdateArchived, onChannelUpdateArchiveTimestamp, onChannelUpdateAutoArchiveDuration, onChannelUpdateBitrate, onChannelUpdateDefaultLayout, onChannelUpdateDefaultReaction, onChannelUpdateDefaultSortOrder, onChannelUpdateDefaultThreadSlowmode, onChannelUpdateFlags, onChannelUpdateInvitable, onChannelUpdateLocked, onChannelUpdateName, onChannelUpdateNSFW, onChannelUpdateParent, onChannelUpdatePosition, onChannelUpdateRegion, onChannelUpdateSlowmode, onChannelUpdateTopic, onChannelUpdateType, onChannelUpdateUserLimit, onChannelUpdateVoiceStatus, onCommandAutoCompleteInteraction, onEmojiAdded, onEmojiRemoved, onEmojiUpdateName, onEmojiUpdateRoles, onEntitlementCreate, onEntitlementDelete, onEntitlementUpdate, onEntitySelectInteraction, onEvent, onException, onForumTagAdd, onForumTagRemove, onForumTagUpdateEmoji, onForumTagUpdateModerated, onForumTagUpdateName, onGatewayPing, onGenericAutoCompleteInteraction, onGenericAutoModRule, onGenericChannel, onGenericChannelUpdate, onGenericCommandInteraction, onGenericComponentInteractionCreate, onGenericContextInteraction, onGenericEmoji, onGenericEmojiUpdate, onGenericEntitlement, onGenericEvent, onGenericForumTag, onGenericForumTagUpdate, onGenericGuild, onGenericGuildInvite, onGenericGuildMember, onGenericGuildMemberUpdate, onGenericGuildSticker, onGenericGuildStickerUpdate, onGenericGuildUpdate, onGenericGuildVoice, onGenericInteractionCreate, onGenericMessage, onGenericMessagePollVote, onGenericMessageReaction, onGenericPermissionOverride, onGenericPrivilegeUpdate, onGenericRole, onGenericRoleUpdate, onGenericScheduledEventGateway, onGenericScheduledEventUpdate, onGenericScheduledEventUser, onGenericSelectMenuInteraction, onGenericSelfUpdate, onGenericSession, onGenericStageInstance, onGenericStageInstanceUpdate, onGenericThread, onGenericThreadMember, onGenericUpdate, onGenericUser, onGenericUserPresence, onGenericUserUpdate, onGuildAuditLogEntryCreate, onGuildAvailable, onGuildBan, onGuildInviteCreate, onGuildInviteDelete, onGuildJoin, onGuildLeave, onGuildMemberJoin, onGuildMemberRemove, onGuildMemberRoleAdd, onGuildMemberRoleRemove, onGuildMemberUpdate, onGuildMemberUpdateAvatar, onGuildMemberUpdateBoostTime, onGuildMemberUpdateFlags, onGuildMemberUpdateNickname, onGuildMemberUpdatePending, onGuildMemberUpdateTimeOut, onGuildReady, onGuildStickerAdded, onGuildStickerRemoved, onGuildStickerUpdateAvailable, onGuildStickerUpdateDescription, onGuildStickerUpdateName, onGuildStickerUpdateTags, onGuildTimeout, onGuildUnavailable, onGuildUnban, onGuildUpdateAfkChannel, onGuildUpdateAfkTimeout, onGuildUpdateBanner, onGuildUpdateBoostCount, onGuildUpdateBoostTier, onGuildUpdateCommunityUpdatesChannel, onGuildUpdateDescription, onGuildUpdateExplicitContentLevel, onGuildUpdateFeatures, onGuildUpdateIcon, onGuildUpdateLocale, onGuildUpdateMaxMembers, onGuildUpdateMaxPresences, onGuildUpdateMFALevel, onGuildUpdateName, onGuildUpdateNotificationLevel, onGuildUpdateNSFWLevel, onGuildUpdateOwner, onGuildUpdateRulesChannel, onGuildUpdateSplash, onGuildUpdateSystemChannel, onGuildUpdateVanityCode, onGuildUpdateVerificationLevel, onGuildVoiceDeafen, onGuildVoiceGuildDeafen, onGuildVoiceGuildMute, onGuildVoiceMute, onGuildVoiceRequestToSpeak, onGuildVoiceSelfDeafen, onGuildVoiceSelfMute, onGuildVoiceStream, onGuildVoiceSuppress, onGuildVoiceUpdate, onGuildVoiceVideo, onHttpRequest, onMessageBulkDelete, onMessageContextInteraction, onMessageDelete, onMessagePollVoteAdd, onMessagePollVoteRemove, onMessageReactionAdd, onMessageReactionRemove, onMessageReactionRemoveAll, onMessageReactionRemoveEmoji, onMessageReceived, onMessageUpdate, onModalInteraction, onPermissionOverrideCreate, onPermissionOverrideDelete, onPermissionOverrideUpdate, onRawGateway, onRoleCreate, onRoleDelete, onRoleUpdateColor, onRoleUpdateHoisted, onRoleUpdateIcon, onRoleUpdateMentionable, onRoleUpdateName, onRoleUpdatePermissions, onRoleUpdatePosition, onScheduledEventCreate, onScheduledEventDelete, onScheduledEventUpdateDescription, onScheduledEventUpdateEndTime, onScheduledEventUpdateImage, onScheduledEventUpdateLocation, onScheduledEventUpdateName, onScheduledEventUpdateStartTime, onScheduledEventUpdateStatus, onScheduledEventUserAdd, onScheduledEventUserRemove, onSelfUpdateAvatar, onSelfUpdateDiscriminator, onSelfUpdateGlobalName, onSelfUpdateMFA, onSelfUpdateName, onSelfUpdateVerified, onSessionDisconnect, onSessionInvalidate, onSessionRecreate, onSessionResume, onShutdown, onSlashCommandInteraction, onStageInstanceCreate, onStageInstanceDelete, onStageInstanceUpdatePrivacyLevel, onStageInstanceUpdateTopic, onStatusChange, onStringSelectInteraction, onThreadHidden, onThreadMemberJoin, onThreadMemberLeave, onThreadRevealed, onUnavailableGuildJoined, onUnavailableGuildLeave, onUserActivityEnd, onUserActivityStart, onUserContextInteraction, onUserTyping, onUserUpdateActivities, onUserUpdateActivityOrder, onUserUpdateAvatar, onUserUpdateDiscriminator, onUserUpdateFlags, onUserUpdateGlobalName, onUserUpdateName, onUserUpdateOnlineStatus

Methods inherited from class java.lang.Object

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

Constructor Details

DIH4JDA

public DIH4JDA(@Nonnull
 DIH4JDAConfig config)
        throws DIH4JDAException

Constructs a new DIH4JDA instance using the specified DIH4JDAConfig. It is highly recommended to use the DIH4JDABuilder instead.

Parameters:

config - The instance's configuration.

Throws:

DIH4JDAException - if the given DIH4JDAConfig is invalid.

Method Details

onReady

public void onReady(@Nonnull
 net.dv8tion.jda.api.events.session.ReadyEvent event)

Ran once the JDA instance fires the ReadyEvent.

Overrides:

onReady in class net.dv8tion.jda.api.hooks.ListenerAdapter

Parameters:

event - The ReadyEvent that was fired.

setDefaultRegistrationType

public static void setDefaultRegistrationType(@Nonnull
 RegistrationType type)

Sets the default RegistrationType for all Application Commands. This is set to RegistrationType.GLOBAL if not set otherwise.

Parameters:

type - The RegistrationType.

registerInteractions

public void registerInteractions()

Registers all Interactions and replaces the old ones. Please note that global commands may need up to an hour before they're fully registered.

addEventListener

public void addEventListener(@Nonnull
 Object... classes)

Allows to register event listener classes.

Parameters:

classes - Implementations of DIH4JDAEventListener.

Since:

v1.5

getJDA

@Nonnull
public net.dv8tion.jda.api.JDA getJDA()

Gets the JDA instance DIH4JDA uses.

Returns:

The JDA instance.

addSlashCommands

public void addSlashCommands(@Nonnull
 SlashCommand... commands)

Manually registers SlashCommands.

Parameters:

commands - An array of commands to register.

addContextCommands

public void addContextCommands(@Nonnull
 ContextCommand<?>... commands)

Manually registers ContextCommands.

Parameters:

commands - An array of commands to register.

addButtonMappings

@SafeVarargs
public final void addButtonMappings(@Nonnull
 IdMapping<ButtonHandler>... mappings)

Binds all ButtonHandlers to their id using IdMapping

 dih4jda.addButtonMappings(
     IdMapping.of(new PingCommand(), "ping", "hello-world"),
     IdMapping.of(new DummyCommand(), "dummy", "test")
 );
 

This is best used in combination with ComponentIdBuilder.build(String, Object...).

Parameters:

mappings - All ButtonHandler, as an array of IdMapping.

addStringSelectMenuMappings

@SafeVarargs
public final void addStringSelectMenuMappings(@Nonnull
 IdMapping<StringSelectMenuHandler>... mappings)

Binds all StringSelectMenuHandlers to their id.

 dih4jda.addStringSelectMenuMappings(
     IdMapping.of(new PingCommand(), "ping", "hello-world"),
     IdMapping.of(new DummyCommand(), "dummy", "test")
 );
 

This is best used in combination with ComponentIdBuilder.build(String, Object...).

Parameters:

mappings - All StringSelectMenuHandler, as an array of IdMapping.

See Also:

• addEntitySelectMenuMappings(IdMapping[])

addEntitySelectMenuMappings

@SafeVarargs
public final void addEntitySelectMenuMappings(@Nonnull
 IdMapping<EntitySelectMenuHandler>... mappings)

Binds all EntitySelectMenuHandlers to their id,

 dih4jda.addEntitySelectMenuMappings(
     IdMapping.of(new PingCommand(), "ping", "hello-world"),
     IdMapping.of(new DummyCommand(), "dummy", "test")
 );
 

This is best used in combination with ComponentIdBuilder.build(String, Object...).

Parameters:

mappings - All EntitySelectMenuHandler, as an array of IdMapping.

See Also:

• addStringSelectMenuMappings(IdMapping[])

addModalMappings

@SafeVarargs
public final void addModalMappings(@Nonnull
 IdMapping<ModalHandler>... mappings)

Binds all ModalHandlers to their id.

 dih4jda.addModalMappings(
     IdMapping.of(new PingCommand(), "ping", "hello-world"),
     IdMapping.of(new DummyCommand(), "dummy", "test")
 );
 

This is best used in combination with ComponentIdBuilder.build(String, Object...).

Parameters:

mappings - All ModalHandler, as an array of IdMapping.