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

DIH4JDA

Creating a new DIH4JDA instance:

 DIH4JDA dih4JDA = DIH4JDABuilder
         .setJDA(jda) // Your JDA instance
         .setCommandsPackages("com.dynxsty.superawesomebot.commands") // The main package where all your commands are in.
         .build();
 

Upon calling .build();, the bot will automatically register all Commands that are in the given commandsPackage. (if not disabled)

Field Summary

Fields

Modifier and Type	Field	Description
static RegistrationType	defaultCommandType	The default RegistrationType which is used for queuing new commands.

Method Summary

Modifier and Type	Method	Description
void	addButtonHandlers(Map<List<String>,ButtonHandler> handlers)	Binds all ButtonHandlers to their id.
void	addContextCommands(ContextCommand... commands)	Manually registers ContextCommands.
void	addEntitySelectMenuHandlers(Map<List<String>,EntitySelectMenuHandler> handlers)	Binds all EntitySelectMenuHandlers to their id,
void	addEventListener(Object... classes)	Allows to add Listener classes (that implements DIH4JDAEventListener).
void	addModalHandlers(Map<List<String>,ModalHandler> handlers)	Binds all ModalHandlers to their id.
void	addSlashCommands(SlashCommand... commands)	Manually registers SlashCommands.
void	addStringSelectMenuHandlers(Map<List<String>,StringSelectMenuHandler> handlers)	Binds all StringSelectMenuHandlers to their id.
Map<List<String>,ButtonHandler>	getButtonHandlers()	Gets all ButtonHandlers.
DIH4JDAConfig	getConfig()
Map<List<String>,EntitySelectMenuHandler>	getEntitySelectMenuHandlers()	Gets all registered EntitySelectMenuHandlers.
net.dv8tion.jda.api.JDA	getJDA()	Convenience method which replaces invalid @link {@link DIH4JDA#getConfig()#getJDA() }
Map<List<String>,ModalHandler>	getModalHandlers()	Gets all ModalHandlers.
Map<List<String>,StringSelectMenuHandler>	getStringSelectMenuHandlers()	Gets all registered StringSelectMenuHandlers.
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.

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

onApplicationCommandUpdatePrivileges, onApplicationUpdatePrivileges, onButtonInteraction, onChannelCreate, onChannelDelete, onChannelUpdateAppliedTags, onChannelUpdateArchived, onChannelUpdateArchiveTimestamp, onChannelUpdateAutoArchiveDuration, onChannelUpdateBitrate, onChannelUpdateDefaultReaction, onChannelUpdateDefaultThreadSlowmode, onChannelUpdateFlags, onChannelUpdateInvitable, onChannelUpdateLocked, onChannelUpdateName, onChannelUpdateNSFW, onChannelUpdateParent, onChannelUpdatePosition, onChannelUpdateRegion, onChannelUpdateSlowmode, onChannelUpdateTopic, onChannelUpdateType, onChannelUpdateUserLimit, onCommandAutoCompleteInteraction, onEmojiAdded, onEmojiRemoved, onEmojiUpdateName, onEmojiUpdateRoles, onEntitySelectInteraction, onEvent, onException, onForumTagAdd, onForumTagRemove, onForumTagUpdateEmoji, onForumTagUpdateModerated, onForumTagUpdateName, onGatewayPing, onGenericAutoCompleteInteraction, onGenericChannel, onGenericChannelUpdate, onGenericCommandInteraction, onGenericComponentInteractionCreate, onGenericContextInteraction, onGenericEmoji, onGenericEmojiUpdate, onGenericEvent, onGenericForumTag, onGenericForumTagUpdate, onGenericGuild, onGenericGuildInvite, onGenericGuildMember, onGenericGuildMemberUpdate, onGenericGuildSticker, onGenericGuildStickerUpdate, onGenericGuildUpdate, onGenericGuildVoice, onGenericInteractionCreate, onGenericMessage, onGenericMessageReaction, onGenericPermissionOverride, onGenericPrivilegeUpdate, onGenericRole, onGenericRoleUpdate, onGenericScheduledEventUpdate, onGenericSelectMenuInteraction, onGenericSelfUpdate, onGenericSessionEvent, onGenericStageInstance, onGenericStageInstanceUpdate, onGenericThread, onGenericThreadMember, onGenericUpdate, onGenericUser, onGenericUserPresence, onGuildAvailable, onGuildBan, onGuildInviteCreate, onGuildInviteDelete, onGuildJoin, onGuildLeave, onGuildMemberJoin, onGuildMemberRemove, onGuildMemberRoleAdd, onGuildMemberRoleRemove, onGuildMemberUpdate, onGuildMemberUpdateAvatar, onGuildMemberUpdateBoostTime, 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, onMessageEmbed, onMessageReactionAdd, onMessageReactionRemove, onMessageReactionRemoveAll, onMessageReactionRemoveEmoji, onMessageReceived, onMessageUpdate, onModalInteraction, onPermissionOverrideCreate, onPermissionOverrideDelete, onPermissionOverrideUpdate, onRawGateway, onRoleCreate, onRoleDelete, onRoleUpdateColor, onRoleUpdateHoisted, onRoleUpdateIcon, onRoleUpdateMentionable, onRoleUpdateName, onRoleUpdatePermissions, onRoleUpdatePosition, onScheduledEventCreate, onScheduledEventDelete, onScheduledEventUpdateDescription, onScheduledEventUpdateEndTime, onScheduledEventUpdateLocation, onScheduledEventUpdateName, onScheduledEventUpdateStartTime, onScheduledEventUpdateStatus, onScheduledEventUserAdd, onScheduledEventUserRemove, onSelfUpdateAvatar, 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, onUserUpdateName, onUserUpdateOnlineStatus

Methods inherited from class java.lang.Object

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

Field Details

defaultCommandType

public static RegistrationType defaultCommandType

The default RegistrationType which is used for queuing new commands. This can be overridden using BaseCommandRequirements.setRegistrationType(RegistrationType)

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.

registerInteractions

public void registerInteractions()
                          throws ReflectiveOperationException

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

Throws:

ReflectiveOperationException

getConfig

@Nonnull
public DIH4JDAConfig getConfig()

Returns:

The instance's configuration.

addEventListener

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

Allows to add Listener classes (that implements DIH4JDAEventListener).

Since:

v1.5

getJDA

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

Convenience method which replaces

invalid @link

{@link DIH4JDA#getConfig()#getJDA()

}

Returns:

The JDA instance.

addSlashCommands

public void addSlashCommands(SlashCommand... commands)

Manually registers SlashCommands.

Parameters:

commands - An array of commands to register.

addContextCommands

public void addContextCommands(ContextCommand... commands)

Manually registers ContextCommands.

Parameters:

commands - An array of commands to register.

addButtonHandlers

public void addButtonHandlers(Map<List<String>,ButtonHandler> handlers)

Binds all ButtonHandlers to their id.

 dih4jda.addButtonHandlers(Map.of(
 	List.of("apple"), new AppleButtonHandler(),
 	List.of("banana"), new BananaButtonHandler()
 ));
 

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

Parameters:

handlers - All ButtonHandler, as a immutable Map.

getButtonHandlers

@Nonnull
public Map<List<String>,ButtonHandler> getButtonHandlers()

Gets all ButtonHandlers.

Returns:

An immutable Map which stores the id as the Key and the ButtonHandler as the Value.

addStringSelectMenuHandlers

public void addStringSelectMenuHandlers(Map<List<String>,StringSelectMenuHandler> handlers)

Binds all StringSelectMenuHandlers to their id.

 dih4jda.addStringSelectMenuHandlers(Map.of(
 	List.of("apple"), new AppleSelectMenuHandler(),
 	List.of("banana"), new BananaSelectMenuHandler()
 ));
 

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

Parameters:

handlers - All StringSelectMenuHandler, as a immutable Map.

See Also:

• addEntitySelectMenuHandlers(Map)

addEntitySelectMenuHandlers

public void addEntitySelectMenuHandlers(Map<List<String>,EntitySelectMenuHandler> handlers)

Binds all EntitySelectMenuHandlers to their id,

 dih4jda.addEntitySelectMenuHandlers(Map.of(
 	List.of("apple"), new AppleSelectMenuHandler(),
 	List.of("banana"), new BananaSelectMenuHandler()
 ));
 

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

Parameters:

handlers - All EntitySelectMenuHandler, as a immutable Map.

See Also:

• addStringSelectMenuHandlers(Map)

getStringSelectMenuHandlers

@Nonnull
public Map<List<String>,StringSelectMenuHandler> getStringSelectMenuHandlers()

Gets all registered StringSelectMenuHandlers.

Returns:

An immutable Map which stores the id as the Key and the StringSelectMenuHandler as the value.

See Also:

• addStringSelectMenuHandlers(Map)

getEntitySelectMenuHandlers

@Nonnull
public Map<List<String>,EntitySelectMenuHandler> getEntitySelectMenuHandlers()

Gets all registered EntitySelectMenuHandlers.

Returns:

An immutable Map which stores the id as the Key and the EntitySelectMenuHandler as the values.

See Also:

• addEntitySelectMenuHandlers(Map)

addModalHandlers

public void addModalHandlers(Map<List<String>,ModalHandler> handlers)

Binds all ModalHandlers to their id.

 dih4jda.addModalHandlers(Map.of(
 	List.of("apple"), new AppleModalHandler(),
 	List.of("banana"), new BananaModalHandler()
 ));
 

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

Parameters:

handlers - All ModalHandler, as a immutable Map.

getModalHandlers

@Nonnull
public Map<List<String>,ModalHandler> getModalHandlers()

Gets all ModalHandlers.

Returns:

An immutable Map which stores the id as the Key and the ModalHandler as the Value.