Discord
Invite
The discord bot is a fully functional, example implementation of the DocDex API. The bot allows you to retrieve javadocs in a server, in a constructed embed.
Types
Methods
Fields
The bot is designed to be ran as a public bot, meaning it's meant to be ran on multiple servers, and that's exactly how the public instance is ran. Due to this, lots of key aspects of the bot are configurable in discord itself, via commands, for the benefit of the server owner/administrators. The things that are currently configurable are:
- Bot prefix
- Default javadoc
- Searching algorithm
- Which roles can access these configuration commands
- Which commands can be ran in which channels (whitelists/blacklists)
These commands are grouped into "Permission Commands", as by default they're only accessible to users with the ADMINISTRATOR permission in discord. There are also obviously the search commands, and a javadoc list command.
You may notice that on a vast majority of the command results, a little trash can emote is added. This can be used by the original command sender to delete the bot's message, along with their original command. The bot deletes both, as if it only deleted its own message, people would naturally assume the bot is broken. This semantic of the trash can only being able to be used by the original sender, applies to all reactions from the bot, such as paginations. Any reactions added by any user will be removed, and if the command sender is the one doing the reacting, the bot will respond by changing the page.