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

Interface Embed

  • public interface Embed
    This interface represents an embed.

    • Method Detail

      • getTitle

        java.util.Optional<java.lang.String> getTitle()
        Gets the title of the embed.
        Returns:
        The title of the embed.

      • getType

        java.lang.String getType()
        Gets the type of the embed. (always "rich" for webhook embeds)
        Returns:
        The type of the embed.

      • getDescription

        java.util.Optional<java.lang.String> getDescription()
        Gets the description of the embed.
        Returns:
        The description of the embed.

      • getUrl

        java.util.Optional<java.net.URL> getUrl()
        Gets the url of the embed.
        Returns:
        The url of the embed.

      • getTimestamp

        java.util.Optional<java.time.Instant> getTimestamp()
        Gets the timestamp of the embed.
        Returns:
        The timestamp of the embed.

      • getColor

        java.util.Optional<java.awt.Color> getColor()
        Gets the color of the embed.
        Returns:
        The color of the embed.

      • getFooter

        java.util.Optional<EmbedFooter> getFooter()
        Gets the footer of the embed.
        Returns:
        The footer of the embed.

      • getImage

        java.util.Optional<EmbedImage> getImage()
        Gets the image of the embed.
        Returns:
        The image of the embed.

      • getThumbnail

        java.util.Optional<EmbedThumbnail> getThumbnail()
        Gets the thumbnail of the embed.
        Returns:
        The thumbnail of the embed.

      • getVideo

        java.util.Optional<EmbedVideo> getVideo()
        Gets the video of the embed.
        Returns:
        The video of the embed.

      • getProvider

        java.util.Optional<EmbedProvider> getProvider()
        Gets the provider of the embed.
        Returns:
        The provider of the embed.

      • getAuthor

        java.util.Optional<EmbedAuthor> getAuthor()
        Gets the author of the embed.
        Returns:
        The author of the embed.

      • getFields

        java.util.List<EmbedField> getFields()
        Gets the fields of the embed.
        Returns:
        The fields of the embed.

      • toBuilder

        default EmbedBuilder toBuilder()
        Creates a builder, based on the embed. You can use this method, if you want to resend an embed, you received as a message.
        Returns:
        A builder with the values of this embed.