Type alias PerGuildMailboxOptions

PerGuildMailboxOptions: {
    embedOptions?: EmbedOptions;
    generateClosedChannelName: ((ticket, guild, thread?) => string);
    generateMessageTitle: ((ticket, guild) => string);
    generateReplyMessage: ((ticket, guild) => string);
    generateTooMuchTicketsMessage: ((user, guild) => string);
    loggingOptions?: LoggingOptions;
    mailboxChannel: Snowflake;
    maxOnGoingTicketsPerUser: number;
    modalOptions: ModalOptions;
    threadOptions?: ThreadOptions;
} & InteractionOptions

Type declaration

  • Optional embedOptions?: EmbedOptions

    The embed options. Do not provide if you do not want to use embeds.

  • generateClosedChannelName: ((ticket, guild, thread?) => string)

    A function to build the ticket's channel name when the ticket is closed.

      • (ticket, guild, thread?): string

      • Parameters

        • ticket: Ticket
        • guild: Guild
        • Optional thread: ThreadChannel

        Returns string

  • generateMessageTitle: ((ticket, guild) => string)

    A function to build a ticket's title from the ticket object itself.

      • (ticket, guild): string

      • Parameters

        Returns string

  • generateReplyMessage: ((ticket, guild) => string)

    A function to build the reply message.

      • (ticket, guild): string

      • Parameters

        Returns string

  • generateTooMuchTicketsMessage: ((user, guild) => string)

    A function to build the message sent to a user when they have too much ongoing tickets.

      • (user, guild): string

      • Parameters

        • user: User
        • guild: Guild

        Returns string

  • Optional loggingOptions?: LoggingOptions

    The logging options. Do not provide if you do not want to log.

  • mailboxChannel: Snowflake

    The mailbox channel in which the content is sent (or from which the threads are created).

  • maxOnGoingTicketsPerUser: number

    The maximum number of ongoing tickets per user for this guild.

  • modalOptions: ModalOptions

    The settings for the modal forms.

  • Optional threadOptions?: ThreadOptions

    The thread options. Do not provide if you do not want to use threads.

Settings

Member Visibility

Theme