Package com.github.twitch4j.common.util

Class ChatReply

java.lang.Object

com.github.twitch4j.common.util.ChatReply

public final class ChatReply
extends Object

Meta-info regarding the parent message being replied to.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REPLY_MSG_ID_TAG_NAME

Constructor Summary

Constructors

Constructor	Description
ChatReply(@NonNull String messageId, String messageBody, String userId, String userLogin, String displayName, String threadMessageId, String threadUserLogin, String threadUserName)	Creates a new ChatReply instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDisplayName()	The display name of the sender of the direct parent message.
String	getMessageBody()	The text of the direct parent message.
@NonNull String	getMessageId()	An ID that uniquely identifies the direct parent message that this message is replying to.
String	getThreadMessageId()	An ID that uniquely identifies the top-level parent message of the reply thread that this message is replying to.
String	getThreadUserLogin()	The login name of the sender of the top-level parent message.
String	getThreadUserName()	The display name of the sender of the top-level parent message.
String	getUserId()	An ID that identifies the sender of the direct parent message.
String	getUserLogin()	The login name of the sender of the direct parent message.
int	hashCode()
static ChatReply	parse(Map<String,CharSequence> tags)	Attempts to parse a ChatReply instance from chat tags.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

REPLY_MSG_ID_TAG_NAME

public static final String REPLY_MSG_ID_TAG_NAME

See Also:

• Constant Field Values

Constructor Details

ChatReply

public ChatReply(@NonNull
 @NonNull String messageId,
 String messageBody,
 String userId,
 String userLogin,
 String displayName,
 String threadMessageId,
 String threadUserLogin,
 String threadUserName)

Creates a new ChatReply instance.

Parameters:

messageId - An ID that uniquely identifies the direct parent message that this message is replying to.

messageBody - The text of the direct parent message.

userId - An ID that identifies the sender of the direct parent message.

userLogin - The login name of the sender of the direct parent message.

displayName - The display name of the sender of the direct parent message.

threadMessageId - An ID that uniquely identifies the top-level parent message of the reply thread that this message is replying to.

threadUserLogin - The login name of the sender of the top-level parent message.

threadUserName - The display name of the sender of the top-level parent message.

Method Details

parse

@Internal
public static ChatReply parse(Map<String,CharSequence> tags)

Attempts to parse a ChatReply instance from chat tags.

Parameters:

tags - the message tags associated with a reply.

Returns:

the parsed ChatReply, or null if unsuccessful

getMessageId

@NonNull
public @NonNull String getMessageId()

An ID that uniquely identifies the direct parent message that this message is replying to.

getMessageBody

public String getMessageBody()

The text of the direct parent message.

getUserId

public String getUserId()

An ID that identifies the sender of the direct parent message.

getUserLogin

public String getUserLogin()

The login name of the sender of the direct parent message.

getDisplayName

public String getDisplayName()

The display name of the sender of the direct parent message.

getThreadMessageId

public String getThreadMessageId()

An ID that uniquely identifies the top-level parent message of the reply thread that this message is replying to.

getThreadUserLogin

public String getThreadUserLogin()

The login name of the sender of the top-level parent message.

getThreadUserName

public String getThreadUserName()

The display name of the sender of the top-level parent message.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object