Class Embed

Namespace

Discord

Assembly

Discord.Net.Core.dll

Represents an embed object seen in an IUserMessage.

public class Embed : IEmbed

Inheritance

object

Embed

Implements

IEmbed

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

StringExtensions.ToJsonString(Embed, Formatting)

EmbedBuilderExtensions.ToEmbedBuilder(IEmbed)

Properties

Author

Gets the author field of this embed.

public EmbedAuthor? Author { get; }

Property Value

EmbedAuthor?

The author field of the embed, or null if none is set.

Color

Gets the color of this embed.

public Color? Color { get; }

Property Value

Color?

The color of the embed present on the side of the embed, or null if none is set.

Description

Gets the description of this embed.

public string Description { get; }

Property Value

string

The description field of the embed.

Fields

Gets the fields of the embed.

public ImmutableArray<EmbedField> Fields { get; }

Property Value

ImmutableArray<EmbedField>

An array of the fields of the embed.

Footer

Gets the footer field of this embed.

public EmbedFooter? Footer { get; }

Property Value

EmbedFooter?

The author field of the embed, or null if none is set.

Image

Gets the image of this embed.

public EmbedImage? Image { get; }

Property Value

EmbedImage?

The image of the embed, or null if none is set.

Length

Gets the total length of all embed properties.

public int Length { get; }

Property Value

int

Provider

Gets the provider of this embed.

public EmbedProvider? Provider { get; }

Property Value

EmbedProvider?

The source of the embed, or null if none is set.

Thumbnail

Gets the thumbnail featured in this embed.

public EmbedThumbnail? Thumbnail { get; }

Property Value

EmbedThumbnail?

The thumbnail featured in the embed, or null if none is set.

Timestamp

Gets the timestamp of this embed.

public DateTimeOffset? Timestamp { get; }

Property Value

DateTimeOffset?

A DateTimeOffset based on the timestamp present at the bottom left of the embed, or null if none is set.

Title

Gets the title of this embed.

public string Title { get; }

Property Value

string

The title of the embed.

Type

Gets the type of this embed.

public EmbedType Type { get; }

Property Value

EmbedType

The type of the embed.

Url

Gets the title URL of this embed.

public string Url { get; }

Property Value

string

A string containing the URL set in a title of the embed.

Video

Gets the video of this embed.

public EmbedVideo? Video { get; }

Property Value

EmbedVideo?

The video of the embed, or null if none is set.

Methods

Equals(Embed)

Determines whether the specified Embed is equal to the current Embed

public bool Equals(Embed embed)

Parameters

embed Embed

The Embed to compare with the current Embed

Returns

bool

Equals(object)

Determines whether the specified object is equal to the current Embed.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current Embed

Returns

bool

Remarks

If the object passes is an Embed, Equals(Embed) will be called to compare the 2 instances

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Gets the title of the embed.

public override string ToString()

Returns

string

Operators

operator ==(Embed, Embed)

public static bool operator ==(Embed left, Embed right)

Parameters

left Embed

right Embed

Returns

bool

operator !=(Embed, Embed)

public static bool operator !=(Embed left, Embed right)

Parameters

left Embed

right Embed

Returns

bool