discord-entities

Discord Entities for SqlSauce

A package of Discord related entities and classes for SqlSauce.

Current main purpose: Provide a framework to save settings for users / guilds combined with keeping some data on them, like names or avatar urls etc.

Adding SqlSauce Discord Entities to your project

Make sure to include the core package SqlSauce in your project. This module can then be added through this additional dependency:

Gradle build.gradle

    dependencies {
        compile group: 'space.npstr.SqlSauce', name: 'discord-entities', version: '0.2.3'
    }

Maven pom.xml

    <dependency>
        <groupId>space.npstr.SqlSauce</groupId>
        <artifactId>discord-entities</artifactId>
        <version>0.2.3</version>
    </dependency>

Usage

Make sure to read the documentation of SqlSauce as this package relies on many of its concepts.

Example class:

   @Entity(name = "MyGuildSettings")
   @Table(name = "guild_settings")
   public class MyGuildSettings extends DiscordGuild<MyGuildSettings> {
   
       @Column(name = "prefix")
       private String prefix = "!";
   
       //for JPA / SaucedEntity
       public MyGuildSettings() {
       }
   
       public static String getPrefix(long guildId) throws DatabaseException {
           return load(guildId, MyGuildSettings.class).getPrefix();
       }
   
       public static MyGuildSettings setPrefix(long guildId, String prefix) throws DatabaseException {
           return load(guildId, MyGuildSettings.class)
                   .setPrefix(prefix)
                   .save();
       }
   
       public String getPrefix() {
           return prefix;
       }
   
       public MyGuildSettings setPrefix(String prefix) {
           this.prefix = prefix;
           return this;
       }
   }

Setting the entity up to be automatically cached with JDA:

        JDABuilder jdaBuilder = new JDABuilder(AccountType.BOT)
                [...]
                .addEventListener(new GuildCachingListener<>(MyGuildSettings.class))
                [...];

Changelog

Omitted versions mean there were no changes to this module. It is still recommended to use the latest version as shown on the core module readme.

v0.4.0

• CacheableGuilds and CacheableUsers allow more generic CachingListeners

v0.2.4

• Support AsyncDatabaseWrapper contract in the provided CachingListener implementations

v0.2.3

• Expose the cache pump of CachingListeners, good for instrumenting.

v0.2.0

• Delete deprecated code (mostly static SaucedEntity abuse)

v0.1.1 through v0.1.5

• Deprecate static abuse of the entities

v0.1.0

• Replaced deprecated events in the UserMemberCachingListener

v0.0.13

• Add better named id getters for base discord entities

v0.0.8

• Add missing package-info.java files

v0.0.7

• Bintray publishing fix

v0.0.6

• base user and base guild entities
• Add package wide nullability annotations

v0.0.5

• testing and publishing to Bintray

v0.0.4

• Composite ids
• Fix guilds not being cached on join / leave

v0.0.3

• Caching happens on a worker thread now instead of the main JDA thread
• Some constants are now publicly accessible
• module was renamed 'sqlsauce-discord-entities' -> 'discord-entities'
• default values for non-null columns added, this should help with upgrading
• mass sync / cache methods (useful after downtime / restarts); performance isn't good yet, especially when using it for users
• Users of a guild are cached when the bot joins a guild
• Guilds are cached on reconnect
• More complete attempt at looking up a user name

v0.0.2

• Initial release with Proof of Concept for Guilds and a JDA listener

TODOs

• static getters should not load the entity and instead look up the field by a direct query
• indices?

Dependencies

• Java Discord API
  • GitHub
  • The Apache Software License, Version 2.0
  • JCenter