Class InteractionBasedMailboxManager

A mailbox working on interactions.

Export

InteractionBasedMailboxManager

Hierarchy (view full)

MailboxManager
- InteractionBasedMailboxManager

Index

Constructors

Properties

#options client usersTickets

Methods

checkTickets closeTicket createTicket getTicketById getTicketByLastMessage replyToTicket sendSelectGuildMenu

Constructors

constructor

new InteractionBasedMailboxManager(client, options): InteractionBasedMailboxManager
Creates an instance of InteractionBasedMailboxManager.
Parameters
- client: Client<boolean>
- options: ManagerOptions
Returns InteractionBasedMailboxManager
Memberof
InteractionBasedMailboxManager
Overrides MailboxManager.constructor
- Defined in InteractionBasedMailboxManager.ts:66

Properties

`Readonly` `Protected` #options

#options: ManagerOptions

The options of the interactions manager.

Memberof

InteractionBasedMailboxManager

`Readonly` client

client: Client<boolean>

The discord client

Memberof

MailboxManager

`Readonly` usersTickets

usersTickets: Collection<string, UserTickets>

Inherit

Methods

checkTickets

checkTickets(): void
Returns void
Inherit
Overrides MailboxManager.checkTickets
- Defined in InteractionBasedMailboxManager.ts:151

closeTicket

closeTicket(ticketId): void
Parameters
- ticketId: string
Returns void
Inherit
Inherited from MailboxManager.closeTicket
- Defined in MailboxManager.ts:105

createTicket

createTicket(content, guildId, maxOnGoingTicketsPerUser?): Ticket
Parameters
- content: TicketContent
- guildId: string
- Optional maxOnGoingTicketsPerUser: number
Returns Ticket
Inherit
Inherited from MailboxManager.createTicket
- Defined in MailboxManager.ts:74

getTicketById

getTicketById(ticketId): Ticket
Gets a ticket by id.
Parameters
- ticketId: string
Returns Ticket
Memberof
MailboxManager
Inherited from MailboxManager.getTicketById
- Defined in MailboxManager.ts:128

getTicketByLastMessage

getTicketByLastMessage(lastMessageId, safeReturn?): Ticket
Gets a ticket by last message id. If safeReturn is false and no ticket is found, throws an error.
Parameters
- lastMessageId: string
- Optional safeReturn: false
Returns Ticket
Memberof
MailboxManager
Inherited from MailboxManager.getTicketByLastMessage
- Defined in MailboxManager.ts:144
getTicketByLastMessage(lastMessageId, safeReturn): undefined | Ticket
Parameters
- lastMessageId: string
- safeReturn: true
Returns undefined | Ticket
Inherited from MailboxManager.getTicketByLastMessage
- Defined in MailboxManager.ts:145

replyToTicket

replyToTicket(content, ticketId): void
Parameters
- content: TicketContent
- ticketId: string
Returns void
Inherit
Inherited from MailboxManager.replyToTicket
- Defined in MailboxManager.ts:97

sendSelectGuildMenu

sendSelectGuildMenu(user): Promise<void>
Sends the select menu to choose a guild.
Parameters
- user: User
Returns Promise<void>
Memberof
InteractionBasedMailboxManager
- Defined in InteractionBasedMailboxManager.ts:180