Class LabelBuilder

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

Hierarchy (View Summary)

ComponentBuilder<LabelBuilderData>
- LabelBuilder

Index

Constructors

Methods

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

Constructors

constructor

new LabelBuilder(data?: Partial<APILabelComponent>): LabelBuilder
Creates a new label.
Parameters
- Optionaldata: Partial<APILabelComponent>
  The API data to create this label with
Returns LabelBuilder
Example
Creating a label from an API data object:
```
const label = new LabelBuilder({
	label: "label",
	component,
});
```
Example
Creating a label using setters and API data:
```
const label = new LabelBuilder({
	label: 'label',
	component,
}).setLabel('new text');
```
Overrides ComponentBuilder.constructor
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1073

Methods

clearDescription

clearDescription(): this
Clears the description for this label.

Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1089

clearId

clearId(): this
Clears the id of this component, defaulting to a default incremented id.

Returns this
Inherited from ComponentBuilder.clearId
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:455

setChannelSelectMenuComponent

setChannelSelectMenuComponent(
    input:
        | APIChannelSelectComponent
        | ChannelSelectMenuBuilder
        | ((builder: ChannelSelectMenuBuilder) => ChannelSelectMenuBuilder),
): this
Sets a channel select menu component to this label.
Parameters
- input:
      | APIChannelSelectComponent
      | ChannelSelectMenuBuilder
      | ((builder: ChannelSelectMenuBuilder) => ChannelSelectMenuBuilder)
  A function that returns a component builder or an already built builder
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1119

setDescription

setDescription(description: string): this
Sets the description for this label.
Parameters
- description: string
  The description to use
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1085

setId

setId(id: number): this
Sets the id (not the custom id) for this component.
Parameters
- id: number
  The id for this component
Returns this
Inherited from ComponentBuilder.setId
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:451

setLabel

setLabel(label: string): this
Sets the label for this label.
Parameters
- label: string
  The label to use
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1079

setMentionableSelectMenuComponent

setMentionableSelectMenuComponent(
    input:
        | APIMentionableSelectComponent
        | MentionableSelectMenuBuilder
        | (
            (
                builder: MentionableSelectMenuBuilder,
            ) => MentionableSelectMenuBuilder
        ),
): this
Sets a mentionable select menu component to this label.
Parameters
- input:
      | APIMentionableSelectComponent
      | MentionableSelectMenuBuilder
      | ((builder: MentionableSelectMenuBuilder) => MentionableSelectMenuBuilder)
  A function that returns a component builder or an already built builder
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1113

setRoleSelectMenuComponent

setRoleSelectMenuComponent(
    input:
        | APIRoleSelectComponent
        | RoleSelectMenuBuilder
        | ((builder: RoleSelectMenuBuilder) => RoleSelectMenuBuilder),
): this
Sets a role select menu component to this label.
Parameters
- input:
      | APIRoleSelectComponent
      | RoleSelectMenuBuilder
      | ((builder: RoleSelectMenuBuilder) => RoleSelectMenuBuilder)
  A function that returns a component builder or an already built builder
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1107

setStringSelectMenuComponent

setStringSelectMenuComponent(
    input:
        | APIStringSelectComponent
        | SelectMenuBuilder
        | ((builder: SelectMenuBuilder) => SelectMenuBuilder),
): this
Sets a string select menu component to this label.
Parameters
- input:
      | APIStringSelectComponent
      | SelectMenuBuilder
      | ((builder: SelectMenuBuilder) => SelectMenuBuilder)
  A function that returns a component builder or an already built builder
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1095

setTextInputComponent

setTextInputComponent(
    input:
        | APITextInputComponent
        | TextInputBuilder
        | ((builder: TextInputBuilder) => TextInputBuilder),
): this
Sets a text input component to this label.
Parameters
- input:
      | APITextInputComponent
      | TextInputBuilder
      | ((builder: TextInputBuilder) => TextInputBuilder)
  A function that returns a component builder or an already built builder
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1125

setUserSelectMenuComponent

setUserSelectMenuComponent(
    input:
        | APIUserSelectComponent
        | UserSelectMenuBuilder
        | ((builder: UserSelectMenuBuilder) => UserSelectMenuBuilder),
): this
Sets a user select menu component to this label.
Parameters
- input:
      | APIUserSelectComponent
      | UserSelectMenuBuilder
      | ((builder: UserSelectMenuBuilder) => UserSelectMenuBuilder)
  A function that returns a component builder or an already built builder
Returns this
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1101

toJSON

toJSON(): APILabelComponent
Serializes this builder to API-compatible JSON data.

Returns APILabelComponent
Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.
Overrides ComponentBuilder.toJSON
- Defined in node_modules/@discordjs/builders/dist/index.d.mts:1129

Class LabelBuilder

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LabelBuilder

Example

Example

Methods

clearDescription

Returns this

clearId

Returns this

setChannelSelectMenuComponent

Parameters

Returns this

setDescription

Parameters

Returns this

setId

Parameters

Returns this

setLabel

Parameters

Returns this

setMentionableSelectMenuComponent

Parameters

Returns this

setRoleSelectMenuComponent

Parameters

Returns this

setStringSelectMenuComponent

Parameters

Returns this

setTextInputComponent

Parameters

Returns this

setUserSelectMenuComponent

Parameters

Returns this

toJSON

Returns APILabelComponent

Remarks

Settings

On This Page