API Documentation Github

Title

Global

Type Definitions

# ActivityFeature

Properties:
Name Type Description
emoji String the emoji as a string
name String
description String
callback function

View Source classes/activities/activity.js, line 26

# ActivityInfo

Properties:
Name Type Description
activityName string the name of this activity!
guild Guild the guild where the new activity lives
roleParticipants Collection.<String, Role> roles allowed to view activity
botGuild BotGuildModel

View Source classes/activities/activity.js, line 11

# AnnouncementInfo

Properties:
Name Type Description
isEnabled Boolean
announcementChannelID String

View Source classes/bot-guild.js, line 77

# AttendanceInfo

Properties:
Name Type Description
isEnabled Boolean true if attendance is enabled in this guild
attendeeRoleID String the attendee role ID used for attendance

View Source classes/bot-guild.js, line 58

# BotGuildInfo

Properties:
Name Type Description
roleIDs RoleIDs
channelIDs ChannelIDs

View Source classes/bot-guild.js, line 83

# CaveChannels

Properties:
Name Type Description
roleSelection TextChannel

View Source classes/activities/cave.js, line 47

# CaveOptions

Properties:
Name Type Description
name String the name of the cave category
preEmojis String any pre name emojis
preRoleText String the text to add before every role name, not including '-'
color String the role color to use for this cave
role Role the role associated with this cave
emojis Emojis object holding emojis to use in this cave
times Times object holding times to use in this cave
publicRoles Collection.<String, Role> the roles that can request tickets

View Source classes/activities/cave.js, line 11

# ChannelIDs

Properties:
Name Type Description
adminConsole String the admin console channel ID
adminLog String the admin log channel ID
botSupportChannel String the bot support channel ID

View Source classes/bot-guild.js, line 41

Object

# CommandPermissionInfo

Our custom command information for validation
Properties:
Name Type Description
role string the role this command can be run by
channel string the channel ID where this command can be run
roleMessage string the message to be sent for an incorrect role
channelMessage string the message to be sent for an incorrect channel
dmOnly Boolean true if this command can only be used on a DM

View Source classes/permission-command.js, line 16

# ConsoleInfo

Properties:
Name Type Attributes Default Description
title String the console title
description String the description of the console
channel TextChannel | DMChannel the channel this console lives in
features Collection.<String, Feature> <optional>
 the collection of features mapped by emoji name
fields Collection.<String, String> <optional>
 a collection of fields
color String <optional>
 console color in hex
options ReactionCollectorOptions <optional>
 {} collector options

View Source classes/consoles/console.js, line 6

# Emojis

Properties:
Name Type Description
joinTicketEmoji GuildEmoji | ReactionEmoji emoji for mentors to accept a ticket
giveHelpEmoji GuildEmoji | ReactionEmoji emoji for mentors to join an ongoing ticket
requestTicketEmoji GuildEmoji | ReactionEmoji emoji for hackers to request a ticket
addRoleEmoji GuildEmoji | ReactionEmoji emoji for Admins to add a mentor role
deleteChannelsEmoji GuildEmoji | ReactionEmoji emoji for Admins to force delete ticket channels
excludeFromAutoDeleteEmoji GuildEmoji | ReactionEmoji emoji for Admins to opt tickets in/out of garbage collector

View Source classes/activities/cave.js, line 23

# async FeatureCallback(user, reaction, stopInteracting, console)

The function to be called when a feature is activated.
Parameters:
Name Type Description
user User the user that reacted
reaction MessageReaction the reaction
stopInteracting StopInteractingCallback callback to let the console know the user has stopped interacting.
console Console the console this feature is working on

View Source classes/consoles/feature.js, line 5

# GarbageCollectorInfo

Properties:
Name Type Description
isEnabled Boolean if the garbage collector is enabled for this ticket system
inactivePeriod Number number of minutes a ticket channel will be inactive before bot starts to delete it
bufferTime Number number of minutes the bot will wait for a response before deleting ticket

