Package com.gmt2001.twitch.tmi

Class TMIMessage

java.lang.Object
com.gmt2001.twitch.tmi.TMIMessage
public final class TMIMessage extends Object
An IRCv3 formatted message from TMI
Author:
gmt2001

  • Method Details

    • messageType

      public TMIMessage.TMIMessageType messageType()
      Returns:
      The message type

    • tags

      public Map<String,String> tags()
      Returns:
      The IRCv3 tags. Badges, emotes, and emote-sets are still in raw form in this Map

    • badges

      public Map<String,String> badges()
      Returns:
      The badges and badge-info components of the IRCv3 tags

    • emotes

      public Map<String,List<TMIMessage.EmoteLocation>> emotes()
      Returns:
      The emotes component of the IRCv3 tags, parsed into emoteId: List<TMIMessage.EmoteLocation> pairs

    • emoteSets

      public List<String> emoteSets()
      Returns:
      The emote-sets component of the IRCv3 tags

    • nick

      public String nick()
      Returns:
      The nick that sent the message, if present

    • host

      public String host()
      Returns:
      The host that sent the message, if present

    • command

      public String command()
      Returns:
      The IRC command received

    • channel

      public String channel()
      Returns:
      The channel the command was received in, if present

    • parameters

      public String parameters()
      Returns:
      The parameters of the command, if present