Class Embed

Namespace

NetCord

Assembly

NetCord.dll

Displays embedded content such as an image or URL, alongside a title and various other fields. You can only have up to 10 embeds per message, and the total text of all embeds must be less than or equal to 6000 characters.

public class Embed : IJsonModel<JsonEmbed>

Inheritance

object

Embed

Implements

IJsonModel<JsonEmbed>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Embed(JsonEmbed)

Creates an embed from its JsonEmbed equivalent.

public Embed(JsonEmbed jsonModel)

Parameters

jsonModel JsonEmbed

Properties

Author

Contains the author block, always located at the top of the embed.

public EmbedAuthor? Author { get; }

Property Value

EmbedAuthor

Color

The color of the embed’s border in an RGB format.

public Color? Color { get; }

Property Value

Color?

Description

The part of the embed where the main text is contained, limited to 4096 characters.

public string? Description { get; }

Property Value

string

Fields

Allows the addition of multiple subtitles with additional content underneath them below the main Title and Description blocks, maximum of 25 per embed.

public IReadOnlyList<EmbedField> Fields { get; }

Property Value

IReadOnlyList<EmbedField>

Footer

The text at the bottom of the embed, limited to 2048 characters.

public EmbedFooter? Footer { get; }

Property Value

EmbedFooter

Image

The image included in the embed, displayed as a large-sized image located below the Description element.

public EmbedImage? Image { get; }

Property Value

EmbedImage

Provider

The provider of the embed content (YouTube, Twitter/X, etc), automatically generated from links in content.

public EmbedProvider? Provider { get; }

Property Value

EmbedProvider

Thumbnail

The thumbnail of the embed, displayed as a medium-sized image in the top right corner of the embed.

public EmbedThumbnail? Thumbnail { get; }

Property Value

EmbedThumbnail

Timestamp

Displays time in a format similar to a message timestamp. Located next to the Footer.

public DateTimeOffset? Timestamp { get; }

Property Value

DateTimeOffset?

Title

The text that is placed above the description, usually highlighted. Also directs to a URL if one is given in Url, has a 256 character limit.

public string? Title { get; }

Property Value

string

Type

Information about the type of the embed.

public EmbedType? Type { get; }

Property Value

EmbedType?

Url

A link to an address of a webpage. When set, the Title becomes a clickable link, directing to the URL.

public string? Url { get; }

Property Value

string

Video

The video included and displayed in the embed.

public EmbedVideo? Video { get; }

Property Value

EmbedVideo