channelPairing(oldState, newState)

Parameters

• oldState Discord.VoiceState

  The <VoiceState> before the update

• newState Discord.VoiceState

  The <VoiceState> after the update

Source

• handlers/channelPairing.js, line 10  //  View on GitHub

commandError(msg, errorMsg, commandError, footeropt)

Parameters

• msg Discord.Message
  

  Erroneous command message

• errorMsg string
  

  Error message to display

• commandError string
  

  The error text to display for the command

• footer string <optional>
  

  Optional supplementary footer

Source

• handlers/commandError.js, line 8  //  View on GitHub

commandHandler(msg)

Parameters

• msg Discord.Message

  The <Message> that emitted the <Client>#message event

Source

• handlers/commandHandler.js, line 11  //  View on GitHub

confirmWithReaction(msg, dm, confirm, cancel)

Parameters

• msg Discord.Message

  Command/reaction message

• dm Discord.Message

  Direct message to attach confirmation emojis to

• confirm function

  Callback function to execute on confirmation

• cancel function

  Callback function to execute on cancel

Source

• handlers/confirmWithReaction.js, line 10  //  View on GitHub

createEmbed(prompt, colouropt) → {Discord.MessageEmbed}

Parameters

• prompt string
  

  The prompt to display as the embed description

• colour Discord.ColorResolvable <optional>
  

  The colour to set the embed to

Returns

• Discord.MessageEmbed

  The created embed

Source

• handlers/createEmbed.js, line 7  //  View on GitHub

createGuild(guild) → {Promise.<Typings.GuildConfiguration>}

Parameters

• guild Discord.Guild

  The <Guild> to initialise

Returns

• Promise.<Typings.GuildConfiguration>

  The guild's <GuildConfiguration> document

Source

• handlers/createGuild.js, line 36  //  View on GitHub

debugError(guildnullable, error, errorMsg, fieldTitleopt, fieldContentopt)

Parameters

• guild Discord.Guild <nullable>
  

  The guild the member shares with the bot

• error Error
  

  The error object

• errorMsg string
  

  A string to display as an error message

• fieldTitle string <optional>
  

  A title for an optional additional embed field

• fieldContent string <optional>
  

  The field content for the optional embed field

Source

• handlers/debugError.js, line 11  //  View on GitHub

deleteMsg(msg)

Parameters

• msg Discord.Message

  The message to delete

Source

• handlers/deleteMsg.js, line 9  //  View on GitHub

directCommandError(msg, typeopt)

Parameters

• msg Discord.Message
  

  The erroneous command message

• type 'NO_PERMISSION'  |  'HAS_ROLE_MENTION'  |  'NO_DIRECT'  |  'MULTIPLE_GUILDS' <optional>
  

  The reason for the command error

Source

• handlers/directCommandError.js, line 9  //  View on GitHub

embedScaffold(guildnullable, destination, description, colour, type, fieldTitleopt, nullable, fieldContentopt, nullable, errorFieldopt)

Parameters

• guild Discord.Guild <nullable>
  

  The guild the member shares with the bot

• destination Discord.TextBasedChannels  |  Discord.User  |  Discord.GuildMember
  

  The TextBasedChannel to send the embed to

• description string
  

  The description of the embed to be created

• colour Discord.ColorResolvable
  

  The colour of the embed to be created

• type 'MESSAGE'  |  'DIRECT'  |  'DEVELOPER'  |  'DEBUG'
  

  The intended purpose of the embed

• fieldTitle string <optional> <nullable>
  

  A title for an optional embed field

• fieldContent string <optional> <nullable>
  

  Embed field content

• errorField string <optional>
  

  An optional additional error message to append to the end of the description

Source

• handlers/embedScaffold.js, line 10  //  View on GitHub

emojiReact(msg, emoji)

Parameters

• msg Discord.Message

  The message to react to

• emoji Discord.EmojiIdentifierResolvable

  The emoji to react with

Source

• handlers/emojiReact.js, line 9  //  View on GitHub

errorReact(msg)

Parameters

• msg Discord.Message

  The message to error react to

Source

• handlers/errorReact.js, line 9  //  View on GitHub

findGuildConfiguration(guildopt, changesopt) → {Promise.<Typings.GuildConfiguration>}

Parameters

• guild Discord.Guild <optional>
  

  The <Guild> to find the <GuildConfiguration> for

  • If undefined, the <GuildConfiguration> of the default guild defined by config.ids.DEFAULT_GUILD will be returned instead
• changes Partial.<Typings.GuildConfiguration> <optional>
  

  A Partial<GuildConfiguration> object of the values to update within the <GuildConfiguration>

Returns

• Promise.<Typings.GuildConfiguration>

  The guild's <GuildConfiguration>, or the config.ids.DEFAULT_GUILD's <GuildConfiguration>

Source

• handlers/findGuildConfiguration.js, line 13  //  View on GitHub

