Class MessageEmbedBuilder
-
- All Implemented Interfaces:
public class MessageEmbedBuildercom.discord.api.message.embed.MessageEmbed builder
-
-
Constructor Summary
Constructors Constructor Description MessageEmbedBuilder()Creates a rich embed MessageEmbedBuilder(EmbedType type)Creates an embed with a specific type.
-
Method Summary
Modifier and Type Method Description MessageEmbedbuild()Builds the MessageEmbed MessageEmbedBuildersetAuthor(String name)MessageEmbedBuildersetAuthor(String name, String iconUrl)MessageEmbedBuildersetAuthor(String name, String iconUrl, String proxyIconUrl)MessageEmbedBuildersetAuthor(EmbedAuthor author)Sets the embed author. MessageEmbedBuildersetRandomColor()Sets a random embed color. MessageEmbedBuildersetColor(Integer color)Sets the embed color. MessageEmbedBuildersetDescription(String description)Sets the embed description. MessageEmbedBuilderaddField(String name, String value, boolean inline)Adds a field to the embed. MessageEmbedBuilderaddField(EmbedField field)Adds a field to the embed. MessageEmbedBuildersetFields(List<EmbedField> fields)Sets embed fields. MessageEmbedBuildersetFooter(String text)Sets the embed footer. MessageEmbedBuildersetFooter(String text, String iconUrl)Sets the embed footer. MessageEmbedBuildersetFooter(String text, String iconUrl, String proxyIconUrl)Sets the embed footer. MessageEmbedBuildersetFooter(EmbedFooter footer)Sets the embed footer. MessageEmbedBuildersetImage(String imageUrl)Sets the embed image. MessageEmbedBuildersetImage(String imageUrl, String proxyImageUrl)Sets the embed image. MessageEmbedBuildersetImage(String imageUrl, String proxyImageUrl, Integer imageHeight, Integer imageWidth)Sets the embed image. MessageEmbedBuildersetImage(EmbedImage image)Sets the embed image. MessageEmbedBuildersetProvider(EmbedProvider provider)Sets the embed provider. MessageEmbedBuildersetThumbnail(String imageUrl)Sets the embed thumbnail. MessageEmbedBuildersetThumbnail(String imageUrl, String proxyImageUrl)Sets the embed thumbnail. MessageEmbedBuildersetThumbnail(String imageUrl, String proxyImageUrl, Integer imageHeight, Integer imageWidth)Sets the embed thumbnail. MessageEmbedBuildersetThumbnail(EmbedThumbnail image)Sets the embed thumbnail. MessageEmbedBuildersetTimestamp(UtcDateTime timestamp)Sets the embed timestamp. MessageEmbedBuildersetTitle(String title)Sets the embed title. MessageEmbedBuildersetType(EmbedType type)Sets the embed type. MessageEmbedBuildersetUrl(String url)Sets the embed URL. MessageEmbedBuildersetVideo(String videoUrl, String proxyVideoUrl, Integer height, Integer width)Sets the embed video. MessageEmbedBuildersetVideo(String videoUrl)Sets the embed video. MessageEmbedBuildersetVideo(String videoUrl, String proxyVideoUrl)Sets the embed video. MessageEmbedBuildersetVideo(EmbedVideo video)Sets the embed video. static EmbedFieldcreateField(String name, String value, Boolean inline)-
-
Method Detail
-
build
MessageEmbed build()
Builds the MessageEmbed
-
setAuthor
MessageEmbedBuilder setAuthor(String name)
- Parameters:
name- Name of the author.- Returns:
MessageEmbedBuilder for chaining.
-
setAuthor
MessageEmbedBuilder setAuthor(String name, String iconUrl)
- Parameters:
name- Name of the author.iconUrl- Icon URL of the author.- Returns:
MessageEmbedBuilder for chaining.
-
setAuthor
MessageEmbedBuilder setAuthor(String name, String iconUrl, String proxyIconUrl)
- Parameters:
name- Name of the author.iconUrl- Icon URL of the author.proxyIconUrl- Proxy icon URL of the author.- Returns:
MessageEmbedBuilder for chaining.
-
setAuthor
MessageEmbedBuilder setAuthor(EmbedAuthor author)
Sets the embed author.
- Parameters:
author- EmbedAuthor- Returns:
MessageEmbedBuilder for chaining.
-
setRandomColor
MessageEmbedBuilder setRandomColor()
Sets a random embed color.
- Returns:
MessageEmbedBuilder for chaining.
-
setColor
MessageEmbedBuilder setColor(Integer color)
Sets the embed color.
- Parameters:
color- Embed color.- Returns:
MessageEmbedBuilder for chaining.
-
setDescription
MessageEmbedBuilder setDescription(String description)
Sets the embed description.
- Parameters:
description- Embed description.- Returns:
MessageEmbedBuilder for chaining.
-
addField
MessageEmbedBuilder addField(String name, String value, boolean inline)
Adds a field to the embed.
- Parameters:
name- Name of the field.value- Content of the field.inline- Whether to inline the field or not.- Returns:
MessageEmbedBuilder for chaining.
-
addField
MessageEmbedBuilder addField(EmbedField field)
Adds a field to the embed.
- Parameters:
field- EmbedField- Returns:
MessageEmbedBuilder for chaining.
-
setFields
MessageEmbedBuilder setFields(List<EmbedField> fields)
Sets embed fields.
- Parameters:
fields- List of EmbedField- Returns:
MessageEmbedBuilder for chaining.
-
setFooter
MessageEmbedBuilder setFooter(String text)
Sets the embed footer.
- Parameters:
text- Footer text.- Returns:
MessageEmbedBuilder for chaining.
-
setFooter
MessageEmbedBuilder setFooter(String text, String iconUrl)
Sets the embed footer.
- Parameters:
text- Footer text.iconUrl- Footer icon URL.- Returns:
MessageEmbedBuilder for chaining.
-
setFooter
MessageEmbedBuilder setFooter(String text, String iconUrl, String proxyIconUrl)
Sets the embed footer.
- Parameters:
text- Footer text.iconUrl- Footer icon URL.proxyIconUrl- Footer Proxy icon URL.- Returns:
MessageEmbedBuilder for chaining.
-
setFooter
MessageEmbedBuilder setFooter(EmbedFooter footer)
Sets the embed footer.
- Parameters:
footer- EmbedFooter- Returns:
MessageEmbedBuilder for chaining.
-
setImage
MessageEmbedBuilder setImage(String imageUrl)
Sets the embed image.
- Parameters:
imageUrl- Image URL.- Returns:
MessageEmbedBuilder for chaining.
-
setImage
MessageEmbedBuilder setImage(String imageUrl, String proxyImageUrl)
Sets the embed image.
- Parameters:
imageUrl- Image URL.proxyImageUrl- Proxy image URL.- Returns:
MessageEmbedBuilder for chaining.
-
setImage
MessageEmbedBuilder setImage(String imageUrl, String proxyImageUrl, Integer imageHeight, Integer imageWidth)
Sets the embed image.
- Parameters:
imageUrl- Image URL.proxyImageUrl- Proxy image URL.imageHeight- Image height.imageWidth- Image width.- Returns:
MessageEmbedBuilder for chaining.
-
setImage
MessageEmbedBuilder setImage(EmbedImage image)
Sets the embed image.
- Parameters:
image- EmbedImage- Returns:
MessageEmbedBuilder for chaining.
-
setProvider
MessageEmbedBuilder setProvider(EmbedProvider provider)
Sets the embed provider.
- Parameters:
provider- EmbedProvider.- Returns:
MessageEmbedBuilder for chaining.
-
setThumbnail
MessageEmbedBuilder setThumbnail(String imageUrl)
Sets the embed thumbnail.
- Parameters:
imageUrl- Image URL.- Returns:
MessageEmbedBuilder for chaining.
-
setThumbnail
MessageEmbedBuilder setThumbnail(String imageUrl, String proxyImageUrl)
Sets the embed thumbnail.
- Parameters:
imageUrl- Image URL.proxyImageUrl- Proxy image URL.- Returns:
MessageEmbedBuilder for chaining.
-
setThumbnail
MessageEmbedBuilder setThumbnail(String imageUrl, String proxyImageUrl, Integer imageHeight, Integer imageWidth)
Sets the embed thumbnail.
- Parameters:
imageUrl- Image URL.proxyImageUrl- Proxy image URL.imageHeight- Image height.imageWidth- Image width.- Returns:
MessageEmbedBuilder for chaining.
-
setThumbnail
MessageEmbedBuilder setThumbnail(EmbedThumbnail image)
Sets the embed thumbnail.
- Parameters:
image- EmbedThumbnail- Returns:
MessageEmbedBuilder for chaining.
-
setTimestamp
MessageEmbedBuilder setTimestamp(UtcDateTime timestamp)
Sets the embed timestamp.
- Parameters:
timestamp- UtcDateTime timestamp.- Returns:
MessageEmbedBuilder for chaining.
-
setTitle
MessageEmbedBuilder setTitle(String title)
Sets the embed title.
- Parameters:
title- Embed title.- Returns:
MessageEmbedBuilder for chaining.
-
setType
MessageEmbedBuilder setType(EmbedType type)
Sets the embed type.
- Parameters:
type- EmbedType.- Returns:
MessageEmbedBuilder for chaining.
-
setUrl
MessageEmbedBuilder setUrl(String url)
Sets the embed URL.
- Parameters:
url- Embed URL.- Returns:
MessageEmbedBuilder for chaining.
-
setVideo
MessageEmbedBuilder setVideo(String videoUrl, String proxyVideoUrl, Integer height, Integer width)
Sets the embed video.
- Parameters:
videoUrl- Video URL.- Returns:
MessageEmbedBuilder for chaining.
-
setVideo
MessageEmbedBuilder setVideo(String videoUrl)
Sets the embed video.
- Parameters:
videoUrl- Video URL.- Returns:
MessageEmbedBuilder for chaining.
-
setVideo
MessageEmbedBuilder setVideo(String videoUrl, String proxyVideoUrl)
Sets the embed video.
- Parameters:
videoUrl- Video URL.- Returns:
MessageEmbedBuilder for chaining.
-
setVideo
MessageEmbedBuilder setVideo(EmbedVideo video)
Sets the embed video.
- Parameters:
video- EmbedVideo.- Returns:
MessageEmbedBuilder for chaining.
-
createField
static EmbedField createField(String name, String value, Boolean inline)
- Parameters:
name- Field name.value- Field content.inline- Whether to inline the field or not.- Returns:
MessageEmbedBuilder for chaining.
-
-
-
-