Class UserMenuProperties

Namespace

NetCord.Rest

Assembly

NetCord.dll

public class UserMenuProperties : EntityMenuProperties, IInteractiveComponentProperties, IMessageComponentProperties, IJsonSerializable<IMessageComponentProperties>, IComponentContainerComponentProperties, IJsonSerializable<IComponentContainerComponentProperties>, ILabelComponentProperties, IComponentProperties, IJsonSerializable<ILabelComponentProperties>

Inheritance

object

MenuProperties

EntityMenuProperties

UserMenuProperties

Implements

IInteractiveComponentProperties

IMessageComponentProperties

IJsonSerializable<IMessageComponentProperties>

IComponentContainerComponentProperties

IJsonSerializable<IComponentContainerComponentProperties>

ILabelComponentProperties

IComponentProperties

IJsonSerializable<ILabelComponentProperties>

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

UserMenuProperties(string)

public UserMenuProperties(string customId)

Parameters

customId string

Properties

ComponentType

Type of the component.

public override ComponentType ComponentType { get; }

Property Value

ComponentType

DefaultValues

Default values for auto-populated select menu components.

[JsonConverter(typeof(UserMenuProperties.DefaultValuesConverter))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("default_values")]
public IEnumerable<ulong>? DefaultValues { get; set; }

Property Value

IEnumerable<ulong>

Methods

AddDefaultValues(params IEnumerable<ulong>)

Default values for auto-populated select menu components.

public UserMenuProperties AddDefaultValues(params IEnumerable<ulong> defaultValues)

Parameters

defaultValues IEnumerable<ulong>

Returns

UserMenuProperties

WithCustomId(string)

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

public UserMenuProperties WithCustomId(string customId)

Parameters

customId string

Returns

UserMenuProperties

WithDefaultValues(IEnumerable<ulong>?)

Default values for auto-populated select menu components.

public UserMenuProperties WithDefaultValues(IEnumerable<ulong>? defaultValues)

Parameters

defaultValues IEnumerable<ulong>

Returns

UserMenuProperties

WithDisabled(bool)

Whether the menu is disabled.

public UserMenuProperties WithDisabled(bool disabled = true)

Parameters

disabled bool

Returns

UserMenuProperties

WithId(int?)

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

public UserMenuProperties WithId(int? id)

Parameters

id int?

Returns

UserMenuProperties

WithMaxValues(int?)

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

public UserMenuProperties WithMaxValues(int? maxValues)

Parameters

maxValues int?

Returns

UserMenuProperties

WithMinValues(int?)

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

public UserMenuProperties WithMinValues(int? minValues)

Parameters

minValues int?

Returns

UserMenuProperties

WithParentId(int?)

public UserMenuProperties WithParentId(int? parentId)

Parameters

parentId int?

Returns

UserMenuProperties

WithPlaceholder(string?)

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

public UserMenuProperties WithPlaceholder(string? placeholder)

Parameters

placeholder string

Returns

UserMenuProperties

WithRequired(bool?)

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

public UserMenuProperties WithRequired(bool? required = true)

Parameters

required bool?

Returns

UserMenuProperties