Package tv.phantombot.event.discord

Class DiscordEvent

java.lang.Object
tv.phantombot.event.Event
tv.phantombot.event.discord.DiscordEvent
Direct Known Subclasses:
DiscordChannelEvent, DiscordReactionEvent, DiscordRoleEvent, DiscordUserVoiceChannelEvent
public abstract class DiscordEvent extends Event

  • Constructor Details

    • DiscordEvent

      protected DiscordEvent()
      Class constructor for this event.

    • DiscordEvent

      protected DiscordEvent(User user)
      Class constructor for this event.
      Parameters:
      user -

    • DiscordEvent

      protected DiscordEvent(User user, Channel channel)
      Class constructor for this event.
      Parameters:
      user -
      channel -

    • DiscordEvent

      protected DiscordEvent(User user, Channel channel, Message message)
      Class constructor for this event.
      Parameters:
      user -
      channel -
      message -

    • DiscordEvent

      protected DiscordEvent(User user, VoiceChannel voicechannel)
      Class constructor for this event.
      Parameters:
      user -
      channel -

  • Method Details

    • getSender

      public String getSender()
      Method that returns the sender of the event.
      Returns:
      getUsername() converted to lowercase

    • getUsername

      public String getUsername()
      Method that returns the username of the event.
      Returns:

    • getMention

      public String getMention()
      Method that returns the mention string for this user.
      Returns:

    • getChannel

      public String getChannel()
      Method that returns the channel name.
      Returns:

    • getMessage

      public String getMessage()
      Method that gets the raw message.
      Returns:

    • getChannelId

      public String getChannelId()
      Method that returns the channel ID.
      Returns:

    • getDiscriminator

      @Deprecated(since="3.10.0.0", forRemoval=true) public String getDiscriminator()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Discriminators have been removed from Discord
      Method that returns the user's discriminator.
      Returns:
      0

    • getSenderId

      public String getSenderId()
      Method that returns the user's ID.
      Returns:

    • getDiscordUser

      public User getDiscordUser()
      Method that returns the user's object for Discord4J.
      Returns:

    • getDiscordChannel

      public Channel getDiscordChannel()
      Method that returns the channel's object for Discord4J.
      Returns:

    • getDiscordVoiceChannel

      public Channel getDiscordVoiceChannel()
      Method that returns the channel's object for Discord4J.
      Returns:

    • getDiscordMessage

      public Message getDiscordMessage()
      Method that returns the message object
      Returns: