com.github.twitch4j.chat.events.channel.ChannelMessageEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twitch4j-chat Show documentation
Chat dependency
The newest version!
package com.github.twitch4j.chat.events.channel;

import com.github.twitch4j.chat.events.AbstractChannelMessageEvent;
import com.github.twitch4j.chat.util.ChatCrowdChant;
import com.github.twitch4j.common.annotation.Unofficial;
import com.github.twitch4j.common.enums.HypeChatLevel;
import com.github.twitch4j.common.events.domain.EventChannel;
import com.github.twitch4j.common.events.domain.EventUser;
import com.github.twitch4j.common.util.ChatReply;
import com.github.twitch4j.common.util.DonationAmount;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
import lombok.Value;
import org.apache.commons.lang3.StringUtils;
import org.jetbrains.annotations.Nullable;

import java.util.Map;
import java.util.Optional;

/**
 * This event gets called when a message is received in a channel.
 */
@Value
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
public class ChannelMessageEvent extends AbstractChannelMessageEvent {

    /**
     * Information regarding the parent message being replied to, if applicable.
     */
    @Nullable
    @Getter(lazy = true)
    ChatReply replyInfo = ChatReply.parse(getMessageEvent().getEscapedTags());

    /**
     * Information regarding any associated Crowd Chant for this message, if applicable.
     *
     * @deprecated Will be disabled on 2022-02-02
     */
    @Nullable
    @Unofficial
    @Getter(lazy = true)
    @Deprecated
    ChatCrowdChant chantInfo = ChatCrowdChant.parse(getMessageEvent());

    /**
     * Event Constructor
     *
     * @param channel      The channel that this event originates from.
     * @param messageEvent The raw message event
     * @param user         The user who triggered the event.
     * @param message      The plain text of the message.
     */
    public ChannelMessageEvent(
        EventChannel channel,
        IRCMessageEvent messageEvent,
        EventUser user,
        String message
    ) {
        super(channel, messageEvent, user, message);
    }

    /**
     * @return whether "Highlight My Message" was redeemed for this event
     */
    @Unofficial
    public boolean isHighlightedMessage() {
        return StringUtils.equals("highlighted-message", getMessageEvent().getRawTag("msg-id"));
    }

    /**
     * @return whether "Send a Message in Sub-Only Mode" was redeemed for this event
     */
    @Unofficial
    public boolean isSkipSubsModeMessage() {
        return StringUtils.equals("skip-subs-mode-message", getMessageEvent().getRawTag("msg-id"));
    }

    /**
     * @return the id for the custom reward that was redeemed with this associated message, in an optional wrapper
     */
    @Unofficial
    public Optional getCustomRewardId() {
        return getMessageEvent().getTagValue("custom-reward-id");
    }

    /**
     * @return whether this is the user's first message in the channel.
     * @apiNote This method is marked as unofficial since this tag does not appear in the irc guide.
     * @see Official documentation
     */
    @Unofficial
    public boolean isDesignatedFirstMessage() {
        return StringUtils.equals("1", getMessageEvent().getRawTag("first-msg"));
    }

    /**
     * @return whether this message constitutes the user's designated introduction.
     * @apiNote This method is unofficial since the experiment is not officially documented in the irc guide.
     * @see Twitch Announcement
     */
    @Unofficial
    public boolean isUserIntroduction() {
        return StringUtils.equals("user-intro", getMessageEvent().getRawTag("msg-id"));
    }

    /**
     * @return whether the message is a "Gigantify an Emote" bits redemption
     * @apiNote This method is unofficial since the msg-id is not documented in the irc guide.
     * @see Twitch Announcement
     */
    @Unofficial
    public boolean hasGiganticEmote() {
        return StringUtils.equals("gigantified-emote-message", getMessageEvent().getRawTag("msg-id"));
    }

    /**
     * @return whether the message is a "Message Effects" bits redemption
     * @apiNote This method is unofficial since the msg-id is not documented in the irc guide.
     * @see Twitch Announcement
     */
    @Unofficial
    public boolean hasMessageEffects() {
        return StringUtils.equals("animated-message", getMessageEvent().getRawTag("msg-id"));
    }

    /**
     * @return returns the animation id associated with the "Message Effects" bits redemption. Possible values include "cosmic-abyss", "simmer", and "rainbow-eclipse".
     * @apiNote This method is unofficial since the tag is not documented in the irc guide.
     * @see Twitch Announcement
     */
    @Unofficial
    public Optional getAnimationId() {
        return getMessageEvent().getTagValue("animation-id");
    }

    /**
     * Hype Chat Contribution
     *
     * @return the payment information related to this hype chat, if applicable.
     * @see Twitch Announcement
     */
    public Optional getElevatedChatPayment() {
        final Map tags = getMessageEvent().getEscapedTags();

        CharSequence amount = tags.get("pinned-chat-paid-amount");
        if (amount == null) {
            amount = tags.get("pinned-chat-paid-canonical-amount");
        }

        return Optional.ofNullable(amount)
            .map(amt -> {
                try {
                    return Long.parseLong(amt.toString());
                } catch (Exception e) {
                    return null;
                }
            })
            .map(amt -> {
                String currency = tags.getOrDefault("pinned-chat-paid-currency", "USD").toString();
                String exponentStr = tags.getOrDefault("pinned-chat-paid-exponent", "2").toString();
                int exponent;
                try {
                    exponent = Integer.parseInt(exponentStr);
                } catch (Exception e) {
                    return null;
                }
                return new DonationAmount(amt, exponent, currency);
            });
    }

    /**
     * @return the {@link HypeChatLevel} associated with the hype chat contribution.
     * @see #getElevatedChatPayment()
     */
    public Optional getHypeChatLevel() {
        return getMessageEvent()
            .getTagValue("pinned-chat-paid-level")
            .map(HypeChatLevel.MAPPINGS::get);
    }

}