Class UserSelectMenuInteraction

Represents a ComponentType.UserSelect select menu interaction.

Hierarchy (View Summary)

MessageComponentInteraction
- UserSelectMenuInteraction

Constructors

constructor

new UserSelectMenuInteraction(
client: default,
data: APIMessageComponentInteraction,
): UserSelectMenuInteraction
Parameters
- client: default
- data: APIMessageComponentInteraction
Returns UserSelectMenuInteraction
Overrides MessageComponentInteraction.constructor
- Defined in src/structures/Interaction/MessageComponentInteraction/Select/UserSelectComponent.ts:33

Properties

applicationId

applicationId: string

The ID of the application (bot) this interaction is for.

appPermissions

appPermissions: Readonly<BitField>

The permissions the application (bot) has in the interaction's channel.

attachmentSizeLimit

attachmentSizeLimit: number

Maximum attachment size allowed for this interaction (in bytes).

authorizingIntegrationOwners

authorizingIntegrationOwners: APIAuthorizingIntegrationOwnersMap

channelId

channelId: null | string

The ID of the channel this interaction was sent in.

`Readonly`client

client: any

The client instance associated with this interaction. (Injected from REST in constructor; should point to your bot client)

`Readonly`componentType

componentType: number

The type of component which was interacted with

context

context: null | number

The context in which this interaction was triggered (e.g., direct message, command, etc.).

`Readonly`customId

customId: string

The custom id of the component which was interacted with

deferred

deferred: boolean = false

Whether the reply to this interaction has been deferred

entitlements

entitlements: APIEntitlement[]

ephemeral

ephemeral: null | boolean = null

Whether the reply to this interaction is ephemeral

guildId

guildId: null | string

The ID of the guild this interaction was sent in (if applicable).

guildLocale

guildLocale: null | Locale

The preferred locale of the guild, if the interaction was in a guild.

id

id: string

The interaction's unique ID.

locale

locale: Locale

The locale of the user invoking the interaction (e.g., "en-US").

member

member: null | APIInteractionGuildMember

The guild member who invoked this interaction (if in a guild).

memberPermissions

memberPermissions: null | Readonly<BitField<Record<string, number>, number>>

The permissions the invoking member has in the interaction's channel.

members

members: Collection<string, APIInteractionDataResolvedGuildMember> = ...

Collection of the selected members

`Readonly`message

message: APIMessage

The message to which the component was attached

replied

replied: boolean = false

Whether this interaction has already been replied to

`Readonly`token

token: string

The interaction token used for responding.

type

type: InteractionType

The interaction's type.

user

user: APIUser

The user who invoked this interaction.

users

users: Collection<string, APIUser> = ...

Collection of the selected users

values

values: string[]

An array of the selected user ids

version

version: number

The interaction protocol version.

`Readonly`webhook

webhook: InteractionWebhook

An associated interaction webhook, can be used to further interact with this interaction

Accessors

component

get component(): APIComponentInMessageActionRow | MessageActionRowComponent
The component which was interacted with

Returns APIComponentInMessageActionRow | MessageActionRowComponent
Inherited from MessageComponentInteraction.component
- Defined in src/structures/Interaction/MessageComponentInteraction/Base.ts:73

createdAt

get createdAt(): Date
The time the interaction was created at

Returns Date
Inherited from MessageComponentInteraction.createdAt
- Defined in src/structures/Interaction/BaseInterction.ts:225

createdTimestamp

get createdTimestamp(): number
The timestamp the interaction was created at

Returns number
Inherited from MessageComponentInteraction.createdTimestamp
- Defined in src/structures/Interaction/BaseInterction.ts:217

Methods

deferReply

deferReply(
    options?: Omit<
        djs.InteractionDeferReplyOptions,
        "ephemeral"
        | "fetchReply"
        | "withResponse",
    >,
): void
Parameters
- options: Omit<
      djs.InteractionDeferReplyOptions,
      "ephemeral"
      | "fetchReply"
      | "withResponse",
  > = {}
Returns void
Inherited from MessageComponentInteraction.deferReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:82

deferUpdate

deferUpdate(
options: InteractionDeferUpdateOptions & { withResponse: true },
): Promise<InteractionCallbackResponse>
Parameters
- options: InteractionDeferUpdateOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse>
Inherited from MessageComponentInteraction.deferUpdate
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:347
deferUpdate(
options: InteractionDeferUpdateOptions & { withResponse?: false },
): Promise<undefined>
Parameters
- options: InteractionDeferUpdateOptions & { withResponse?: false }
Returns Promise<undefined>
Inherited from MessageComponentInteraction.deferUpdate
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:350

deleteReply

deleteReply(message?: string): Promise<void>
Parameters
- message: string = "@original"
Returns Promise<void>
Inherited from MessageComponentInteraction.deleteReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:238

editReply

editReply(
options: string | MessagePayload | InteractionEditReplyOptions,
): Promise<APIMessage>
Parameters
- options: string | MessagePayload | InteractionEditReplyOptions
  The new options for the message
Returns Promise<APIMessage>
Inherited from MessageComponentInteraction.editReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:214

fetchReply

fetchReply(message?: string): Promise<APIMessage>
Parameters
- message: string = "@original"
Returns Promise<APIMessage>
Inherited from MessageComponentInteraction.fetchReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:202

followUp

followUp(
options: { withResponse: true } & InteractionReplyOptions,
): Promise<APIMessage>
Send a follow-up message to this interaction.
Parameters
- options: { withResponse: true } & InteractionReplyOptions
  The options for the reply
