class LabelBuilder

export declare class LabelBuilder extends ComponentBuilder<APILabelComponent>

A builder that creates API-compatible JSON data for labels.

clearDescription
clearId
setChannelSelectMenuComponent
setDescription
setFileUploadComponent
setId
setLabel
setMentionableSelectMenuComponent
setRoleSelectMenuComponent
setStringSelectMenuComponent
setTextInputComponent
setUserSelectMenuComponent
toJSON

Constructors

constructor(
data?: Partial<APILabelComponent>
)

Creates a new label.

Examples:Creating a label from an API data object:
const label = new LabelBuilder({
	label: "label",
	component,
});
Creating a label using setters and API data:
const label = new LabelBuilder({
	label: 'label',
	component,
}).setContent('new text');

clearDescription() : this

Clears the description for this label.

clearId() : this

Clears the id of this component, defaulting to a default incremented id.

Inherited from: ComponentBuilder

setChannelSelectMenuComponent(
input: APIChannelSelectComponent | ChannelSelectMenuBuilder | ((builder: ChannelSelectMenuBuilder) => ChannelSelectMenuBuilder)
) : this

Sets a channel select menu component to this label.

setDescription(
description: string
) : this

Sets the description for this label.

setFileUploadComponent(
input: APIFileUploadComponent | FileUploadBuilder | ((builder: FileUploadBuilder) => FileUploadBuilder)
) : this

Sets a file upload component to this label.

setId(
id: number
) : this

Sets the id of this component.

Inherited from: ComponentBuilder

setLabel(
label: string
) : this

Sets the label for this label.

setMentionableSelectMenuComponent(
input: APIMentionableSelectComponent | MentionableSelectMenuBuilder | ((builder: MentionableSelectMenuBuilder) => MentionableSelectMenuBuilder)
) : this

Sets a mentionable select menu component to this label.

setRoleSelectMenuComponent(
input: APIRoleSelectComponent | RoleSelectMenuBuilder | ((builder: RoleSelectMenuBuilder) => RoleSelectMenuBuilder)
) : this

Sets a role select menu component to this label.

setStringSelectMenuComponent(
input: APIStringSelectComponent | StringSelectMenuBuilder | ((builder: StringSelectMenuBuilder) => StringSelectMenuBuilder)
) : this

Sets a string select menu component to this label.

setTextInputComponent(
input: APITextInputComponent | TextInputBuilder | ((builder: TextInputBuilder) => TextInputBuilder)
) : this

Sets a text input component to this label.

setUserSelectMenuComponent(
input: APIUserSelectComponent | UserSelectMenuBuilder | ((builder: UserSelectMenuBuilder) => UserSelectMenuBuilder)
) : this

Sets a user select menu component to this label.

toJSON(
validationOverride?: boolean
) : APILabelComponent

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.