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

Interface Embed


  • public interface Embed
    This interface represents an embed.

    • Method Detail

      • getTitle

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

      • getType

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

      • getDescription

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

      • getUrl

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

      • getTimestamp

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

      • getColor

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

      • getFooter

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

      • getImage

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

      • getThumbnail

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

      • getVideo

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

      • getProvider

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

      • getAuthor

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

      • getFields

        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.