Class EmbedGenerator

java.lang.Object
org.deltava.discord.EmbedGenerator
class EmbedGenerator extends Object
A utility class to generate Discord responses.
Since:
11.1
Version:
12.4
Author:
Luke

  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createError(String userName, String actionName, Exception ex)
    Generates an embedded error message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createInsufficientAccess(org.javacord.api.event.message.MessageCreateEvent e)
    Generates an insufficient access message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createNick(String userName, Pilot p, Collection<org.javacord.api.entity.permission.Role> roles, String nickName)
    Generates a nickname message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createNicknameError(String userName, Pilot p, Collection<org.javacord.api.entity.permission.Role> roles)
    Generates an embedded nickname error message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createPIREP(FlightReport fr, Pilot p)
    Generates a Flight Report submission message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createStatus(org.javacord.api.event.message.MessageCreateEvent e, Pilot p, Collection<org.javacord.api.entity.permission.Role> roles)
    Creates a registration status message, to provide feedback to the Pilot about registration status.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createWarning(String author, String channel, String msg)
    Creates a content warning message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    createWarning(org.javacord.api.event.message.MessageCreateEvent e, Collection<String> keywords)
    Generates an keyword warning message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    register(long id)
    Generates a registration message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    showKeys(boolean isSafe, Collection<String> keywords)
    Returns a keyword list message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    welcome(org.javacord.api.event.message.MessageCreateEvent e)
    Returns a welcome message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    wordAdded(boolean isSafe, String key, String user)
    Returns a keyword removed message.
    (package private) static org.javacord.api.entity.message.embed.EmbedBuilder
    wordDeleted(boolean isSafe, String key, String user)
    Returns a keyword added message.

    Methods inherited from class Object

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

  • Method Details

    • createError

      static org.javacord.api.entity.message.embed.EmbedBuilder createError(String userName, String actionName, Exception ex)
      Generates an embedded error message.
      Parameters:
      userName - the User Name
      actionName - the action being performed
      ex - the Exception
      Returns:
      an EmbedBuilder

    • createWarning

      static org.javacord.api.entity.message.embed.EmbedBuilder createWarning(org.javacord.api.event.message.MessageCreateEvent e, Collection<String> keywords)
      Generates an keyword warning message.
      Parameters:
      e - the MessageCreateEvent
      keywords - a Collection of keywords
      Returns:
      an EmbedBuilder

    • createInsufficientAccess

      static org.javacord.api.entity.message.embed.EmbedBuilder createInsufficientAccess(org.javacord.api.event.message.MessageCreateEvent e)
      Generates an insufficient access message.
      Parameters:
      e - the MessageCreateEvent
      Returns:
      an EmbedBuilder

    • createNick

      static org.javacord.api.entity.message.embed.EmbedBuilder createNick(String userName, Pilot p, Collection<org.javacord.api.entity.permission.Role> roles, String nickName)
      Generates a nickname message.
      Parameters:
      userName - the Dicsord User name
      p - the Pilot
      roles - the Discord security Roles
      nickName - the nickname
      Returns:
      an EmbedBuilder

    • createStatus

      static org.javacord.api.entity.message.embed.EmbedBuilder createStatus(org.javacord.api.event.message.MessageCreateEvent e, Pilot p, Collection<org.javacord.api.entity.permission.Role> roles)
      Creates a registration status message, to provide feedback to the Pilot about registration status.
      Parameters:
      e - the MessageCreateEvent
      p - the Pilot
      roles - the Discord security Roles
      Returns:
      an EmbedBuilder

    • createNicknameError

      static org.javacord.api.entity.message.embed.EmbedBuilder createNicknameError(String userName, Pilot p, Collection<org.javacord.api.entity.permission.Role> roles)
      Generates an embedded nickname error message.
      Parameters:
      userName - the Discord User name
      p - the Pilot
      roles - the Discord security Roles
      Returns:
      an EmbedBuilder

    • createPIREP

      static org.javacord.api.entity.message.embed.EmbedBuilder createPIREP(FlightReport fr, Pilot p)
      Generates a Flight Report submission message.
      Parameters:
      fr - the FlightReport
      p - the Pilot
      Returns:
      an EmbedBuilder

    • register

      static org.javacord.api.entity.message.embed.EmbedBuilder register(long id)
      Generates a registration message.
      Parameters:
      id - the Discord User UUID
      Returns:
      an EmbedBuilder

    • welcome

      static org.javacord.api.entity.message.embed.EmbedBuilder welcome(org.javacord.api.event.message.MessageCreateEvent e)
      Returns a welcome message.
      Parameters:
      e - the MessageCreateEvent
      Returns:
      an EmbedBuilder

    • wordDeleted

      static org.javacord.api.entity.message.embed.EmbedBuilder wordDeleted(boolean isSafe, String key, String user)
      Returns a keyword added message.
      Parameters:
      isSafe - TRUE if a safe word, otherwise FALSE
      key - the keyword
      user - the User adding the keyword
      Returns:
      an EmbedBuilder

    • wordAdded

      static org.javacord.api.entity.message.embed.EmbedBuilder wordAdded(boolean isSafe, String key, String user)
      Returns a keyword removed message.
      Parameters:
      isSafe - TRUE if a safe word, otherwise FALSE
      key - the keyword
      user - the User removing the keyword
      Returns:
      an EmbedBuilder

    • showKeys

      static org.javacord.api.entity.message.embed.EmbedBuilder showKeys(boolean isSafe, Collection<String> keywords)
      Returns a keyword list message.
      Parameters:
      isSafe - TRUE if a safe word list, otherwise FALSE
      keywords - a Collection of keywords
      Returns:
      an EmbedBuilder

    • createWarning

      static org.javacord.api.entity.message.embed.EmbedBuilder createWarning(String author, String channel, String msg)
      Creates a content warning message.
      Parameters:
      author - the Author name
      channel - the Channel name
      msg - the warning message
      Returns:
      an EmbedBuilder