club.minnced.discord.webhook.receive

Class ReadonlyEmbed

java.lang.Object

club.minnced.discord.webhook.send.WebhookEmbed

club.minnced.discord.webhook.receive.ReadonlyEmbed

All Implemented Interfaces:

org.json.JSONString

public class ReadonlyEmbed
extends WebhookEmbed

Extension of WebhookEmbed with additional meta-data on receivable embeds.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadonlyEmbed.EmbedImage POJO containing meta-data about an embed image component
static class	ReadonlyEmbed.EmbedProvider POJO containing meta-data for an embed provider
static class	ReadonlyEmbed.EmbedVideo POJO containing meta-data about an embed video

Nested classes/interfaces inherited from class club.minnced.discord.webhook.send.WebhookEmbed

WebhookEmbed.EmbedAuthor, WebhookEmbed.EmbedField, WebhookEmbed.EmbedFooter, WebhookEmbed.EmbedTitle

Field Summary

Fields inherited from class club.minnced.discord.webhook.send.WebhookEmbed

MAX_FIELDS

Constructor Summary

Constructors

Constructor and Description

ReadonlyEmbed(@Nullable java.time.OffsetDateTime timestamp, @Nullable java.lang.Integer color, @Nullable java.lang.String description, @Nullable ReadonlyEmbed.EmbedImage thumbnail, @Nullable ReadonlyEmbed.EmbedImage image, @Nullable WebhookEmbed.EmbedFooter footer, @Nullable WebhookEmbed.EmbedTitle title, @Nullable WebhookEmbed.EmbedAuthor author, @NotNull java.util.List<WebhookEmbed.EmbedField> fields, @Nullable ReadonlyEmbed.EmbedProvider provider, @Nullable ReadonlyEmbed.EmbedVideo video)

Method Summary

Modifier and Type	Method and Description
@Nullable ReadonlyEmbed.EmbedImage	getImage() The image of this embed.
@Nullable ReadonlyEmbed.EmbedProvider	getProvider() The ReadonlyEmbed.EmbedProvider Used for services that are automatically embedded by discord when posting a link, this includes services like youtube or twitter.
@Nullable ReadonlyEmbed.EmbedImage	getThumbnail() The thumbnail of this embed.
@Nullable ReadonlyEmbed.EmbedVideo	getVideo() The video of this embed.
@NotNull WebhookEmbed	reduced() Reduces this embed to a simpler WebhookEmbed instance that can be used for sending, this is done implicitly when trying to send an instance of a readonly-embed.
java.lang.String	toJSONString()
java.lang.String	toString() JSON representation of this embed.

Methods inherited from class club.minnced.discord.webhook.send.WebhookEmbed

getAuthor, getColor, getDescription, getFields, getFooter, getImageUrl, getThumbnailUrl, getTimestamp, getTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadonlyEmbed

public ReadonlyEmbed(@Nullable
                     @Nullable java.time.OffsetDateTime timestamp,
                     @Nullable
                     @Nullable java.lang.Integer color,
                     @Nullable
                     @Nullable java.lang.String description,
                     @Nullable
                     @Nullable ReadonlyEmbed.EmbedImage thumbnail,
                     @Nullable
                     @Nullable ReadonlyEmbed.EmbedImage image,
                     @Nullable
                     @Nullable WebhookEmbed.EmbedFooter footer,
                     @Nullable
                     @Nullable WebhookEmbed.EmbedTitle title,
                     @Nullable
                     @Nullable WebhookEmbed.EmbedAuthor author,
                     @NotNull
                     @NotNull java.util.List<WebhookEmbed.EmbedField> fields,
                     @Nullable
                     @Nullable ReadonlyEmbed.EmbedProvider provider,
                     @Nullable
                     @Nullable ReadonlyEmbed.EmbedVideo video)

Method Detail

getProvider

@Nullable
public @Nullable ReadonlyEmbed.EmbedProvider getProvider()

The ReadonlyEmbed.EmbedProvider
Used for services that are automatically embedded by discord when posting a link, this includes services like youtube or twitter.

Returns:

Possibly-null embed provider

getThumbnail

@Nullable
public @Nullable ReadonlyEmbed.EmbedImage getThumbnail()

The thumbnail of this embed.

Returns:

Possibly-null ReadonlyEmbed.EmbedImage for the thumbnail

getImage

@Nullable
public @Nullable ReadonlyEmbed.EmbedImage getImage()

The image of this embed.

Returns:

Possibly-null ReadonlyEmbed.EmbedImage for the image

getVideo

@Nullable
public @Nullable ReadonlyEmbed.EmbedVideo getVideo()

The video of this embed.
This is a whitelisted feature only available for services like youtube and is only populated for link embeds.

Returns:

Possibly-null ReadonlyEmbed.EmbedVideo

reduced

@NotNull
public @NotNull WebhookEmbed reduced()

Reduces this embed to a simpler WebhookEmbed instance that can be used for sending, this is done implicitly when trying to send an instance of a readonly-embed.

Overrides:

reduced in class WebhookEmbed

Returns:

The reduced embed instance

toString

public java.lang.String toString()

JSON representation of this embed.
Note that received embeds look different compared to sent ones.

Overrides:

toString in class WebhookEmbed

Returns:

The JSON representation

toJSONString

public java.lang.String toJSONString()

Specified by:

toJSONString in interface org.json.JSONString

Overrides:

toJSONString in class WebhookEmbed