discord.js | InteractionsAPI

/

/

/

/

/

InteractionsAPI%3AClass

Search...

K

InteractionsAPI

declare class InteractionsAPI

declare class InteractionsAPI

No summary provided.

constructor(rest, webhooks)

Constructs a new instance of the InteractionsAPI class

Name	Type	Optional	Description
rest	REST	No	None
webhooks	WebhooksAPI	No	None

createAutocompleteResponse(interactionId, interactionToken, data):Promise<void>

Sends an autocomplete response to an interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

Name	Type	Optional	Description
interactionId	Snowflake	No	The id of the interaction
interactionToken	string	No	The token of the interaction
data	APICommandAutocompleteInteractionResponseCallbackData	No	Data for the autocomplete response

createModal(interactionId, interactionToken, data):Promise<void>

Sends a modal response to an interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

Name	Type	Optional	Description
interactionId	Snowflake	No	The id of the interaction
interactionToken	string	No	The token of the interaction
data	APIModalInteractionResponseCallbackData	No	The modal to send

defer(interactionId, interactionToken):Promise<void>

Defers the reply to an interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

Name	Type	Optional	Description
interactionId	Snowflake	No	The id of the interaction
interactionToken	string	No	The token of the interaction

deferMessageUpdate(interactionId, interactionToken):Promise<void>

Defers an update from a message component interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

Name	Type	Optional	Description
interactionId	Snowflake	No	The id of the interaction
interactionToken	string	No	The token of the interaction

deleteReply(applicationId, interactionToken, messageId?):Promise<void>

Deletes the initial reply to an interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-responsehttps://discord.com/developers/docs/interactions/receiving-and-responding#delete-followup-message

Name	Type	Optional	Description
applicationId	Snowflake	No	The application id of the interaction
interactionToken	string	No	The token of the interaction
messageId	Snowflake \| '@original'	Yes	The id of the message to delete. If omitted, the original reply will be deleted

editReply(applicationId, interactionToken, data, messageId?):Promise<discord_api_types_v10.APIMessage>

Edits the initial reply to an interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-responsehttps://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

Name	Type	Optional	Description
applicationId	Snowflake	No	The application id of the interaction
interactionToken	string	No	The token of the interaction
data	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The data to use when editing the reply
messageId	Snowflake \| '@original'	Yes	The id of the message to edit. If omitted, the original reply will be edited

followUp(applicationId, interactionToken, data):Promise<void>

Reply to a deferred interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message

Name	Type	Optional	Description
applicationId	Snowflake	No	The application id of the interaction
interactionToken	string	No	The token of the interaction
data	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The data to use when replying

getOriginalReply(applicationId, interactionToken):Promise<discord_api_types_v10.APIMessage>

Fetches the initial reply to an interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response

Name	Type	Optional	Description
applicationId	Snowflake	No	The application id of the interaction
interactionToken	string	No	The token of the interaction

reply(interactionId, interactionToken, data):Promise<void>

Replies to an interaction

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

Name	Type	Optional	Description
interactionId	Snowflake	No	The id of the interaction
interactionToken	string	No	The token of the interaction
data	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The data to use when replying

updateMessage(interactionId, interactionToken, data):Promise<void>

Updates the the message the component interaction was triggered on

See Also

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

Name	Type	Optional	Description
interactionId	Snowflake	No	The id of the interaction
interactionToken	string	No	The token of the interaction
data	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The data to use when updating the interaction