discord.js | InteractionsAPI

/

/

/

/

/

InteractionsAPI%3AClass

Search...

K

InteractionsAPI

export declare class InteractionsAPI

export 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, callbackData, options?):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
callbackData	APICommandAutocompleteInteractionResponseCallbackData	No	The callback data for the autocomplete response
options	Pick<RequestData, 'signal'>	Yes	The options for sending the autocomplete response

createModal(interactionId, interactionToken, callbackData, options?):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
callbackData	APIModalInteractionResponseCallbackData	No	The modal callback data to send
options	Pick<RequestData, 'signal'>	Yes	The options for sending the modal

defer(interactionId, interactionToken, data?, options?):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
data	APIInteractionResponseDeferredChannelMessageWithSource['data']	Yes	The data for deferring the reply
options	Pick<RequestData, 'signal'>	Yes	The options for deferring

deferMessageUpdate(interactionId, interactionToken, options?):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
options	Pick<RequestData, 'signal'>	Yes	The options for deferring

deleteReply(applicationId, interactionToken, messageId?, options?):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
options	Pick<RequestData, 'signal'>	Yes	The options for deleting the reply

editReply(applicationId, interactionToken, callbackData, messageId?, options?):Promise<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
callbackData	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The callback data for editing the reply
messageId	Snowflake \| '@original'	Yes	The id of the message to edit. If omitted, the original reply will be edited
options	Pick<RequestData, 'signal'>	Yes	The options for editing the reply

followUp(applicationId, interactionToken, body, options?):Promise<APIMessage>

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
body	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The callback data for replying
options	Pick<RequestData, 'signal'>	Yes	The options for replying

getOriginalReply(applicationId, interactionToken, options?):Promise<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
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the reply

reply(interactionId, interactionToken, body, options?):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
body	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The callback data for replying
options	Pick<RequestData, 'signal'>	Yes	The options for replying

Deprecated

sendPremiumRequired(interactionId, interactionToken, options?):Promise<void>

Sending a premium-style button is the new Discord behaviour.

Deprecated

Sends a premium required 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
options	Pick<RequestData, 'signal'>	Yes	The options for sending the premium required response

updateMessage(interactionId, interactionToken, callbackData, options?):Promise<void>

Updates 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
callbackData	APIInteractionResponseCallbackData & { files?: RawFile[]; }	No	The callback data for updating the interaction
options	Pick<RequestData, 'signal'>	Yes	The options for updating the interaction