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, DiscordUserAudioChannelEvent
public abstract class DiscordEvent extends Event

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    DiscordEvent()
    Class constructor for this event.
    protected
    DiscordEvent(discord4j.core.object.entity.User user)
    Class constructor for this event.
    protected
    DiscordEvent(discord4j.core.object.entity.User user, discord4j.core.object.entity.channel.AudioChannel audiochannel)
    Class constructor for this event.
    protected
    DiscordEvent(discord4j.core.object.entity.User user, discord4j.core.object.entity.channel.Channel channel)
    Class constructor for this event.
    protected
    DiscordEvent(discord4j.core.object.entity.User user, discord4j.core.object.entity.channel.Channel channel, discord4j.core.object.entity.Message message)
    Class constructor for this event.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getChannel()
    Method that returns the channel name.
    String
    getChannelId()
    Method that returns the channel ID.
    discord4j.core.object.entity.channel.Channel
    getDiscordAudioChannel()
    Method that returns the channel's object for Discord4J.
    discord4j.core.object.entity.channel.Channel
    getDiscordChannel()
    Method that returns the channel's object for Discord4J.
    discord4j.core.object.entity.Message
    getDiscordMessage()
    Method that returns the message object
    discord4j.core.object.entity.User
    getDiscordUser()
    Method that returns the user's object for Discord4J.
    String
    getDiscriminator()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Discriminators have been removed from Discord
    String
    getMention()
    Method that returns the mention string for this user.
    String
    getMessage()
    Method that gets the raw message.
    String
    getSender()
    Method that returns the sender of the event.
    String
    getSenderId()
    Method that returns the user's ID.
    String
    getUsername()
    Method that returns the username of the event.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DiscordEvent

      protected DiscordEvent()
      Class constructor for this event.

    • DiscordEvent

      protected DiscordEvent(discord4j.core.object.entity.User user)
      Class constructor for this event.
      Parameters:
      user -

    • DiscordEvent

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

    • DiscordEvent

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

    • DiscordEvent

      protected DiscordEvent(discord4j.core.object.entity.User user, discord4j.core.object.entity.channel.AudioChannel audiochannel)
      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 discord4j.core.object.entity.User getDiscordUser()
      Method that returns the user's object for Discord4J.
      Returns:

    • getDiscordChannel

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

    • getDiscordAudioChannel

      public discord4j.core.object.entity.channel.Channel getDiscordAudioChannel()
      Method that returns the channel's object for Discord4J.
      Returns:

    • getDiscordMessage

      public discord4j.core.object.entity.Message getDiscordMessage()
      Method that returns the message object
      Returns: