com.github.twitch4j.pubsub.domain.ChannelBitsData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of twitch4j-pubsub Show documentation

PubSub API dependency

The newest version!

package com.github.twitch4j.pubsub.domain;

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
import lombok.Setter;
import lombok.experimental.Accessors;
import org.jetbrains.annotations.Nullable;

import java.time.Instant;

@Data
@Setter(onMethod_ = { @Deprecated })
public class ChannelBitsData {

    /**
     * The id for the user that cheered
     */
    @Nullable
    private String userId;

    /**
     * The login name for the user that cheered
     */
    @Nullable
    private String userName;

    /**
     * The id for the channel where the bits were used
     */
    private String channelId;

    /**
     * The login name of the channel where the bits were used
     */
    private String channelName;

    /**
     * RFC 3339 timestamp of when the bits were used
     */
    private String time;

    /**
     * The message sent with the cheer
     */
    private String chatMessage;

    /**
     * The number of bits used
     */
    private Integer bitsUsed;

    /**
     * A cumulative total of all bits this user has cheered in this channel
     */
    private Integer totalBitsUsed;

    /**
     * The event type for this bits usage (e.g. "cheer")
     */
    private String context;

    /**
     * If a non-anonymous user reached a new badge level with this cheer,
     * this object will contain more information regarding the new level
     */
    private BadgeEntitlement badgeEntitlement;

    /**
     * Whether or not the event was anonymous
     */
    @Accessors(fluent = true)
    @JsonProperty("is_anonymous")
    private Boolean isAnonymous = false;

    /**
     * @return the parsed time in an Instant wrapper
     */
    public Instant getTimeAsInstant() {
        return Instant.parse(this.time);
    }

    @Data
    @Setter(onMethod_ = { @Deprecated })
    public static class BadgeEntitlement {
        /**
         * The number of bits associated with the previous badge
         */
        private int previousVersion;

        /**
         * The number of bits associated with the new badge
         */
        private int newVersion;
    }

}