getRoleError(msg) → {Promise.<'ERROR'>}

Parameters

• msg Discord.Message

  The command message

Returns

• Promise.<'ERROR'>

  An error!

Source

• handlers/getRoleError.js, line 9  //  View on GitHub

lessonInstructions(channelId, guild)

Parameters

• channelId Discord.Snowflake
• guild Discord.Guild

Source

• handlers/lessonInstructions.js, line 11  //  View on GitHub

lessonReminders(guild)

Parameters

• guild Discord.Guild

Source

• handlers/lessonReminders.js, line 15  //  View on GitHub

manageAttendance(reaction, user)

Parameters

• reaction Discord.MessageReaction

  The reaction object

• user Discord.User

  The <User> that applied the guild or reaction emoji

Source

• handlers/manageAttendance.js, line 15  //  View on GitHub

overwriteCommands(guild) → {Promise.<Typings.GuildConfiguration>}

Parameters

• guild Discord.Guild

Returns

• Promise.<Typings.GuildConfiguration>

Source

• handlers/overwriteCommands.js, line 12  //  View on GitHub

permissionsCheck(memberRoles, id, command) → {boolean}

Parameters

• memberRoles Discord.Collection.<Discord.Snowflake, Discord.Role>

  The Collection<Snowflake, Role> of the <GuildMember>

• id Discord.Snowflake

  The <User.id> of the user to check permissions for

• command Typings.BaseCommand

  The <BaseCommand> object to check permissions against

Returns

• boolean

  Whether the <User> has the adequate permissions to access the <Command>

Source

• handlers/permissionsCheck.js, line 10  //  View on GitHub

permissionsHandler(msg, command) → {Promise.<(boolean|'ERROR')>}

Parameters

• msg Discord.Message

  The command message

• command Typings.BaseCommand

  The <BaseCommand> object to check permissions against

Returns

• Promise.<(boolean|'ERROR')>

  If user has permissions or ERROR

Source

• handlers/permissionsHandler.js, line 12  //  View on GitHub

purgeChannel(msgs, channel, collectoropt)

Parameters

• msgs Discord.Collection.<Discord.Snowflake, Discord.Message>  |  Array.<Discord.MessageResolvable>  |  number
  

  Messages to delete

• channel Discord.GuildTextBasedChannel
  

  Channel to purge

• collector Discord.ReactionCollector <optional>
  

  An optional reaction collector to stop

Source

• handlers/purgeChannel.js, line 9  //  View on GitHub

removeGuild(guild)

Parameters

• guild Discord.Guild

  The guild to delete from the database

Source

• handlers/removeGuild.js, line 9  //  View on GitHub

sendDirect(user, options, guildChannelnullable, toDebugopt) → {Promise.<(void|Discord.Message)>}

Parameters

• user Discord.User  |  Discord.GuildMember  |  Discord.DMChannel
  

  User to send to

• options string  |  Discord.MessagePayload  |  Discord.MessageOptions
  

  Message options

• guildChannel Discord.GuildTextBasedChannel <nullable>
  

  A guild channel that the user has access to, to send an error in case cannot send DM

• toDebug boolean <optional>
  false

  Whether to send the error message to debugging rather than the user in a guild channel

Returns

• Promise.<(void|Discord.Message)>

  Message if it was sent

Source

• handlers/sendDirect.js, line 12  //  View on GitHub

sendMsg(destination, options) → {Promise.<(void|Discord.Message)>}

Parameters

• destination Discord.GuildTextBasedChannel

  Destination channel

• options string  |  Discord.MessagePayload  |  Discord.MessageOptions

  Message payload/options

Returns

• Promise.<(void|Discord.Message)>

  The message if it was successfully sent

Source

• handlers/sendMsg.js, line 7  //  View on GitHub

successReact(msg)

Parameters

• msg Discord.Message

  The message to success react to

Source

• handlers/successReact.js, line 9  //  View on GitHub

unsubmittedLessons(guild)

Parameters

• guild Discord.Guild

  The guild to update lessons for

Source

• handlers/unsubmittedLessons.js, line 15  //  View on GitHub

updateUnsubmitted(reaction, user)

Parameters

• reaction Discord.MessageReaction

  The reaction object

• user Discord.User

  The <User> that applied the guild or reaction emoji

Source

• handlers/updateUnsubmitted.js, line 10  //  View on GitHub

upsertCommands(guild) → {Promise.<Typings.GuildConfiguration>}

Parameters

• guild Discord.Guild

Returns

• Promise.<Typings.GuildConfiguration>

Source

• handlers/upsertCommands.js, line 11  //  View on GitHub

verifyBotPermissions(guild, changesopt)

Parameters

• guild Discord.Guild
  

  The <Guild> to verify permissions for

• changes Array.<Discord.PermissionString> <optional>
  

Source

• handlers/verifyBotPermissions.js, line 12  //  View on GitHub