Package com.github.twitch4j.helix.domain

Class Emote

java.lang.Object

com.github.twitch4j.helix.domain.Emote

public class Emote
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Emote.Format
static class	Emote.Images
static enum	Emote.Scale
static enum	Emote.Theme
static enum	Emote.Type

Constructor Summary

Constructors

Constructor	Description
Emote()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable String	getEmoteSetId()	ID of the emote set the emote belongs to.
@Nullable String	getEmoteType()	The type of emote.
List<Emote.Format>	getFormat()	The formats that the emote is available in.
String	getId()	ID of the emote.
@Nullable Emote.Images	getImages()	The image URLs for the emote.
String	getName()	Name of the emote a viewer types into Twitch chat for the image to appear.
@Nullable String	getOwnerId()	User ID of the broadcaster who owns the emote.
@NonNull Emote.Type	getParsedEmoteType()	Attempts to parse this emoteType to a known Emote.Type.
List<Emote.Scale>	getScale()	The sizes that the emote is available in.
List<Emote.Theme>	getThemeMode()	The background themes that the emote is available in.
@Nullable SubscriptionPlan	getTier()	The subscriber tier at which the emote is unlocked.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Emote

public Emote()

Method Details

getParsedEmoteType

@NonNull
public @NonNull Emote.Type getParsedEmoteType()

Attempts to parse this emoteType to a known Emote.Type.

Returns:

the parsed Emote.Type.

See Also:

• getEmoteType()

getId

public String getId()

ID of the emote.

getName

public String getName()

Name of the emote a viewer types into Twitch chat for the image to appear.

getImages

@Nullable
public @Nullable Emote.Images getImages()

The image URLs for the emote.

This is not present for TwitchHelix.getUserEmotes(String, String, String, String); use EmoteList.getPopulatedTemplateUrl(String, Format, Theme, Scale).

getEmoteSetId

@Nullable
public @Nullable String getEmoteSetId()

ID of the emote set the emote belongs to.

This is not present for TwitchHelix.getGlobalEmotes(String). This is present for TwitchHelix.getChannelEmotes(String, String), TwitchHelix.getEmoteSets(String, Collection), and TwitchHelix.getUserEmotes(String, String, String, String).

getFormat

public List<Emote.Format> getFormat()

The formats that the emote is available in.

For example, if the emote is available only as a static PNG, the collection contains only Emote.Format.STATIC. But if it’s available as a static PNG and an animated GIF, the collection contains both Emote.Format.STATIC and Emote.Format.ANIMATED.

getScale

public List<Emote.Scale> getScale()

The sizes that the emote is available in.

getThemeMode

public List<Emote.Theme> getThemeMode()

The background themes that the emote is available in.

getOwnerId

@Nullable
public @Nullable String getOwnerId()

User ID of the broadcaster who owns the emote.

This is only present for TwitchHelix.getEmoteSets(String, Collection) and TwitchHelix.getUserEmotes(String, String, String, String).

getEmoteType

@Nullable
public @Nullable String getEmoteType()

The type of emote.

This is only present for TwitchHelix.getChannelEmotes(String, String) TwitchHelix.getEmoteSets(String, Collection), and TwitchHelix.getUserEmotes(String, String, String, String).

getTier

@Nullable
public @Nullable SubscriptionPlan getTier()

The subscriber tier at which the emote is unlocked.

This is only present when getEmoteType() equals Emote.Type.SUBSCRIPTIONS. Also, this can only be present when using TwitchHelix.getChannelEmotes(String, String).

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object