Class: InteractionHandler<O>

Type parameters

Name	Type
O	extends Options = Options

Hierarchy

• Piece<O>

  ↳ InteractionHandler

Constructors

constructor

• new InteractionHandler<O>(context, options)

Type parameters

Name	Type
O	extends InteractionHandlerOptions = InteractionHandlerOptions

Parameters

Name	Type
context	PieceContext
options	InteractionHandlerOptions

Overrides

Piece.constructor

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:13

Properties

enabled

• enabled: boolean

Whether or not the piece is enabled.

Inherited from

Piece.enabled

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:447

---

interactionHandlerType

• Readonly interactionHandlerType: InteractionHandlerTypes

The type for this handler

since 3.0.0

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:11

---

location

• Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Piece.location

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:439

---

name

• Readonly name: string

The name of the piece.

Inherited from

Piece.name

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:443

---

options

• Readonly options: O

The raw options passed to this Piece

Inherited from

Piece.options

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:451

---

store

• Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Inherited from

Piece.store

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:435

Accessors

container

• get container(): Container

A reference to the {@link Container} object for ease of use.

see container

Returns

Container

Inherited from

Piece.container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:457

Methods

none

▸ none(): None

Returns

None

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:74

---

onLoad

▸ onLoad(): unknown

Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

Returns

unknown

Inherited from

Piece.onLoad

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:462

---

onUnload

▸ onUnload(): unknown

Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

Returns

unknown

Inherited from

Piece.onUnload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:467

---

parse

▸ parse(_interaction): Awaitable<Maybe<unknown>>

A custom function that will be called when checking if an interaction should be passed to this handler. You can use this method to not only filter by ids, but also pre-parse the data from the id for use in the run method.

By default, all interactions of the type you specified will run in a handler. You should override this method to change that behavior.

example

// Parsing a button handler
public override parse(interaction: ButtonInteraction) {
  if (interaction.customId.startsWith('my-awesome-clicky-button')) {
       // Returning a `some` here means that the run method should be called next!
    return this.some({ isMyBotAwesome: true, awesomenessLevel: 9001 });
  }

  // Returning a `none` means this interaction shouldn't run in this handler
  return this.none();
}

example

// Getting data from a database based on the custom id
public override async parse(interaction: ButtonInteraction) {
  // This code is purely for demonstration purposes only!
  if (interaction.customId.startsWith('example-data')) {
    const [, userId, channelId] = interaction.customId.split('.');

       const dataFromDatabase = await container.prisma.exampleData.findFirst({ where: { userId, channelId } });

    // Returning a `some` here means that the run method should be called next!
    return this.some(dataFromDatabase);
  }

  // Returning a `none` means this interaction shouldn't run in this handler
  return this.none();
}

Parameters

Name	Type
_interaction	Interaction<CacheType>

Returns

Awaitable<Maybe<unknown>>

A Maybe (or a {@link Promise Promised} Maybe) that indicates if this interaction should be handled by this handler, and any extra data that should be passed to the run method

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:64

---

reload

▸ reload(): Promise<void>

Reloads the piece by loading the same path in the store.

Returns

Promise<void>

Inherited from

Piece.reload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:475

---

run

▸ Abstract run(interaction, parsedData?): unknown

Parameters

Name	Type
interaction	Interaction<CacheType>
parsedData?	unknown

Returns

unknown

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:19

---

some

▸ some(): Maybe<never>

Returns

Maybe<never>

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:68

▸ some<T>(data): Maybe<T>

Type parameters

Name
T

Parameters

Name	Type
data	T

Returns

Maybe<T>

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:69

---

toJSON

▸ toJSON(): InteractionHandlerJSON

Defines the JSON.stringify behavior of this piece.

Returns

InteractionHandlerJSON

Overrides

Piece.toJSON

Defined in

projects/framework/src/lib/structures/InteractionHandler.ts:78

---

unload

▸ unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Piece.unload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:471