Class ComponentContainerExtensions

Namespace

Discord

Assembly

Discord.Net.Core.dll

public static class ComponentContainerExtensions

Inheritance

object

ComponentContainerExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ComponentCount(IComponentContainer)

Gets the total number of components in this and all child IComponentContainers combined.

public static int ComponentCount(this IComponentContainer container)

Parameters

container IComponentContainer

Returns

int

FindComponentById(IComponentContainer, int)

Finds the first IMessageComponentBuilder in the IComponentContainer or any of its child IComponentContainers with matching id.

public static IMessageComponentBuilder FindComponentById(this IComponentContainer container, int id)

Parameters

container IComponentContainer

id int

Returns

IMessageComponentBuilder

The IMessageComponentBuilder with matching id, null otherwise.

FindComponentById(INestedComponent, int)

Finds the first IMessageComponent in the INestedComponent or any of its child INestedComponents with matching id.

public static IMessageComponent FindComponentById(this INestedComponent container, int id)

Parameters

container INestedComponent

id int

Returns

IMessageComponent

The IMessageComponent with matching id, null otherwise.

FindComponentById(IEnumerable<IMessageComponent>, int)

Finds the first IMessageComponent in the IEnumerable<T> or any of its child INestedComponents with matching id.

public static IMessageComponent FindComponentById(this IEnumerable<IMessageComponent> components, int id)

Parameters

components IEnumerable<IMessageComponent>

id int

Returns

IMessageComponent

The IMessageComponent with matching id, null otherwise.

FindComponentById<ComponentT>(IComponentContainer, int)

Finds the first ComponentT in the IComponentContainer or any of its child IComponentContainers with matching id.

public static ComponentT FindComponentById<ComponentT>(this IComponentContainer container, int id) where ComponentT : class, IMessageComponentBuilder

Parameters

container IComponentContainer

id int

Returns

ComponentT

The ComponentT with matching id, null otherwise.

Type Parameters

ComponentT

FindComponentById<ComponentT>(INestedComponent, int)

Finds the first ComponentT in the INestedComponent or any of its child INestedComponents with matching id.

public static ComponentT FindComponentById<ComponentT>(this INestedComponent container, int id) where ComponentT : class, IMessageComponent

Parameters

container INestedComponent

id int

Returns

ComponentT

The ComponentT with matching id, null otherwise.

Type Parameters

ComponentT

FindComponentById<ComponentT>(IEnumerable<IMessageComponent>, int)

Finds the first ComponentT in the IEnumerable<T> or any of its child INestedComponents with matching id.

public static ComponentT FindComponentById<ComponentT>(this IEnumerable<IMessageComponent> components, int id) where ComponentT : class, IMessageComponent

Parameters

components IEnumerable<IMessageComponent>

id int

Returns

ComponentT

The ComponentT with matching id, null otherwise.

Type Parameters

ComponentT

GetComponentIds(IComponentContainer)

Gets a IEnumerable containing ids of IMessageComponentBuilder in this IComponentContainer and all child IComponentContainers.

public static IEnumerable<int> GetComponentIds(this IComponentContainer container)

Parameters

container IComponentContainer

Returns

IEnumerable<int>

WithActionRow<BuilderT>(BuilderT, ActionRowBuilder)

Adds a ActionRowBuilder to the container.

public static BuilderT WithActionRow<BuilderT>(this BuilderT container, ActionRowBuilder actionRow) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

actionRow ActionRowBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithActionRow<BuilderT>(BuilderT, Action<ActionRowBuilder>)

Adds a SectionBuilder to the container.

public static BuilderT WithActionRow<BuilderT>(this BuilderT container, Action<ActionRowBuilder> options) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

options Action<ActionRowBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithActionRow<BuilderT>(BuilderT, IEnumerable<IMessageComponentBuilder>, int?)

Adds a ActionRowBuilder to the container.

