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)

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 add Listener classes (that implements DIH4JDAEventListener).
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.
final IdMapping<ButtonHandler>[]	getButtonMappings()	Gets all ButtonHandlers.
DIH4JDAConfig	getConfig()
static RegistrationType	getDefaultRegistrationType()
final IdMapping<EntitySelectMenuHandler>[]	getEntitySelectMenuMappings()	Gets all registered EntitySelectMenuHandlers.
Set<DIH4JDAEventListener>	getEventListeners()
net.dv8tion.jda.api.JDA	getJDA()	Convenience method which replaces invalid @link {@link DIH4JDA#getConfig()#getJDA() }
final IdMapping<ModalHandler>[]	getModalMappings()	Gets all ModalHandlers.
final IdMapping<StringSelectMenuHandler>[]	getStringSelectMenuMappings()	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.
static void	setDefaultRegistrationType(RegistrationType type)	Sets the default RegistrationType for all Commands.

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

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(RegistrationType type)

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

Parameters:

type - The RegistrationType.

getDefaultRegistrationType

public static RegistrationType getDefaultRegistrationType()

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

getEventListeners

@Nonnull
public Set<DIH4JDAEventListener> getEventListeners()

Returns:

A set of all Listener classes.

See Also:

• addEventListener(Object...)

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.

addButtonMappings

@SafeVarargs
public final void addButtonMappings(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.

getButtonMappings

@Nonnull
public final IdMapping<ButtonHandler>[] getButtonMappings()

Gets all ButtonHandlers.

Returns:

An IdMapping array which contains the never-null ids and handlers.

addStringSelectMenuMappings

@SafeVarargs
public final void addStringSelectMenuMappings(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[])

getStringSelectMenuMappings

@Nonnull
public final IdMapping<StringSelectMenuHandler>[] getStringSelectMenuMappings()

Gets all registered StringSelectMenuHandlers.

Returns:

An IdMapping array which contains the never-null ids and handlers.

See Also:

• addStringSelectMenuMappings(IdMapping[])

addEntitySelectMenuMappings

@SafeVarargs
public final void addEntitySelectMenuMappings(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[])

getEntitySelectMenuMappings

@Nonnull
public final IdMapping<EntitySelectMenuHandler>[] getEntitySelectMenuMappings()

Gets all registered EntitySelectMenuHandlers.

Returns:

An IdMapping array which contains the never-null ids and handlers.

See Also:

• addEntitySelectMenuMappings(IdMapping[])

addModalMappings

@SafeVarargs
public final void addModalMappings(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.

getModalMappings

@Nonnull
public final IdMapping<ModalHandler>[] getModalMappings()

Gets all ModalHandlers.

Returns:

An IdMapping array which contains the never-null ids and handlers.