Class Embed

Represents an embed object seen in an IUserMessage.

Inheritance
Object
Embed
Implements
Namespace: Discord
Assembly: Discord.Net.Core.dll
Syntax
public class Embed : object, IEmbed

Properties

| Improve this Doc View Source

Author

Gets the author field of this embed.

Declaration
public EmbedAuthor? Author { get; }
Property Value
Type Description
Nullable<EmbedAuthor>

The author field of the embed, or null if none is set.
| Improve this Doc View Source

Color

Gets the color of this embed.

Declaration
public Color? Color { get; }
Property Value
Type Description
Nullable<Color>

The color of the embed present on the side of the embed, or null if none is set.
| Improve this Doc View Source

Description

Gets the description of this embed.

Declaration
public string Description { get; }
Property Value
Type Description
String

The description field of the embed.
| Improve this Doc View Source

Fields

Gets the fields of the embed.

Declaration
public ImmutableArray<EmbedField> Fields { get; }
Property Value
Type Description
ImmutableArray<EmbedField>

An array of the fields of the embed.
| Improve this Doc View Source

Gets the footer field of this embed.

Declaration
public EmbedFooter? Footer { get; }
Property Value
Type Description
Nullable<EmbedFooter>

The author field of the embed, or null if none is set.
| Improve this Doc View Source

Image

Gets the image of this embed.

Declaration
public EmbedImage? Image { get; }
Property Value
Type Description
Nullable<EmbedImage>

The image of the embed, or null if none is set.
| Improve this Doc View Source

Length

Gets the total length of all embed properties.

Declaration
public int Length { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Provider

Gets the provider of this embed.

Declaration
public EmbedProvider? Provider { get; }
Property Value
Type Description
Nullable<EmbedProvider>

The source of the embed, or null if none is set.
| Improve this Doc View Source

Thumbnail

Gets the thumbnail featured in this embed.

Declaration
public EmbedThumbnail? Thumbnail { get; }
Property Value
Type Description
Nullable<EmbedThumbnail>

The thumbnail featured in the embed, or null if none is set.
| Improve this Doc View Source

Timestamp

Gets the timestamp of this embed.

Declaration
public DateTimeOffset? Timestamp { get; }
Property Value
Type Description
Nullable<DateTimeOffset>

A based on the timestamp present at the bottom left of the embed, or null if none is set.
| Improve this Doc View Source

Title

Gets the title of this embed.

Declaration
public string Title { get; }
Property Value
Type Description
String

The title of the embed.
| Improve this Doc View Source

Type

Gets the type of this embed.

Declaration
public EmbedType Type { get; }
Property Value
Type Description
EmbedType

The type of the embed.
| Improve this Doc View Source

Url

Gets the title URL of this embed.

Declaration
public string Url { get; }
Property Value
Type Description
String

A string containing the URL set in a title of the embed.
| Improve this Doc View Source

Video

Gets the video of this embed.

Declaration
public EmbedVideo? Video { get; }
Property Value
Type Description
Nullable<EmbedVideo>

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

Methods

| Improve this Doc View Source

Equals(Embed)

Determines whether the specified Embed is equal to the current Embed

Declaration
public bool Equals(Embed embed)
Parameters
Type Name Description
Embed embed

The Embed to compare with the current Embed
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The object to compare with the current Embed
Returns
Type Description
Boolean
Remarks

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

| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
| Improve this Doc View Source

ToString()

Gets the title of the embed.

Declaration
public override string ToString()
Returns
Type Description
String

Operators

| Improve this Doc View Source

Equality(Embed, Embed)

Declaration
public static bool operator ==(Embed left, Embed right)
Parameters
Type Name Description
Embed left
Embed right
Returns
Type Description
Boolean
| Improve this Doc View Source

Inequality(Embed, Embed)

Declaration
public static bool operator !=(Embed left, Embed right)
Parameters
Type Name Description
Embed left
Embed right
Returns
Type Description
Boolean

Implements

Extension Methods