public static BuilderT WithActionRow<BuilderT>(this BuilderT container, IEnumerable<IMessageComponentBuilder> components, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

components IEnumerable<IMessageComponentBuilder>

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithButton<BuilderT>(BuilderT, ButtonBuilder)

Adds a ButtonBuilder to the container.

public static BuilderT WithButton<BuilderT>(this BuilderT container, ButtonBuilder button) where BuilderT : class, IInteractableComponentContainer

Parameters

container BuilderT

button ButtonBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithButton<BuilderT>(BuilderT, Action<ButtonBuilder>)

Adds a ButtonBuilder to the container.

public static BuilderT WithButton<BuilderT>(this BuilderT container, Action<ButtonBuilder> options) where BuilderT : class, IInteractableComponentContainer

Parameters

container BuilderT

options Action<ButtonBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithButton<BuilderT>(BuilderT, string, string, ButtonStyle, IEmote, string, bool, ulong?, int?)

Adds a ButtonBuilder to the container.

public static BuilderT WithButton<BuilderT>(this BuilderT container, string label = null, string customId = null, ButtonStyle style = ButtonStyle.Primary, IEmote emote = null, string url = null, bool disabled = false, ulong? skuId = null, int? id = null) where BuilderT : class, IInteractableComponentContainer

Parameters

container BuilderT

label string

customId string

style ButtonStyle

emote IEmote

url string

disabled bool

skuId ulong?

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithContainer<BuilderT>(BuilderT, ContainerBuilder)

Adds a ContainerBuilder to the container.

public static BuilderT WithContainer<BuilderT>(this BuilderT container, ContainerBuilder containerComponent) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

containerComponent ContainerBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithContainer<BuilderT>(BuilderT, params IMessageComponentBuilder[])

Adds a ContainerBuilder to the container.

public static BuilderT WithContainer<BuilderT>(this BuilderT container, params IMessageComponentBuilder[] components) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

components IMessageComponentBuilder[]

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithContainer<BuilderT>(BuilderT, Action<ContainerBuilder>)

Adds a ContainerBuilder to the container.

public static BuilderT WithContainer<BuilderT>(this BuilderT container, Action<ContainerBuilder> options) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

options Action<ContainerBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithContainer<BuilderT>(BuilderT, IEnumerable<IMessageComponentBuilder>, Color?, bool, int?)

Adds a ContainerBuilder to the container.

public static BuilderT WithContainer<BuilderT>(this BuilderT container, IEnumerable<IMessageComponentBuilder> components, Color? accentColor = null, bool isSpoiler = false, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

components IEnumerable<IMessageComponentBuilder>

accentColor Color?

isSpoiler bool

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithFile<BuilderT>(BuilderT, FileComponentBuilder)

Adds a FileComponentBuilder to the container.

public static BuilderT WithFile<BuilderT>(this BuilderT container, FileComponentBuilder file) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

file FileComponentBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithFile<BuilderT>(BuilderT, UnfurledMediaItemProperties, bool, int?)

Adds a FileComponentBuilder to the container.

public static BuilderT WithFile<BuilderT>(this BuilderT container, UnfurledMediaItemProperties file, bool isSpoiler = false, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

file UnfurledMediaItemProperties

isSpoiler bool

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithFile<BuilderT>(BuilderT, Action<FileComponentBuilder>)

Adds a FileComponentBuilder to the container.

public static BuilderT WithFile<BuilderT>(this BuilderT container, Action<FileComponentBuilder> options) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

options Action<FileComponentBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithMediaGallery<BuilderT>(BuilderT, MediaGalleryBuilder)

Adds a MediaGalleryBuilder to the container.

public static BuilderT WithMediaGallery<BuilderT>(this BuilderT container, MediaGalleryBuilder mediaGallery) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

mediaGallery MediaGalleryBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithMediaGallery<BuilderT>(BuilderT, Action<MediaGalleryBuilder>)

Adds a MediaGalleryBuilder to the container.

public static BuilderT WithMediaGallery<BuilderT>(this BuilderT container, Action<MediaGalleryBuilder> options) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

options Action<MediaGalleryBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithMediaGallery<BuilderT>(BuilderT, IEnumerable<MediaGalleryItemProperties>, int?)

Adds a MediaGalleryBuilder to the container.

public static BuilderT WithMediaGallery<BuilderT>(this BuilderT container, IEnumerable<MediaGalleryItemProperties> items, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

items IEnumerable<MediaGalleryItemProperties>

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithMediaGallery<BuilderT>(BuilderT, IEnumerable<string>, int?)

Adds a MediaGalleryBuilder to the container.

public static BuilderT WithMediaGallery<BuilderT>(this BuilderT container, IEnumerable<string> urls, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

urls IEnumerable<string>

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSection<BuilderT>(BuilderT, SectionBuilder)

Adds a SectionBuilder to the container.

public static BuilderT WithSection<BuilderT>(this BuilderT container, SectionBuilder section) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

section SectionBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSection<BuilderT>(BuilderT, Action<SectionBuilder>)

Adds a SectionBuilder to the container.

public static BuilderT WithSection<BuilderT>(this BuilderT container, Action<SectionBuilder> options) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

options Action<SectionBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSection<BuilderT>(BuilderT, IEnumerable<TextDisplayBuilder>, IMessageComponentBuilder, bool, int?)

Adds a SectionBuilder to the container.

public static BuilderT WithSection<BuilderT>(this BuilderT container, IEnumerable<TextDisplayBuilder> components, IMessageComponentBuilder accessory, bool isSpoiler = false, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

components IEnumerable<TextDisplayBuilder>

accessory IMessageComponentBuilder

isSpoiler bool

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSelectMenu<BuilderT>(BuilderT, SelectMenuBuilder)

Adds a SelectMenuBuilder to the container.

public static BuilderT WithSelectMenu<BuilderT>(this BuilderT container, SelectMenuBuilder selectMenu) where BuilderT : class, IInteractableComponentContainer

Parameters

container BuilderT

selectMenu SelectMenuBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSelectMenu<BuilderT>(BuilderT, Action<SelectMenuBuilder>)

Adds a ButtonBuilder to the container.

public static BuilderT WithSelectMenu<BuilderT>(this BuilderT container, Action<SelectMenuBuilder> options) where BuilderT : class, IInteractableComponentContainer

Parameters

container BuilderT

options Action<SelectMenuBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSelectMenu<BuilderT>(BuilderT, string, List<SelectMenuOptionBuilder>, string, int, int, bool, int, ComponentType, ChannelType[], SelectMenuDefaultValue[], int?)

Adds a SelectMenuBuilder to the container.

public static BuilderT WithSelectMenu<BuilderT>(this BuilderT container, string customId, List<SelectMenuOptionBuilder> options = null, string placeholder = null, int minValues = 1, int maxValues = 1, bool disabled = false, int row = 0, ComponentType type = ComponentType.SelectMenu, ChannelType[] channelTypes = null, SelectMenuDefaultValue[] defaultValues = null, int? id = null) where BuilderT : class, IInteractableComponentContainer

Parameters

container BuilderT

customId string

options List<SelectMenuOptionBuilder>

placeholder string

minValues int

maxValues int

disabled bool

row int

type ComponentType

channelTypes ChannelType[]

defaultValues SelectMenuDefaultValue[]

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSeparator<BuilderT>(BuilderT, SeparatorBuilder)

Adds a SeparatorBuilder to the container.

public static BuilderT WithSeparator<BuilderT>(this BuilderT container, SeparatorBuilder separator) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

separator SeparatorBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSeparator<BuilderT>(BuilderT, SeparatorSpacingSize, bool, int?)

Adds a SeparatorBuilder to the container.

public static BuilderT WithSeparator<BuilderT>(this BuilderT container, SeparatorSpacingSize spacing = SeparatorSpacingSize.Small, bool isDivider = true, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

spacing SeparatorSpacingSize

isDivider bool

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithSeparator<BuilderT>(BuilderT, Action<SeparatorBuilder>)

Adds a SeparatorBuilder to the container.

public static BuilderT WithSeparator<BuilderT>(this BuilderT container, Action<SeparatorBuilder> options) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

options Action<SeparatorBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithTextDisplay<BuilderT>(BuilderT, TextDisplayBuilder)

Adds a TextDisplayBuilder to the container.

public static BuilderT WithTextDisplay<BuilderT>(this BuilderT container, TextDisplayBuilder textDisplay) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

textDisplay TextDisplayBuilder

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithTextDisplay<BuilderT>(BuilderT, Action<TextDisplayBuilder>)

Adds a TextDisplayBuilder to the container.

public static BuilderT WithTextDisplay<BuilderT>(this BuilderT container, Action<TextDisplayBuilder> options) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

options Action<TextDisplayBuilder>

Returns

BuilderT

The current container.

Type Parameters

BuilderT

WithTextDisplay<BuilderT>(BuilderT, string, int?)

Adds a TextDisplayBuilder to the container.

public static BuilderT WithTextDisplay<BuilderT>(this BuilderT container, string content, int? id = null) where BuilderT : class, IStaticComponentContainer

Parameters

container BuilderT

content string

id int?

Returns

BuilderT

The current container.

Type Parameters

BuilderT