Package net.dv8tion.jda.api.managers

Interface GuildStickerManager

All Superinterfaces:
AuditableRestAction<Void>, Manager<GuildStickerManager>, RestAction<Void>
public interface GuildStickerManager extends Manager<GuildStickerManager>
Manager providing functionality to update one or more fields for GuildSticker.

Example 


 manager.setName("catDance")
        .setDescription("Cat dancing")
        .queue();
 manager.reset(GuildStickerManager.NAME | GuildStickerManager.TAGS)
        .setName("dogDance")
        .setTags("dancing", "dog")
        .queue();
See Also:

  • Field Details

  • Method Details

    • reset

      @Nonnull @CheckReturnValue GuildStickerManager reset(long fields)
      Resets the fields specified by the provided bit-flag pattern. You can specify a combination by using a bitwise OR concat of the flag constants.
      Example: manager.reset(GuildStickerManager.NAME | GuildStickerManager.TAGS);

      Flag Constants:

      Specified by:
      reset in interface Manager<GuildStickerManager>
      Parameters:
      fields - Integer value containing the flags to reset.
      Returns:
      GuildStickerManager for chaining convenience

    • reset

      @Nonnull @CheckReturnValue GuildStickerManager reset(long... fields)
      Resets the fields specified by the provided bit-flag patterns.
      Example: manager.reset(GuildStickerManager.NAME, GuildStickerManager.TAGS);

      Flag Constants:

      Specified by:
      reset in interface Manager<GuildStickerManager>
      Parameters:
      fields - Integer value containing the flags to reset.
      Returns:
      GuildStickerManager for chaining convenience

    • getGuild

      @Nullable Guild getGuild()
      The Guild this Manager's GuildSticker is in.

      This is null if GuildSticker.getManager() is used on a sticker with an uncached guild.

      Returns:
      The Guild, or null if not present.
      See Also:

    • 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

    • setName

      @Nonnull @CheckReturnValue GuildStickerManager setName(@Nonnull String name)
      Sets the name of the sticker.

      A sticker name must be between 2-30 characters long!

      Example: catDance or dogWave

      Parameters:
      name - The new name for the sticker (2-30 characters)
      Returns:
      GuildStickerManager for chaining convenience
      Throws:
      IllegalArgumentException - If the provided name is null or not between 2-30 characters long

    • setDescription

      @Nonnull @CheckReturnValue GuildStickerManager setDescription(@Nonnull String description)
      Sets the description of the sticker.

      A sticker description must be between 2-100 characters long!

      Parameters:
      description - The new description for the sticker (2-100 characters)
      Returns:
      GuildStickerManager for chaining convenience
      Throws:
      IllegalArgumentException - If the provided description is null or not between 2-100 characters long

    • setTags

      @Nonnull @CheckReturnValue GuildStickerManager setTags(@Nonnull Collection<String> tags)
      Sets the tags of the sticker.
      These are used for auto-complete when sending a message in the client, and for the sticker picker menu.

      The combined list of sticker tags must at most be 200 characters long!

      Example: catDance or dogWave

      Parameters:
      tags - The new tags for the sticker (up to 200 characters)
      Returns:
      GuildStickerManager for chaining convenience
      Throws:
      IllegalArgumentException -
      • If tags is null
      • If tags is empty
      • If tags contains null or empty strings
      • If the concatenated tags are more than 200 characters long (including commas between tags)

    • setTags

      @Nonnull @CheckReturnValue default GuildStickerManager setTags(@Nonnull String... tags)
      Sets the tags of the sticker.
      These are used for auto-complete when sending a message in the client, and for the sticker picker menu.

      The combined list of sticker tags must at most be 200 characters long!

      Example: catDance or dogWave

      Parameters:
      tags - The new tags for the sticker (up to 200 characters)
      Returns:
      GuildStickerManager for chaining convenience
      Throws:
      IllegalArgumentException -
      • If tags is null
      • If tags is empty
      • If tags contains null or empty strings
      • If the concatenated tags are more than 200 characters long (including commas between tags)