Package net.dv8tion.jda.internal.entities.sticker

Class GuildStickerImpl

java.lang.Object

net.dv8tion.jda.internal.entities.sticker.StickerItemImpl

net.dv8tion.jda.internal.entities.sticker.RichStickerImpl

net.dv8tion.jda.internal.entities.sticker.GuildStickerImpl

All Implemented Interfaces:

ISnowflake, GuildSticker, RichSticker, Sticker, StickerItem, StickerSnowflake, StickerUnion

public class GuildStickerImpl
extends RichStickerImpl
implements GuildSticker

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.sticker.Sticker

Sticker.StickerFormat, Sticker.Type

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.sticker.Sticker

ICON_URL

Constructor Summary

Constructors

Constructor	Description
GuildStickerImpl(long id, Sticker.StickerFormat format, String name, Set<String> tags, String description, boolean available, long guildId, JDA jda, User owner)

Method Summary

Modifier and Type	Method	Description
GuildSticker	asGuildSticker()	Returns the underlying GuildSticker if applicable.
GuildStickerImpl	copy()
AuditableRestAction<Void>	delete()	Deletes this sticker from the guild.
boolean	equals(Object obj)
Guild	getGuild()	The Guild this sticker belongs to.
long	getGuildIdLong()	The ID of the guild this sticker belongs to.
GuildStickerManager	getManager()	Modify this sticker using GuildStickerManager.
User	getOwner()	The user who created this sticker.
int	hashCode()
boolean	isAvailable()	Whether this sticker is currently available.
CacheRestAction<User>	retrieveOwner()	Retrieves the sticker owner.
GuildStickerImpl	setAvailable(boolean available)
String	toString()

Methods inherited from class net.dv8tion.jda.internal.entities.sticker.RichStickerImpl

asStandardSticker, getDescription, getTags, setDescription, setTags

Methods inherited from class net.dv8tion.jda.internal.entities.sticker.StickerItemImpl

getFormatType, getIdLong, getName, setName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.sticker.GuildSticker

getGuildId, getType

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

getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.sticker.RichSticker

getDescription, getTags

Methods inherited from interface net.dv8tion.jda.api.entities.sticker.Sticker

getFormatType, getIcon, getIconUrl, getName

Constructor Details

GuildStickerImpl

public GuildStickerImpl(long id,
 Sticker.StickerFormat format,
 String name,
 Set<String> tags,
 String description,
 boolean available,
 long guildId,
 JDA jda,
 User owner)

Method Details

asGuildSticker

@Nonnull
public GuildSticker asGuildSticker()

Description copied from interface: StickerUnion

Returns the underlying GuildSticker if applicable.

Specified by:

asGuildSticker in interface StickerUnion

Overrides:

asGuildSticker in class RichStickerImpl

Returns:

The GuildSticker

isAvailable

public boolean isAvailable()

Description copied from interface: GuildSticker

Whether this sticker is currently available.
A sticker becomes unavailable when the boost level of a guild drops and the slot becomes unusable.

Specified by:

isAvailable in interface GuildSticker

Returns:

True, if this sticker is available

getGuildIdLong

public long getGuildIdLong()

Description copied from interface: GuildSticker

The ID of the guild this sticker belongs to.

Specified by:

getGuildIdLong in interface GuildSticker

Returns:

The guild id

getGuild

@Nullable
public Guild getGuild()

Description copied from interface: GuildSticker

The Guild this sticker belongs to.
This is null if the guild is not cached on creation, Which is often the case for JDA.retrieveSticker(...).

Specified by:

getGuild in interface GuildSticker

Returns:

Possibly-null guild of the sticker

getOwner

@Nullable
public User getOwner()

Description copied from interface: GuildSticker

The user who created this sticker.
This is null if the sticker is retrieved from cache, since the owner is only provided for explicitly requested stickers.

Specified by:

getOwner in interface GuildSticker

Returns:

Possibly-null sticker owner

See Also:

• GuildSticker.retrieveOwner()

retrieveOwner

@Nonnull
public CacheRestAction<User> retrieveOwner()

Description copied from interface: GuildSticker

Retrieves the sticker owner.
If GuildSticker.getOwner() is present, this will directly return the owner in a completed RestAction without making a request. The user information might be outdated, you can use action.useCache(false) to force an update.

Possible ErrorResponses include:

• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MANAGE_GUILD_EXPRESSIONS in the guild

Specified by:

retrieveOwner in interface GuildSticker

Returns:

CacheRestAction - Type: User

delete

@Nonnull
public AuditableRestAction<Void> delete()

Description copied from interface: GuildSticker

Deletes this sticker from the guild.

Specified by:

delete in interface GuildSticker

Returns:

AuditableRestAction

getManager

@Nonnull
public GuildStickerManager getManager()

Description copied from interface: GuildSticker

Modify this sticker using GuildStickerManager.
You can update multiple fields at once, by calling the respective setters before executing the request.

Specified by:

getManager in interface GuildSticker

Returns:

GuildStickerManager

setAvailable

public GuildStickerImpl setAvailable(boolean available)

copy

public GuildStickerImpl copy()

toString

public String toString()

Overrides:

toString in class RichStickerImpl

hashCode

public int hashCode()

Overrides:

hashCode in class StickerItemImpl

equals

public boolean equals(Object obj)

Overrides:

equals in class StickerItemImpl