Package com.github.twitch4j.chat.util

Class ChatCrowdChant

java.lang.Object

com.github.twitch4j.chat.util.ChatCrowdChant

@Unofficial
@Deprecated
public final class ChatCrowdChant
extends Object

Deprecated.

Will be disabled on 2022-02-02

Information regarding a Crowd Chant participation or initiation.

See Also:

• Related Uservoice

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANT_MSG_ID_TAG_NAME	Deprecated.

Constructor Summary

Constructors

Constructor	Description
ChatCrowdChant(String messageId, String text, boolean initiator, String channelName)	Deprecated. Creates a new ChatCrowdChant instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Deprecated.
String	getMessageId()	Deprecated. The id for the parent message in the Crowd Chant.
String	getText()	Deprecated. The text being chanted.
int	hashCode()	Deprecated.
boolean	isInitiator()	Deprecated. Whether this message initiated a crowd chat.
static @Nullable ChatCrowdChant	parse(IRCMessageEvent event)	Deprecated. Attempts to parse the ChatCrowdChant information from a chat event.
void	participate(ITwitchChat chat)	Deprecated. Will be disabled on 2022-02-02
String	toString()	Deprecated.

Methods inherited from class java.lang.Object

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

Field Details

CHANT_MSG_ID_TAG_NAME

public static final String CHANT_MSG_ID_TAG_NAME

Deprecated.

See Also:

• Constant Field Values

Constructor Details

ChatCrowdChant

public ChatCrowdChant(String messageId,
 String text,
 boolean initiator,
 String channelName)

Deprecated.

Creates a new ChatCrowdChant instance.

Parameters:

messageId - The id for the parent message in the Crowd Chant.

text - The text being chanted.

initiator - Whether this message initiated a crowd chat. When false, the message is simply participating in the chant, rather than initiating.

channelName - The name of the channel where the Crowd Chant took place.

Method Details

participate

@Unofficial
@Deprecated
public void participate(ITwitchChat chat)

Deprecated.

Will be disabled on 2022-02-02

Sends the same message in the same channel to participate in the Crowd Chant, with the proper chat tag.

Parameters:

chat - an authenticated TwitchChat instance.

parse

@Nullable
public static @Nullable ChatCrowdChant parse(IRCMessageEvent event)

Deprecated.

Attempts to parse the ChatCrowdChant information from a chat event.

Parameters:

event - the raw IRCMessageEvent.

Returns:

ChatCrowdChant (or null if parsing was unsuccessful)

getMessageId

public String getMessageId()

Deprecated.

The id for the parent message in the Crowd Chant.

getText

public String getText()

Deprecated.

The text being chanted.

isInitiator

public boolean isInitiator()

Deprecated.

Whether this message initiated a crowd chat. When false, the message is simply participating in the chant, rather than initiating.

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object