Package com.mewna.catnip.entity.message

Interface Embed

All Known Implementing Classes:
EmbedImpl
public interface Embed
All methods of this class (and inner classes) have nullable returns, unless otherwise stated.
Since:
9/2/18.
Author:
natanbc

  • Method Details

    • title

      @Nullable @CheckReturnValue String title()
      Embed title.
      Returns:
      Title of the embed, or null if absent.

    • type

      @Nonnull @CheckReturnValue Embed.EmbedType type()
      Embed type.
      Returns:
      Type of the embed. Never null.

    • description

      @Nullable @CheckReturnValue String description()
      Embed description.
      Returns:
      Description of the embed, or null if absent.

    • url

      @Nullable @CheckReturnValue String url()
      Embed URL.
      Returns:
      URL of the embed, or null if absent.

    • timestamp

      @Nullable @CheckReturnValue OffsetDateTime timestamp()
      Embed timestamp.
      Returns:
      Timestamp of the embed, or null if absent.

    • color

      @Nullable @CheckReturnValue Integer color()
      Embed color.
      Returns:
      Color of the embed, or null if absent.

    • footer

      @Nullable @CheckReturnValue Embed.Footer footer()
      Embed footer.
      Returns:
      Footer of the embed, or null if absent.

    • image

      @Nullable @CheckReturnValue Embed.Image image()
      Embed image.
      Returns:
      Image of the embed, or null if absent.

    • thumbnail

      @Nullable @CheckReturnValue Embed.Thumbnail thumbnail()
      Embed thumbnail.
      Returns:
      Thumbnail of the embed, or null if absent.

    • video

      @Nullable @CheckReturnValue Embed.Video video()
      Embed video.
      Returns:
      Video of the embed, or null if absent.

    • provider

      @Nullable @CheckReturnValue Embed.Provider provider()
      Embed provider.
      Returns:
      Provider of the embed, or null if absent.

    • author

      @Nullable @CheckReturnValue Embed.Author author()
      Embed author.
      Returns:
      Author of the embed, or null if absent.

    • fields

      @Nonnull @CheckReturnValue List<Embed.Field> fields()
      Embed fields.
      Returns:
      Fields of the embed. Never null.