ModalSubmitInteraction
Extends
Omit
<Interaction
<FromGuild
,APIModalSubmitInteraction
>,"modal"
>.BaseInteraction
<FromGuild
>
Type parameters
Type parameter | Value |
---|---|
FromGuild extends boolean | boolean |
Constructors
new ModalSubmitInteraction(client, interaction, __reply)
1new ModalSubmitInteraction<FromGuild>(2 client: UsingClient,3 interaction: APIInteraction,4__reply?: __InternalReplyFunction): ModalSubmitInteraction<FromGuild>
Parameters
Parameter | Type |
---|---|
client | UsingClient |
interaction | APIInteraction |
__reply ? | __InternalReplyFunction |
Returns
ModalSubmitInteraction
<FromGuild
>
Inherited from
Source
seyfert/src/structures/Interaction.ts:92
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
appPermissions? | public | PermissionsBitField | BaseInteraction .appPermissions |
applicationId | public | string | BaseInteraction .applicationId |
channel? | public | AllChannels | BaseInteraction .channel |
channelId | public | undefined | string | BaseInteraction .channelId |
client | readonly | UsingClient | BaseInteraction .client |
data | public | Object | BaseInteraction .data |
data.components | public | Object [] | - |
data.customId | public | string | - |
entitlements | public | Object [] | BaseInteraction .entitlements |
guildId | public | undefined | string | BaseInteraction .guildId |
guildLocale | public | | undefined | "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi" | BaseInteraction .guildLocale |
id | public | string | BaseInteraction .id |
locale | public | | "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi" | BaseInteraction .locale |
member | public | When <FromGuild , InteractionGuildMember , undefined > | BaseInteraction .member |
message? | public | Message | BaseInteraction .message |
replied? | public | boolean | Promise <boolean > | BaseInteraction .replied |
token | public | string | BaseInteraction .token |
user | public | User | BaseInteraction .user |
version | public | 1 | BaseInteraction .version |
Accessors
components
1get components(): Object[]
Returns
Object
[]
Source
seyfert/src/structures/Interaction.ts:614
createdAt
1get createdAt(): Date
createdAt gets the creation Date instace of the current object.
Returns
Date
Source
seyfert/src/structures/extra/DiscordBase.ts:27
createdTimestamp
1get createdTimestamp(): number
Create a timestamp for the current object.
Returns
number
Source
seyfert/src/structures/extra/DiscordBase.ts:20
customId
1get customId(): string
Returns
string
Source
seyfert/src/structures/Interaction.ts:610
Methods
deferReply()
1deferReply(flags?: MessageFlags): Promise<void>
Parameters
Parameter | Type |
---|---|
flags ? | MessageFlags |
Returns
Promise
<void
>
Inherited from
Source
seyfert/src/structures/Interaction.ts:207
deleteMessage()
1deleteMessage(messageId: string): Promise<undefined | void>
Parameters
Parameter | Type |
---|---|
messageId | string |
Returns
Promise
<undefined
| void
>
Inherited from
Omit.deleteMessage
Source
seyfert/src/structures/Interaction.ts:383
deleteResponse()
1deleteResponse(): Promise<undefined | void>
Returns
Promise
<undefined
| void
>
Inherited from
Omit.deleteResponse
Source
seyfert/src/structures/Interaction.ts:379
editMessage()
1editMessage(messageId: string, body: Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps): Promise<WebhookMessage>
Parameters
Parameter | Type |
---|---|
messageId | string |
body | Omit <RESTPatchAPIWebhookWithTokenMessageJSONBody , "components" | "embeds" > & ResolverProps |
Returns
Promise
<WebhookMessage
>
Inherited from
Omit.editMessage
Source
seyfert/src/structures/Interaction.ts:371
editOrReply()
1editOrReply<FR>(body: Omit<APIInteractionResponseCallbackData, "components" | "embeds" | "poll"> & SendResolverProps, fetchReply?: FR): Promise<When<FR, WebhookMessage, void>>
Type parameters
Type parameter | Value |
---|---|
FR extends boolean | false |
Parameters
Parameter | Type |
---|---|
body | Omit <APIInteractionResponseCallbackData , "components" | "embeds" | "poll" > & SendResolverProps |
fetchReply ? | FR |
Returns
Promise
<When
<FR
, WebhookMessage
, void
>>
Inherited from
Omit.editOrReply
Source
seyfert/src/structures/Interaction.ts:359
editResponse()
1editResponse(body: Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps): Promise<WebhookMessage>
Parameters
Parameter | Type |
---|---|
body | Omit <RESTPatchAPIWebhookWithTokenMessageJSONBody , "components" | "embeds" > & ResolverProps |
Returns
Promise
<WebhookMessage
>
Inherited from
Omit.editResponse
Source
seyfert/src/structures/Interaction.ts:375
fetchGuild()
1fetchGuild(force: boolean): undefined | Promise<Guild<"cached"> | Guild<"api">>
Parameters
Parameter | Type | Default value |
---|---|---|
force | boolean | false |
Returns
undefined
| Promise
<Guild
<"cached"
> | Guild
<"api"
>>
Inherited from
Source
seyfert/src/structures/Interaction.ts:269
fetchMessage()
1fetchMessage(messageId: string): Promise<undefined | WebhookMessage>
Parameters
Parameter | Type |
---|---|
messageId | string |
Returns
Promise
<undefined
| WebhookMessage
>
Inherited from
Omit.fetchMessage
Source
seyfert/src/structures/Interaction.ts:332
fetchResponse()
1fetchResponse(): Promise<undefined | WebhookMessage>
Returns
Promise
<undefined
| WebhookMessage
>
Inherited from
Omit.fetchResponse
Source
seyfert/src/structures/Interaction.ts:336
followup()
1followup(body: Omit<RESTPostAPIWebhookWithTokenJSONBody, "components" | "embeds" | "poll"> & SendResolverProps): Promise<WebhookMessage>
Parameters
Parameter | Type |
---|---|
body | Omit <RESTPostAPIWebhookWithTokenJSONBody , "components" | "embeds" | "poll" > & SendResolverProps |
Returns
Promise
<WebhookMessage
>
Inherited from
Omit.followup
Source
seyfert/src/structures/Interaction.ts:387
getInputValue()
getInputValue(customId, required)
1getInputValue(customId: string, required: true): string
Parameters
Parameter | Type |
---|---|
customId | string |
required | true |
Returns
string
Source
seyfert/src/structures/Interaction.ts:618
getInputValue(customId, required)
1getInputValue(customId: string, required?: false): undefined | string
Parameters
Parameter | Type |
---|---|
customId | string |
required ? | false |
Returns
undefined
| string
Source
seyfert/src/structures/Interaction.ts:619
reply()
1reply(body: ReplyInteractionBody): Promise<void>
Parameters
Parameter | Type |
---|---|
body | ReplyInteractionBody |
Returns
Promise
<void
>
Inherited from
Source
seyfert/src/structures/Interaction.ts:196
write()
1write<FR>(body: Omit<APIInteractionResponseCallbackData, "components" | "embeds" | "poll"> & SendResolverProps, fetchReply?: FR): Promise<When<FR, WebhookMessage, void>>
Type parameters
Type parameter | Value |
---|---|
FR extends boolean | false |
Parameters
Parameter | Type |
---|---|
body | Omit <APIInteractionResponseCallbackData , "components" | "embeds" | "poll" > & SendResolverProps |
fetchReply ? | FR |
Returns
Promise
<When
<FR
, WebhookMessage
, void
>>
Inherited from
Omit.write
Source
seyfert/src/structures/Interaction.ts:340
from()
1static from(2 client: UsingClient,3 gateway: APIInteraction,4 __reply?: __InternalReplyFunction):5 | RoleSelectMenuInteraction6 | UserSelectMenuInteraction7 | MentionableSelectMenuInteraction8 | ChannelSelectMenuInteraction9 | StringSelectMenuInteraction<string[]>10 | AutocompleteInteraction<boolean>11 | ChatInputCommandInteraction<boolean>12 | UserCommandInteraction<boolean>13 | MessageCommandInteraction<boolean>14 | ButtonInteraction15 | ModalSubmitInteraction<boolean>16| BaseInteraction<boolean, APIPingInteraction>
Parameters
Parameter | Type |
---|---|
client | UsingClient |
gateway | APIInteraction |
__reply ? | __InternalReplyFunction |
Returns
| RoleSelectMenuInteraction
| UserSelectMenuInteraction
| MentionableSelectMenuInteraction
| ChannelSelectMenuInteraction
| StringSelectMenuInteraction
<string
[]>
| AutocompleteInteraction
<boolean
>
| ChatInputCommandInteraction
<boolean
>
| UserCommandInteraction
<boolean
>
| MessageCommandInteraction
<boolean
>
| ButtonInteraction
| ModalSubmitInteraction
<boolean
>
| BaseInteraction
<boolean
, APIPingInteraction
>
Inherited from
Source
seyfert/src/structures/Interaction.ts:216
transformBody()
1static transformBody<T>(body: Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps | Omit<RESTPatchAPIChannelMessageJSONBody, "components" | "embeds"> & ResolverProps | Omit<RESTPostAPIWebhookWithTokenJSONBody, "components" | "embeds" | "poll"> & SendResolverProps | Omit<RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "embeds"> & ResolverProps, self: UsingClient): T
Type parameters
Type parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
body | Omit <RESTPostAPIChannelMessageJSONBody , "components" | "embeds" | "poll" > & SendResolverProps | Omit <RESTPatchAPIChannelMessageJSONBody , "components" | "embeds" > & ResolverProps | Omit <RESTPostAPIWebhookWithTokenJSONBody , "components" | "embeds" | "poll" > & SendResolverProps | Omit <RESTPatchAPIWebhookWithTokenMessageJSONBody , "components" | "embeds" > & ResolverProps |
self | UsingClient |
Returns
T
Inherited from
Source
seyfert/src/structures/Interaction.ts:164
transformBodyRequest()
1static transformBodyRequest(body: ReplyInteractionBody, self: BaseClient): APIInteractionResponse
Parameters
Parameter | Type |
---|---|
body | ReplyInteractionBody |
self | BaseClient |
Returns
APIInteractionResponse
Inherited from
BaseInteraction
.transformBodyRequest