Package org.javacord.api.entity.message.embed

Interface EmbedAuthor

All Superinterfaces:

Formattable, Nameable

public interface EmbedAuthor
extends Nameable

This interface represents an embed author.

Method Summary

Modifier and Type	Method	Description
Optional<CompletableFuture<BufferedImage>>	downloadIconAsBufferedImage(DiscordApi api)	Downloads the author icon as a BufferedImage.
Optional<CompletableFuture<byte[]>>	downloadIconAsByteArray(DiscordApi api)	Downloads the author icon as a byte array.
Optional<InputStream>	downloadIconAsInputStream(DiscordApi api)	Downloads the author icon as an input stream.
Optional<URL>	getIconUrl()	Gets the url of the author icon.
Optional<URL>	getProxyIconUrl()	Gets the proxy url of the author icon.
Optional<URL>	getUrl()	Gets the url of the author.

Methods inherited from interface org.javacord.api.entity.Nameable

formatTo, getName

Method Detail

getUrl

Optional<URL> getUrl()

Gets the url of the author.

Returns:

The url of the author.

getIconUrl

Optional<URL> getIconUrl()

Gets the url of the author icon.

Returns:

The url of the author icon.

getProxyIconUrl

Optional<URL> getProxyIconUrl()

Gets the proxy url of the author icon.

Returns:

The proxy url of the author icon.

downloadIconAsBufferedImage

Optional<CompletableFuture<BufferedImage>> downloadIconAsBufferedImage(DiscordApi api)

Downloads the author icon as a BufferedImage.

Parameters:

api - The discord api instance used to download the author icon.

Returns:

The thumbnail as a BufferedImage.

downloadIconAsByteArray

Optional<CompletableFuture<byte[]>> downloadIconAsByteArray(DiscordApi api)

Downloads the author icon as a byte array.

Parameters:

api - The discord api instance used to download the author icon.

Returns:

The thumbnail as a byte array.

downloadIconAsInputStream

Optional<InputStream> downloadIconAsInputStream(DiscordApi api)
                                         throws IOException

Downloads the author icon as an input stream.

Parameters:

api - The discord api instance used to download the author icon.

Returns:

The thumbnail as a input stream.

Throws:

IOException - If an IO error occurs.