Autocomplete

Implementation of the Discord Autocomplete Interaction class in Luau

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-structure

Summary

Properties

state

Autocomplete.state :: State

type

Autocomplete.type :: string

The type of interaction. This can be one of the following values:

“PING”
“APPLICATION_COMMAND”
“MESSAGE_COMPONENT”
“APPLICATION_COMMAND_AUTOCOMPLETE”
“MODAL_SUBMIT”

context

Autocomplete.context :: string

The context type of the interaction. This can be one of the following values:

“GUILD”
“BOT_DM”
“PRIVATE_CHANNEL”

id

Autocomplete.id :: string

The unique identifier for the interaction.

applicationId

Autocomplete.applicationId :: string

The ID of the application this interaction is for.

data

Autocomplete.data :: InteractionBehaviourData?

The data associated with the interaction. The structure of this data varies based on the interaction type.

guild

Autocomplete.guild :: UnavailableGuild?

The guild where the interaction was triggered. This is only present for guild interactions.

guildId

Autocomplete.guildId :: string?

The ID of the guild where the interaction was triggered. This is only present for guild interactions.

channelId

Autocomplete.channelId :: string?

The ID of the channel where the interaction was triggered.

member

Autocomplete.member :: Member?

The member who triggered the interaction. This is only present for guild interactions.

user

Autocomplete.user :: User?

The user who triggered the interaction.

token

Autocomplete.token :: string

The token used for responding to the interaction.

version

Autocomplete.version :: number

The version of the interaction.

message

Autocomplete.message :: Message?

The message that triggered the interaction. This is only present for message component interactions.

appPermissions

Autocomplete.appPermissions :: Permission

The permissions the application has in the channel where the interaction was triggered.

locale

Autocomplete.locale :: string?

The selected language of the user who triggered the interaction.

guildLocale

Autocomplete.guildLocale :: string?

The guild’s preferred locale, if the interaction was triggered in a guild.

entitlements

Autocomplete.entitlements :: Entitlement}

The entitlements for the user who triggered the interaction.

authorizingIntegrationOwners

Autocomplete.authorizingIntegrationOwners :: {
{[string]: string} }

The mapping of integration types to their respective owners.

attachmentSizeLimit

Autocomplete.attachmentSizeLimit :: number?

The maximum attachment size in bytes for this interaction, varies by guild boost tier and the invoking user’s Nitro status.

Methods

respondAsync

Respond to an autocomplete interaction with a list of choices. Sends interaction response type 8 (APPLICATION_COMMAND_AUTOCOMPLETE_RESULT).

interaction:respondAsync({
  builders.choice.new({ name = "Option A", value = "a" }):build(),
  builders.choice.new({ name = "Option B", value = "b" }):build(),
}):await()

Parameters

choices: choiceJSON }

Returns

FutureLike<string, nil>

sync

Responsible for syncing data to this interaction object. This is typically called by the API when this object is created or updated.

Parameters

interactionData: InteractionObject

Functions

new

Responsible for constructing this class.

Parameters

state: State
interactionData: InteractionObject

Returns

Autocomplete

inheritProperties

Responsible for inheriting properties from the interaction data to the class instance. This function initializes all the properties of an Interaction instance based on the provided interaction data.

Parameters

class: any
interactionData: InteractionObject

inheritMethods

Responsible for inheriting methods from the Interaction prototype to the class instance. This function copies all methods from the Interaction.Prototype to the provided class instance.

Parameters

class: any