org.kitteh.irc.client.library.element

Interface MessageTag

All Known Subinterfaces:

MessageTag.Label, MessageTag.MsgId, MessageTag.Time, MessageTag.Typing

All Known Implementing Classes:

Badges, BanDuration, BanReason, Bits, BroadcasterLang, Color, DefaultMessageTagLabel, DefaultMessageTagMsgId, DefaultMessageTagTime, DefaultMessageTagTyping, DisplayName, Emotes, EmoteSets, Id, Login, MessageTagManager.DefaultMessageTag, Mod, MsgId, MsgParamCumulativeMonths, MsgParamMonths, MsgParamSubPlan, MsgParamSubPlanName, R9k, RoomId, Slow, Subscriber, SubsOnly, SystemMsg, Turbo, User, UserId, UserType

public interface MessageTag

Reflects a message tag.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageTag.Label Represents the `label` tag as specified by the labeled responses spec.
static interface	MessageTag.MsgId Represents the `msgid` tag as specified by the Message IDs spec.
static interface	MessageTag.Time Represents the 'time' tag as specified by the 'server-time' extension.
static interface	MessageTag.Typing Represents the `typing` client tag as specified here: https://ircv3.net/specs/client-tags/typing#format

Method Summary

Modifier and Type	Method and Description
default @NonNull String	getAsString() Gets the tag in the String format sent over the IRC protocol.
default @NonNull Optional<String>	getEscapedValue() Gets the escaped value of the tag.
@NonNull String	getName() Gets the name of the tag.
@NonNull Optional<String>	getValue() Gets the unescaped, but otherwise unprocessed, value of the tag.
default boolean	isClientOnly() Gets if this message tag is a client-only tag.

Method Detail

getName

@NonNull String getName()

Gets the name of the tag.

Returns:

tag name

getValue

@NonNull Optional<String> getValue()

Gets the unescaped, but otherwise unprocessed, value of the tag.

Returns:

tag value if set

getEscapedValue

default @NonNull Optional<String> getEscapedValue()

Gets the escaped value of the tag.

Returns:

escaped tag value if set

isClientOnly

default boolean isClientOnly()

Gets if this message tag is a client-only tag.

Returns:

true if the tag name starts with a + character

getAsString

default @NonNull String getAsString()

Gets the tag in the String format sent over the IRC protocol.

Returns:

tag in String form