Returns Promise<APIMessage>
Inherited from MessageComponentInteraction.followUp
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:252
followUp(
options: string | InteractionReplyOptions & { withResponse?: false },
): Promise<undefined>
Send a follow-up message to this interaction.
Parameters
- options: string | InteractionReplyOptions & { withResponse?: false }
  The options for the reply
Returns Promise<undefined>
Inherited from MessageComponentInteraction.followUp
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:255

inGuild

inGuild(): boolean
Indicates whether this interaction is received from a guild.

Returns boolean
Inherited from MessageComponentInteraction.inGuild
- Defined in src/structures/Interaction/BaseInterction.ts:232

launchActivity

launchActivity(
options: LaunchActivityOptions & { withResponse: true },
): Promise<InteractionCallbackResponse>
Parameters
- options: LaunchActivityOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse>
Inherited from MessageComponentInteraction.launchActivity
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:273
launchActivity(
options: LaunchActivityOptions & { withResponse?: false },
): Promise<undefined>
Parameters
- options: LaunchActivityOptions & { withResponse?: false }
Returns Promise<undefined>
Inherited from MessageComponentInteraction.launchActivity
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:276

reply

reply(
options: string | InteractionReplyOptions & { withResponse?: false },
): Promise<undefined>
Creates a reply to this interaction.
Parameters
- options: string | InteractionReplyOptions & { withResponse?: false }
Returns Promise<undefined>
Remarks
Use the withResponse option to get the interaction callback response if a response has already been sent.
Example
```
await interaction.reply("Hello world!");
```
Inherited from MessageComponentInteraction.reply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:121
reply(
options: string | InteractionReplyOptions & { withResponse: true },
): Promise<InteractionCallbackResponse>
Creates a reply to this interaction.
Parameters
- options: string | InteractionReplyOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse>
Remarks
Use the withResponse option to get the interaction callback response if a response has already been sent.
Example
```
await interaction.reply("Hello world!");
```
Inherited from MessageComponentInteraction.reply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:124

showModal

showModal(
    modal:
        | ModalBuilder
        | APIModalInteractionResponseCallbackData
        | ModalComponentData,
    options: ShowModalOptions & { withResposne: true },
): Promise<undefined>
Parameters
- modal: ModalBuilder | APIModalInteractionResponseCallbackData | ModalComponentData
- options: ShowModalOptions & { withResposne: true }
Returns Promise<undefined>
Inherited from MessageComponentInteraction.showModal
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:465
showModal(
    modal:
        | ModalBuilder
        | APIModalInteractionResponseCallbackData
        | ModalComponentData,
    options: ShowModalOptions & { withResponse?: false },
): Promise<InteractionCallbackResponse>
Parameters
- modal: ModalBuilder | APIModalInteractionResponseCallbackData | ModalComponentData
- options: ShowModalOptions & { withResponse?: false }
Returns Promise<InteractionCallbackResponse>
Inherited from MessageComponentInteraction.showModal
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:472

update

update(
options: string | BaseMessageOptionsWithPoll & { withResponse?: false },
): Promise<undefined>
Creates a reply to this interaction.
Parameters
- options: string | BaseMessageOptionsWithPoll & { withResponse?: false }
Returns Promise<undefined>
Remarks
Use the withResponse option to get the interaction callback response if a response has already been sent.
Inherited from MessageComponentInteraction.update
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:392
update(
options: string | BaseMessageOptionsWithPoll & { withResponse: true },
): Promise<InteractionCallbackResponse>
Creates a reply to this interaction.
Parameters
- options: string | BaseMessageOptionsWithPoll & { withResponse: true }
Returns Promise<InteractionCallbackResponse>
Remarks
Use the withResponse option to get the interaction callback response if a response has already been sent.
Inherited from MessageComponentInteraction.update
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:395

Class UserSelectMenuInteraction

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UserSelectMenuInteraction

Properties

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channelId

Readonlyclient

ReadonlycomponentType

context

ReadonlycustomId

deferred

entitlements

ephemeral

guildId

guildLocale

id

locale

member

memberPermissions

members

Readonlymessage

replied

Readonlytoken

type

user

users

values

version

Readonlywebhook

Accessors

component

Returns APIComponentInMessageActionRow | MessageActionRowComponent

createdAt

Returns Date

createdTimestamp

Returns number

Methods

deferReply

Parameters

Returns void

deferUpdate

Parameters

Returns Promise<InteractionCallbackResponse>

Parameters

Returns Promise<undefined>

deleteReply

Parameters

Returns Promise<void>

editReply

Parameters

Returns Promise<APIMessage>

fetchReply

Parameters

Returns Promise<APIMessage>

followUp

Parameters

Returns Promise<APIMessage>

Parameters

Returns Promise<undefined>

inGuild

Returns boolean

isAutocomplete

Returns this is AutoCompleteInteraction

isButton

Returns this is ButtonInteraction

isChannelSelectMenu

Returns this is ChannelSelectMenuInteraction

isChatInputCommand

Returns this is ChatInputCommandInteraction

`Readonly`client

`Readonly`componentType

`Readonly`customId

`Readonly`message

`Readonly`token

`Readonly`webhook

Returns this is
| ChatInputCommandInteraction
| ContextMenuInteraction
| MessageComponentInteraction
| ModalSubmitInteraction

Returns this is
| UserSelectMenuInteraction
| RoleSelectMenuInteraction
| StringSelectMenuInteraction
| ChannelSelectMenuInteraction
| MentionableSelectMenuInteraction