Yor.ts | classes/UserContextMenuCommandInteraction
yor.ts / Exports / UserContextMenuCommandInteraction
Class: UserContextMenuCommandInteraction
Hierarchy
-
↳
UserContextMenuCommandInteraction
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new UserContextMenuCommandInteraction(client, data): UserContextMenuCommandInteraction
Represents a user context menu command
Parameters
| Name | Type | Description |
|---|---|---|
client | YorClient | the YorClient object |
data | APIUserApplicationCommandInteraction | the APIUserApplicationCommandInteraction object |
Returns
UserContextMenuCommandInteraction
Overrides
ContextMenuCommandInteraction.constructor
Defined in
src/structures/Contexts/ContextMenu/UserContextMenuCommandInteraction.ts:15
Properties
applicationId
• applicationId: string
Inherited from
ContextMenuCommandInteraction.applicationId
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:23
client
• client: YorClient
Inherited from
ContextMenuCommandInteraction.client
Defined in
interactionId
• interactionId: string
Inherited from
ContextMenuCommandInteraction.interactionId
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:22
raw
• raw: APIUserApplicationCommandInteraction | APIMessageApplicationCommandInteraction
Inherited from
ContextMenuCommandInteraction.raw
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:16
targetId
• targetId: string
Inherited from
ContextMenuCommandInteraction.targetId
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:21
token
• token: string
Inherited from
ContextMenuCommandInteraction.token
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:20
Methods
decorate
▸ decorate(name, data): unknown
Decorates the object with a new property.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | The name of the property. |
data | unknown | The data to assign to the property. |
Returns
unknown
The decorated object.
Inherited from
ContextMenuCommandInteraction.decorate
Defined in
src/structures/Contexts/BaseContext.ts:22
defer
▸ defer(ephemeral?): Promise<void>
Defers the execution of the function.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
ephemeral | boolean | false | Whether the message is ephemeral or not. |
Returns
Promise<void>
A promise that resolves when the deferral is complete.
Inherited from
ContextMenuCommandInteraction.defer
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:53
deleteReply
▸ deleteReply(): Promise<void>
Deletes a reply.
Returns
Promise<void>
A promise that resolves when the reply is deleted.
Inherited from
ContextMenuCommandInteraction.deleteReply
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:126
editReply
▸ editReply(data): Promise<APIMessage>
Edits a reply.
Parameters
| Name | Type | Description |
|---|---|---|
data | Omit<RESTPostAPIWebhookWithTokenJSONBody, "username" | "avatar_url"> & { flags?: MessageFlags } & { files?: RawFile[] } | The data for editing the reply. |
Returns
Promise<APIMessage>
A promise that resolves when the reply is edited.
Inherited from
ContextMenuCommandInteraction.editReply
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:100
fetchReply
▸ fetchReply(): Promise<APIMessage>
Fetches the reply asynchronously.
Returns
Promise<APIMessage>
A promise that resolves when the original reply is fetched.
Inherited from
ContextMenuCommandInteraction.fetchReply
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:138
followUp
▸ followUp(data): Promise<APIMessage>
Calls the followUp method of the API class with the provided data.
Parameters
| Name | Type | Description |
|---|---|---|
data | Omit<RESTPostAPIWebhookWithTokenJSONBody, "username" | "avatar_url"> & { flags?: MessageFlags } & { files?: RawFile[] } | The data to be passed to the followUp method. |
Returns
Promise<APIMessage>
A promise that resolves to an APIMessage object.
Inherited from
ContextMenuCommandInteraction.followUp
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:175
reply
▸ reply(data): Promise<void>
Replies to an interaction.
Parameters
| Name | Type | Description |
|---|---|---|
data | Omit<RESTPostAPIWebhookWithTokenJSONBody, "username" | "avatar_url"> & { flags?: MessageFlags } & { files?: RawFile[] } | The data for creating the reply. |
Returns
Promise<void>
A promise that resolves when the reply is sent.
Inherited from
ContextMenuCommandInteraction.reply
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:73
replyModal
▸ replyModal(data): Promise<void>
Reply to a modal.
Parameters
| Name | Type | Description |
|---|---|---|
data | APIModalInteractionResponseCallbackData | The data for creating the modal. |
Returns
Promise<void>
A promise that resolves when the modal is created.
Inherited from
ContextMenuCommandInteraction.replyModal
Defined in
src/structures/Contexts/ContextMenu/ContextMenuCommandInteraction.ts:151
targetUser
▸ targetUser(): null | User
Retrieves the target user from the resolved users in the APIUserApplicationCommandInteraction data.
Returns
null | User
The target user if found, otherwise null.
Defined in
src/structures/Contexts/ContextMenu/UserContextMenuCommandInteraction.ts:27