View Source classes/tickets/ticket-manager.js, line 26

# MainHelperInfo

Properties:
Name Type Description
role Role
emoji GuildEmoji | ReactionEmoji can be a unicode emoji string

View Source classes/tickets/ticket-manager.js, line 59

# NewTicketEmbedCreator(ticket) → {MessageEmbed}

Parameters:
Name Type Description
ticket Ticket

View Source classes/tickets/ticket-manager.js, line 54

MessageEmbed

# PollInfo

Properties:
Name Type Description
type String
title String
question String
emojiName String must be unicode emoji!
responses Collection.<String, String>

View Source classes/activities/workshop.js, line 11

# ReminderInfo

Properties:
Name Type Description
isEnabled Boolean is this feature enabled
time Number how long should I wait to remind helpers
reminders Collection.<Number, NodeJS.Timeout> the timeout reminders mapped by the ticket ID

View Source classes/tickets/ticket-manager.js, line 48

# ReportInfo

Properties:
Name Type Description
isEnabled Boolean true if the report functionality is enabled
incomingReportChannelID String channel where reports are sent

View Source classes/bot-guild.js, line 71

# RoleIDs

Properties:
Name Type Description
memberRole String regular guild member role ID
staffRole String the staff role ID
adminRole String the admin role ID
everyoneRole String the everyone role ID

View Source classes/bot-guild.js, line 33

# RolePermission

An object with a role and its permissions
Properties:
Name Type Description
id String the role snowflake
permissions PermissionOverwriteOption the permissions to set to that role

View Source classes/activities/activity.js, line 19

# RolePermission

An object with a role and its permissions
Properties:
Name Type Description
id String the role snowflake
permissions PermissionOverwriteOption the permissions to set to that role

View Source classes/room.js, line 17

# RoomChannels

Properties:
Name Type Description
category CategoryChannel
generalText TextChannel
generalVoice VoiceChannel
nonLockedChannel TextChannel
voiceChannels Collection.<String, VoiceChannel>
textChannels Collection.<String, TextChannel>
safeChannels Collection.<String, (TextChannel|VoiceChannel)> , channels that can not be removed

View Source classes/room.js, line 6

# async ShuffleFilter(member, channel, userId, filteropt) → {Boolean}

Parameters:
Name Type Attributes Description
member GuildMember
channel TextChannel channel to prompt user for specified voice channel
userId String user to prompt for specified voice channel
filter ShuffleFilter <optional>
 filter the users to shuffle

View Source classes/activities/activity.js, line 307

