Class StringMenuProperties

Namespace

NetCord.Rest

Assembly

NetCord.dll

public class StringMenuProperties : MenuProperties, IInteractiveComponentProperties, IMessageComponentProperties, IJsonSerializable<IMessageComponentProperties>, IComponentContainerComponentProperties, IJsonSerializable<IComponentContainerComponentProperties>, ILabelComponentProperties, IJsonSerializable<ILabelComponentProperties>, IComponentProperties, IEnumerable<StringMenuSelectOptionProperties>, IEnumerable

Inheritance

object

MenuProperties

StringMenuProperties

Implements

IInteractiveComponentProperties

IMessageComponentProperties

IJsonSerializable<IMessageComponentProperties>

IComponentContainerComponentProperties

IJsonSerializable<IComponentContainerComponentProperties>

ILabelComponentProperties

IJsonSerializable<ILabelComponentProperties>

IComponentProperties

IEnumerable<StringMenuSelectOptionProperties>

IEnumerable

Inherited Members

MenuProperties.Id

MenuProperties.CustomId

MenuProperties.Placeholder

MenuProperties.MinValues

MenuProperties.MaxValues

MenuProperties.Disabled

MenuProperties.Required

MenuProperties.ParentId

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StringMenuProperties(string)

public StringMenuProperties(string customId)

Parameters

customId string

StringMenuProperties(string, IEnumerable<StringMenuSelectOptionProperties>)

public StringMenuProperties(string customId, IEnumerable<StringMenuSelectOptionProperties> options)

Parameters

customId string

options IEnumerable<StringMenuSelectOptionProperties>

Properties

ComponentType

Type of the component.

public override ComponentType ComponentType { get; }

Property Value

ComponentType

Options

public IEnumerable<StringMenuSelectOptionProperties> Options { get; set; }

Property Value

IEnumerable<StringMenuSelectOptionProperties>

Methods

AddOptions(params IEnumerable<StringMenuSelectOptionProperties>)

public StringMenuProperties AddOptions(params IEnumerable<StringMenuSelectOptionProperties> options)

Parameters

options IEnumerable<StringMenuSelectOptionProperties>

Returns

StringMenuProperties

WithCustomId(string)

Developer-defined identifier for the component (max 100 characters).

public StringMenuProperties WithCustomId(string customId)

Parameters

customId string

Returns

StringMenuProperties

WithDisabled(bool)

Whether the menu is disabled.

public StringMenuProperties WithDisabled(bool disabled = true)

Parameters

disabled bool

Returns

StringMenuProperties

WithId(int?)

Unique identifier for the component. Auto populated through increment if not provided.

public StringMenuProperties WithId(int? id)

Parameters

id int?

Returns

StringMenuProperties

WithMaxValues(int?)

Maximum number of items that can be chosen, default 1 (max 25).

public StringMenuProperties WithMaxValues(int? maxValues)

Parameters

maxValues int?

Returns

StringMenuProperties

WithMinValues(int?)

Minimum number of items that must be chosen, default 1 (0-25).

public StringMenuProperties WithMinValues(int? minValues)

Parameters

minValues int?

Returns

StringMenuProperties

WithOptions(IEnumerable<StringMenuSelectOptionProperties>)

public StringMenuProperties WithOptions(IEnumerable<StringMenuSelectOptionProperties> options)

Parameters

options IEnumerable<StringMenuSelectOptionProperties>

Returns

StringMenuProperties

WithParentId(int?)

public StringMenuProperties WithParentId(int? parentId)

Parameters

parentId int?

Returns

StringMenuProperties

WithPlaceholder(string?)

Placeholder text if nothing is selected (max 150 characters).

public StringMenuProperties WithPlaceholder(string? placeholder)

Parameters

placeholder string

Returns

StringMenuProperties

WithRequired(bool?)

Whether the menu is required to answer in a modal. Defaults to true.

public StringMenuProperties WithRequired(bool? required = true)

Parameters

required bool?

Returns

StringMenuProperties