com.github.twitch4j.helix.domain.Cheermote Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twitch4j-helix Show documentation
Helix API dependency
There is a newer version: 1.23.0
package com.github.twitch4j.helix.domain;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.github.twitch4j.util.EnumUtil;
import lombok.AccessLevel;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.Setter;

import java.time.Instant;
import java.util.List;
import java.util.Map;

@Data
@Setter(AccessLevel.PRIVATE)
@NoArgsConstructor
public class Cheermote {
    /**
     * The name of the Cheermote (e.g., "Cheer", "PogChamp", "Kappa")
     */
    private String prefix;

    /**
     * Cheermotes with their metadata
     */
    private List tiers;

    /**
     * The emote type
     */
    private Type type;

    /**
     * Order of the emotes as shown in the bits card, in ascending order
     */
    private Integer order;

    /**
     * The date when this Cheermote was last updated
     */
    private Instant lastUpdated;

    /**
     * Indicates whether or not this emote provides a charity contribution match
     */
    private Boolean isCharitable;

    public enum Type {
        GLOBAL_FIRST_PARTY,
        GLOBAL_THIRD_PARTY,
        CHANNEL_CUSTOM,
        DISPLAY_ONLY,
        SPONSORED;

        @Override
        public String toString() {
            return this.name().toLowerCase();
        }

        private static final Map MAPPINGS = EnumUtil.buildMapping(values());

        @Deprecated
        public static Type fromString(String type) {
            return MAPPINGS.get(type);
        }
    }

    @Data
    @Setter(AccessLevel.PRIVATE)
    @NoArgsConstructor
    public static class Tier {
        /**
         * ID of the emote tier. Possible tiers are: 1, 100, 500, 1000, 5000, 10k, or 100k
         */
        @NonNull
        private String id;

        /**
         * Minimum number of bits needed to be used to hit the given tier of emote
         */
        private Long minBits;

        /**
         * Hex code for the color associated with the bits of that tier
         */
        private String color;

        /**
         * Structure containing both animated and static image sets, sorted by light and dark
         */
        private ThemedImages images;

        /**
         * Whether or not emote information is accessible to users
         */
        private Boolean canCheer;

        /**
         * Whether or not the emote is hidden from the bits card
         */
        private Boolean showInBitsCard;
    }

    @Data
    @Setter(AccessLevel.PRIVATE)
    public static class ThemedImages {
        private ImageSet dark;
        private ImageSet light;
    }

    @Data
    @Setter(AccessLevel.PRIVATE)
    public static class ImageSet {
        @JsonProperty("animated")
        private SizedImages animatedImages;

        @JsonProperty("static")
        private SizedImages staticImages;
    }

    @Data
    @Setter(AccessLevel.PRIVATE)
    public static class SizedImages {
        /**
         * Image at 1.0x
         */
        @JsonProperty("1")
        private String size10;

        /**
         * Image at 1.5x
         */
        @JsonProperty("1.5")
        private String size15;

        /**
         * Image at 2.0x
         */
        @JsonProperty("2")
        private String size20;

        /**
         * Image at 3.0x
         */
        @JsonProperty("3")
        private String size30;

        /**
         * Image at 4.0x
         */
        @JsonProperty("4")
        private String size40;
    }
}