Class ChannelMenuProperties

Namespace

NetCord.Rest

Assembly

NetCord.dll

public class ChannelMenuProperties : EntityMenuProperties, IComponentProperties, IJsonSerializable

Inheritance

object

MenuProperties

EntityMenuProperties

ChannelMenuProperties

Implements

IComponentProperties

IJsonSerializable

Inherited Members

MenuProperties.Id

MenuProperties.CustomId

MenuProperties.Placeholder

MenuProperties.MinValues

MenuProperties.MaxValues

MenuProperties.Disabled

MenuProperties.ParentId

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ChannelMenuProperties(string)

public ChannelMenuProperties(string customId)

Parameters

customId string

ID for the menu (max 100 characters).

Properties

ChannelTypes

List of channel types to include in the menu.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("channel_types")]
public IEnumerable<ChannelType>? ChannelTypes { get; set; }

Property Value

IEnumerable<ChannelType>

ComponentType

Type of the component.

public override ComponentType ComponentType { get; }

Property Value

ComponentType

DefaultValues

Default values for auto-populated select menu components.

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

Property Value

IEnumerable<ulong>

Methods

AddChannelTypes(params IEnumerable<ChannelType>)

List of channel types to include in the menu.

public ChannelMenuProperties AddChannelTypes(params IEnumerable<ChannelType> channelTypes)

Parameters

channelTypes IEnumerable<ChannelType>

Returns

ChannelMenuProperties

AddDefaultValues(params IEnumerable<ulong>)

Default values for auto-populated select menu components.

public ChannelMenuProperties AddDefaultValues(params IEnumerable<ulong> defaultValues)

Parameters

defaultValues IEnumerable<ulong>

Returns

ChannelMenuProperties

WithChannelTypes(IEnumerable<ChannelType>?)

List of channel types to include in the menu.

public ChannelMenuProperties WithChannelTypes(IEnumerable<ChannelType>? channelTypes)

Parameters

channelTypes IEnumerable<ChannelType>

Returns

ChannelMenuProperties

WithCustomId(string)

ID for the menu (max 100 characters).

public ChannelMenuProperties WithCustomId(string customId)

Parameters

customId string

Returns

ChannelMenuProperties

WithDefaultValues(IEnumerable<ulong>?)

Default values for auto-populated select menu components.

public ChannelMenuProperties WithDefaultValues(IEnumerable<ulong>? defaultValues)

Parameters

defaultValues IEnumerable<ulong>

Returns

ChannelMenuProperties

WithDisabled(bool)

Whether the menu is disabled.

public ChannelMenuProperties WithDisabled(bool disabled = true)

Parameters

disabled bool

Returns

ChannelMenuProperties

WithId(int?)

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

public ChannelMenuProperties WithId(int? id)

Parameters

id int?

Returns

ChannelMenuProperties

WithMaxValues(int?)

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

public ChannelMenuProperties WithMaxValues(int? maxValues)

Parameters

maxValues int?

Returns

ChannelMenuProperties

WithMinValues(int?)

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

public ChannelMenuProperties WithMinValues(int? minValues)

Parameters

minValues int?

Returns

ChannelMenuProperties

WithParentId(int?)

public ChannelMenuProperties WithParentId(int? parentId)

Parameters

parentId int?

Returns

ChannelMenuProperties

WithPlaceholder(string?)

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

public ChannelMenuProperties WithPlaceholder(string? placeholder)

Parameters

placeholder string

Returns

ChannelMenuProperties

WriteTo(Utf8JsonWriter)

public override void WriteTo(Utf8JsonWriter writer)

Parameters

writer Utf8JsonWriter