Package net.dv8tion.jda.api.entities

Class Icon

java.lang.Object
net.dv8tion.jda.api.entities.Icon
public class Icon extends Object
Icon containing a base64 encoded jpeg/png/gif/gifv image.
Used to represent various base64 images in the Discord api.
Example: AccountManager.setAvatar(Icon).
Since:
3.0
See Also:

  • Method Details

    • getEncoding

      @Nonnull public String getEncoding()
      The base64 encoded data for this Icon
      Returns:
      String representation of the encoded data for this icon

    • from

      @Nonnull public static Icon from(@Nonnull File file) throws IOException
      Creates an Icon with the specified File.
      We here read the specified File and forward the retrieved byte data to from(byte[], IconType).
      Parameters:
      file - An existing, not-null file.
      Returns:
      An Icon instance representing the specified File
      Throws:
      IllegalArgumentException - if the provided file is null, does not exist, or has an unsupported extension
      IOException - if there is a problem while reading the file.

    • from

      @Nonnull public static Icon from(@Nonnull InputStream stream) throws IOException
      Creates an Icon with the specified InputStream.
      We here read the specified InputStream and forward the retrieved byte data to from(byte[], IconType). This will use Icon.IconType.JPEG but discord is capable for interpreting other types correctly either way.
      Parameters:
      stream - A not-null InputStream.
      Returns:
      An Icon instance representing the specified InputStream
      Throws:
      IllegalArgumentException - if the provided stream is null
      IOException - If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

    • from

      @Nonnull public static Icon from(@Nonnull byte[] data)
      Creates an Icon with the specified image data. This will use Icon.IconType.JPEG but discord is capable for interpreting other types correctly either way.
      Parameters:
      data - not-null image data bytes.
      Returns:
      An Icon instance representing the specified image data
      Throws:
      IllegalArgumentException - if the provided data is null

    • from

      @Nonnull public static Icon from(@Nonnull File file, @Nonnull Icon.IconType type) throws IOException
      Creates an Icon with the specified File.
      We here read the specified File and forward the retrieved byte data to from(byte[], IconType).
      Parameters:
      file - An existing, not-null file.
      type - The type of image
      Returns:
      An Icon instance representing the specified File
      Throws:
      IllegalArgumentException - if the provided file is either null or does not exist
      IOException - if there is a problem while reading the file.

    • from

      @Nonnull public static Icon from(@Nonnull InputStream stream, @Nonnull Icon.IconType type) throws IOException
      Creates an Icon with the specified InputStream.
      We here read the specified InputStream and forward the retrieved byte data to from(byte[], IconType).
      Parameters:
      stream - A not-null InputStream.
      type - The type of image
      Returns:
      An Icon instance representing the specified InputStream
      Throws:
      IllegalArgumentException - if the provided stream is null
      IOException - If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

    • from

      @Nonnull public static Icon from(@Nonnull byte[] data, @Nonnull Icon.IconType type)
      Creates an Icon with the specified image data.
      Parameters:
      data - not-null image data bytes.
      type - The type of image
      Returns:
      An Icon instance representing the specified image data
      Throws:
      IllegalArgumentException - if the provided data is null