Class Interaction

Represents an interaction.

Hierarchy (view full)

Base
- Interaction

Index

Constructors

Properties

acknowledged application? applicationID client id token type version

Accessors

Methods

isAutocompleteInteraction isCommandInteraction isComponentInteraction isModalSubmitInteraction isPingInteraction toJSON toString from generateID getCreatedAt getDiscordEpoch

Constructors

constructor

new Interaction(data, client): Interaction
Parameters
- data: AnyRawInteraction
- client: Client<ClientEvents>
Returns Interaction
Overrides Base.constructor
- Defined in lib/structures/Interaction.ts:37

Properties

acknowledged

acknowledged: boolean

If this interaction has been acknowledged.

`Optional` application

application?: ClientApplication

The application this interaction is for.

applicationID

applicationID: string

The ID of the application this interaction is for.

client

client: Client<ClientEvents>

id

id: string

token

token: string

The token of this interaction.

type

type: InteractionTypes

The type of this interaction.

version

version: 1

Read-only property, always 1

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in lib/structures/Base.ts:39

Methods

isAutocompleteInteraction

isAutocompleteInteraction(): this is AutocompleteInteraction<Uncached | AnyInteractionChannel>
A type guard, checking if this interaction is an Autocomplete Interaction.

Returns this is AutocompleteInteraction<Uncached | AnyInteractionChannel>
- Defined in lib/structures/Interaction.ts:72

isCommandInteraction

isCommandInteraction(): this is CommandInteraction<Uncached | AnyInteractionChannel, ApplicationCommandTypes>
A type guard, checking if this interaction is a Command Interaction.

Returns this is CommandInteraction<Uncached | AnyInteractionChannel, ApplicationCommandTypes>
- Defined in lib/structures/Interaction.ts:77

isComponentInteraction

isComponentInteraction(): this is ComponentInteraction<BUTTON | SelectMenuTypes, Uncached | AnyInteractionChannel>
A type guard, checking if this interaction is a Component Interaction.

Returns this is ComponentInteraction<BUTTON | SelectMenuTypes, Uncached | AnyInteractionChannel>
- Defined in lib/structures/Interaction.ts:82

isModalSubmitInteraction

isModalSubmitInteraction(): this is ModalSubmitInteraction<Uncached | AnyInteractionChannel>
A type guard, checking if this interaction is a Modal Submit Interaction.

Returns this is ModalSubmitInteraction<Uncached | AnyInteractionChannel>
- Defined in lib/structures/Interaction.ts:87

isPingInteraction

isPingInteraction(): this is PingInteraction
A type guard, checking if this interaction is a Ping Interaction.

Returns this is PingInteraction
- Defined in lib/structures/Interaction.ts:92

toJSON

toJSON(): JSONInteraction
Returns JSONInteraction
Overrides Base.toJSON
- Defined in lib/structures/Interaction.ts:96

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in lib/structures/Base.ts:64

`Static` from

from<T>(data, client): T
Type Parameters
- T extends AnyInteraction = AnyInteraction
Parameters
- data: RawInteraction
- client: Client<ClientEvents>
Returns T
- Defined in lib/structures/Interaction.ts:48

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Base.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in lib/structures/Base.ts:32