- true if filtered /** Shuffle all the general voice members on all other voice channels
Boolean

# SignupEmbedCreator(teamEmoji, prospectEmoji, isNotificationEnabled) → {MessageEmbed}

Parameters:
Name Type Description
teamEmoji String the emoji used by teams to sign up
prospectEmoji String the emoji used by prospects to sign up
isNotificationEnabled Boolean true if parties will be notified when the other party has a new post

View Source classes/team-formation.js, line 75

MessageEmbed

# StampInfo

Properties:
Name Type Description
isEnabled Boolean true if stamps are enabled
stampRoleIDs Collection.<Number, String>
stampCollectionTime Number time given to users to collect password stamps

View Source classes/bot-guild.js, line 64

# StopInteractingCallback(user)

The function used to signal the console the user interacting has finished.
Parameters:
Name Type Description
user User

View Source classes/consoles/feature.js, line 16

# SubRole

Properties:
Name Type Description
name String the role name
id String the role id (snowflake)
activeUsers Number number of users with this role

View Source classes/activities/cave.js, line 40

# SystemWideTicketInfo

All the information needed for tickets in this ticket manager
Properties:
Name Type Description
garbageCollectorInfo GarbageCollectorInfo the garbage collector information for each tickets
isAdvancedMode Boolean Information about the system being advanced. Advanced mode will create a category with channels for the users and the helpers. Regular will not create anything and expects the helper to DM the user or users.

View Source classes/tickets/ticket-manager.js, line 19

# TeamFormationChannels

Properties:
Name Type Description
info TextChannel the info channel where users read about this activity
teamCatalogue TextChannel the channel where team info is posted
prospectCatalogue TextChannel the channel where prospect info is posted

View Source classes/team-formation.js, line 68

# TeamFormationInfo

Properties:
Name Type Attributes Description
teamInfo TeamFormationPartyInfo
prospectInfo TeamFormationPartyInfo
guild Guild
botGuild BotGuildModel
activityRoles Collection.<string, Role>
isNotificationsEnabled Boolean <optional>
signupEmbedCreator SignupEmbedCreator <optional>

View Source classes/team-formation.js, line 83

# TeamFormationPartyInfo

Properties:
Name Type Attributes Description
emoji GuildEmoji | ReactionEmoji the emoji used to add this party to the team formation
role Role the role given to the users of this party
form String <optional>
 the form added to the signup embed for users to respond to. Will not be added if signupEmbed given!
signupEmbed MessageEmbed <optional>
 the embed sent to users when they sign up, must include the form!

View Source classes/team-formation.js, line 60

# TicketConsoles

Properties:
Name Type Description
groupLeader Console
ticketManager Console Message sent to incoming ticket channel for helpers to see.
ticketRoom Console The message with the information embed sent to the ticket channel once the ticket is open.

View Source classes/tickets/ticket.js, line 11

# TicketCreatorInfo

Properties:
Name Type Description
channel TextChannel the channel where users can create a ticket
console Console the console used to let users create tickets

View Source classes/tickets/ticket-manager.js, line 33

# TicketDispatcherInfo

Properties:
Name Type Description
channel TextChannel the channel where tickets are dispatched to
takeTicketEmoji GuildEmoji | ReactionEmoji emoji for mentors to accept/take a ticket, can be a unicode emoji string
joinTicketEmoji GuildEmoji | ReactionEmoji emoji for mentors to join a taken ticket, can be a unicode emoji string
embedCreator NewTicketEmbedCreator function to create a Discord MessageEmbed
reminderInfo ReminderInfo the reminder information
mainHelperInfo MainHelperInfo

View Source classes/tickets/ticket-manager.js, line 39

# TicketGarbageInfo

Properties:
Name Type Description
noHelperInterval Number Interval ID for when there are no more helpers in the ticket
mentorDeletionSequence Boolean Flag to check if a deletion sequence has already been triggered by all mentors leaving the ticket; if so, there will not be another sequence started for inactivity
exclude Boolean Flag for whether this ticket is excluded from automatic garbage collection

View Source classes/tickets/ticket.js, line 18

# Times

Properties:
Name Type Description
inactivePeriod Number number of minutes a ticket channel will be inactive before bot starts to delete it
bufferTime Number number of minutes the bot will wait for a response before deleting ticket
reminderTime Number number of minutes the bot will wait before reminding mentors of unaccepted tickets

View Source classes/activities/cave.js, line 33

# Transfer

Properties:
Name Type Description
name String the transfer name
description String the transfer description
role Role the transfer role

View Source commands/a_utility/role-selector.js, line 40

# TypeInfo

Properties:
Name Type Description
type String
roleId String

View Source classes/bot-guild.js, line 244

# TypeInfo

Properties:
Name Type Description
type String
roleId String

View Source commands/essentials/init-bot.js, line 257

# VerificationChannels

Properties:
Name Type Description
welcomeChannelID String
welcomeChannelSupportID String

View Source classes/bot-guild.js, line 238

# VerificationInfo

Properties:
Name Type Description
isEnabled Boolean true if verification is enabled
isVerifiedRoleID String the verified role ID that holds basic permissions
isVerifiedRolePermissions Array.<String> the permissions for the isVerified role
guestRoleID String the guest role ID used for verification
welcomeChannelID String the welcome channel where users learn to verify
welcomeSupportChannelID String the support channel where the bot can contact users

View Source classes/bot-guild.js, line 48