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

Interface GuildSticker

All Superinterfaces:

ISnowflake, RichSticker, Sticker, StickerSnowflake

public interface GuildSticker
extends RichSticker

Custom guild sticker created by a user.

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

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<Void>	delete()	Deletes this sticker from the guild.
Guild	getGuild()	The Guild this sticker belongs to.
default String	getGuildId()	The ID of 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.
default Sticker.Type	getType()	The Sticker Type
boolean	isAvailable()	Whether this sticker is currently available.
CacheRestAction<User>	retrieveOwner()	Retrieves the sticker owner.

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

Method Details

getType

@Nonnull
default Sticker.Type getType()

Description copied from interface: RichSticker

The Sticker Type

Specified by:

getType in interface RichSticker

Returns:

The type

isAvailable

boolean isAvailable()

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

Returns:

True, if this sticker is available

getGuildIdLong

long getGuildIdLong()

The ID of the guild this sticker belongs to.

Returns:

The guild id

getGuildId

@Nonnull
default String getGuildId()

The ID of the guild this sticker belongs to.

Returns:

The guild id

getGuild

@Nullable
Guild getGuild()

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(...).

Returns:

Possibly-null guild of the sticker

getOwner

@Nullable
User getOwner()

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.

Returns:

Possibly-null sticker owner

See Also:

• retrieveOwner()

retrieveOwner

@Nonnull
@CheckReturnValue
CacheRestAction<User> retrieveOwner()

Retrieves the sticker owner.
If 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

Returns:

CacheRestAction - Type: User

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_GUILD_EXPRESSIONS in the guild.

delete

@Nonnull
@CheckReturnValue
AuditableRestAction<Void> delete()

Deletes this sticker from the guild.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have MANAGE_GUILD_EXPRESSIONS in the guild.

getManager

@Nonnull
@CheckReturnValue
@Contract("->new")
GuildStickerManager getManager()

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

Returns:

GuildStickerManager

Throws:

InsufficientPermissionException - If the currently logged in account does not have MANAGE_GUILD_EXPRESSIONS in the guild.