Package net.dv8tion.jda.api.entities.sticker

Interface Sticker

All Superinterfaces:

ISnowflake, StickerSnowflake

All Known Subinterfaces:

GuildSticker, RichSticker, StandardSticker, StickerItem, StickerUnion

public interface Sticker
extends StickerSnowflake

Abstract representation of all sticker types.

This is specialized in StandardSticker and GuildSticker.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Sticker.StickerFormat	The various formats used for stickers and the respective file extensions.
static enum	Sticker.Type	The specific types of stickers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON_URL	Template for getIconUrl()

Method Summary

Modifier and Type	Method	Description
static StickerSnowflake	fromId(long id)	Creates a sticker snowflake instance which only wraps an ID.
static StickerSnowflake	fromId(String id)	Creates a sticker snowflake instance which only wraps an ID.
Sticker.StickerFormat	getFormatType()	The format type of this sticker, used for getIconUrl().
default ImageProxy	getIcon()	Returns an ImageProxy for this sticker's image.
default String	getIconUrl()	The url of the sticker image.
String	getName()	The name of the sticker.

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Field Details

ICON_URL

static final String ICON_URL

Template for getIconUrl()

See Also:

• Constant Field Values

Method Details

fromId

@Nonnull
static StickerSnowflake fromId(long id)

Creates a sticker snowflake instance which only wraps an ID.

This is primarily used for message sending purposes.

Parameters:

id - The sticker id

Returns:

A sticker snowflake instance

See Also:

• JDA.retrieveSticker(StickerSnowflake)

fromId

@Nonnull
static StickerSnowflake fromId(@Nonnull
 String id)

Creates a sticker snowflake instance which only wraps an ID.

This is primarily used for message sending purposes.

Parameters:

id - The sticker id

Returns:

A sticker snowflake instance

Throws:

IllegalArgumentException - If the provided ID is not a valid snowflake

See Also:

• JDA.retrieveSticker(StickerSnowflake)

getFormatType

@Nonnull
Sticker.StickerFormat getFormatType()

The format type of this sticker, used for getIconUrl().
Note that stickers can be of type LOTTIE, which don't have simple image icons, but instead rely on client-side rendering.

Future stickers might have format UNKNOWN, which cannot be converted to a URL.

Returns:

The Sticker.StickerFormat of this sticker

getName

@Nonnull
String getName()

The name of the sticker.

Returns:

the name of the sticker

getIconUrl

@Nonnull
default String getIconUrl()

The url of the sticker image.
Note that LOTTIE stickers don't provide an image, but a JSON format.

Returns:

The image url of the sticker

Throws:

IllegalStateException - If the StickerFormat of this sticker is UNKNOWN

getIcon

@Nonnull
default ImageProxy getIcon()

Returns an ImageProxy for this sticker's image.

The size parameter for ImageProxy is not supported for stickers of type LOTTIE.

Returns:

Never-null ImageProxy of this sticker's image

Throws:

IllegalStateException - If the Sticker.StickerFormat of this sticker is UNKNOWN

See Also:

• getIconUrl()