Class InteractionBasedMailboxManager

A mailbox working on interactions.

Export

InteractionBasedMailboxManager

Hierarchy (View Summary)

MailboxManager
- InteractionBasedMailboxManager

Index

Constructors

Properties

#options client usersTickets

Methods

checkTickets closeTicket createTicket getTicketById getTicketByLastMessage replyToTicket sendSelectGuildMenu

Constructors

constructor

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

Properties

`Protected` `Readonly`#options

"#options": ManagerOptions

The options of the interactions manager.

Memberof

InteractionBasedMailboxManager

`Readonly`client

client: Client

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: string): void
Parameters
- ticketId: string
Returns void
Inherit
Inherited from MailboxManager.closeTicket
- Defined in MailboxManager.ts:108

createTicket

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

getTicketById

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

getTicketByLastMessage

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

replyToTicket

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

sendSelectGuildMenu

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