Skip to main content

Classes

Main​

Class Purpose:​

The Main class will start and initialize the bot with its default parameters.

Data Fields:​

  • bot: An instance of the Discord Bot
  • database: An instance of the Database class

Methods:​

  • on_ready(): void

    • An event handler called when the Discord bot is ready. It prints a message to the console and sends a message to a specific channel.
    • Pre-conditions: None
    • Parameters: None
    • Returns: Prints "Hello, I'm now online!" string if the channel is active for the bot to enter.

  • setup_hook(): void

    • A method that loads external commands (cogs) from the 'cogs' directory.
    • Pre-conditions: None
    • Parameters: None
    • Returns: Prints string of cog commands to the console.

  • disconnect(ctx):

    • Creates a disconnect command with a disconnect button when activated
    • Pre-conditions: None
    • Parameters: ctx
    • Returns: Returns a disconnect command to be used by the user in the discord server.

  • main(): void

    • The main entry point for the bot, where it sets up the bot, loads cogs, and starts the bot using asyncio.
    • Pre-conditions: None
    • Parameters: None
    • Returns: None

Database​

Class Purpose:​

To create a database of users with data about their performance within a specific language.

Data Fields: None​

Methods:​

  • new(cls):

    • Ensures that only one instance of the Database class is created.
    • Pre-conditions: None
    • Parameters: cls
    • Returns: An instance of the database via cls.instance

  • initDb(self):

    • Initializes the database connection and sets up the client, database, and collections.
    • Pre-conditions: none
    • Parameters: self
    • Returns: Prints a success string if the client successfully to the MongoDB

  • readUser(self, username):

    • Reads the user's conditions and determines if the user is valid or not in the database.
    • Pre-conditions: none
    • Parameters: self, username
    • Returns: Prints a success string if the client can read the user in the database

  • findUser(self, username):

    • Finds a user in the database based on the username.
    • Pre-conditions: None
    • Parameters: self, username
    • Returns: self.userCollection.find_one(query), displays the user if it was found

  • insertUser(self, user): void

    • Inserts a user into the database.
    • Pre-conditions: None
    • Parameters: self, user
    • Returns: A successful call of inserting a user into the database

  • changeUserLangauge(self, username, language):

    • Updates the user's language preference in the user collection.
    • Pre-conditions: None
    • Parameters: self, username, language
    • Returns: A successful call of changing the language of a user based on their collection ID

  • getQuizzes(self, language):

    • Retrieves quizzes based on the specified language.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: An array of the quizzes

  • getPractices(self, language):

    • Retrieves practices based on the specified language.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: An array of practice activities

  • getFlashcards(self, language):

    • Retrieves flashcards based on the specified language.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: An array of flashcard activities

  • getUsrFlashcards(self, unit_choice, language):

    • Confirms with the database that it can successfully access a user's flashcard data.
    • Pre-conditions: None
    • Parameters: self, unit_choice, language
    • Returns: A success string if the database could find a user's flashcard data

  • readProgress(self, language):

    • Reads the user's conditions and determines if the user's progress is valid or not in the database.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: Prints a success string if the client can read the user's progress in the database

  • getRandomQuiz(self, language):

    • Selects and returns a random quiz for the specified language.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: The specific index (quizzes[index]) of the requested quiz

  • getRandomPractice(self, language):

    • Selects and returns a random practice for the specified language.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: The specific index (practices[index]) of the requested practice activity

  • getRandomFlash(self, language):

    • Selects and returns a random flashcard for the specified language.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: The specific index (practices[index]) of the requested flashcard activity

  • updateUserQuiz(self, username, quiz):

    • Updates the user's quiz score in the user collection.
    • Pre-conditions: None
    • Parameters: self, username, quiz
    • Returns: A successful call to the database when a specific user score is updated

  • readUserProgress(self, username):

    • Reads the user's conditions and prints out the user's contents of their progress from the database.
    • Pre-conditions: None
    • Parameters: self, username
    • Returns: Prints a success string if the client can print the user's progress in the database

  • get_all_users(self):

    • Selects and returns all of the users regardless of language
    • Pre-conditions: None
    • Parameters: self
    • Returns: The array of all users

  • get_random_fill_in_the_blank_set(self, language):

    • Selects and returns a random fill-in-the-blank set of any language
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: The array of all fill-in-the-blank sets

VocabQuiz​

Class Purpose:​

To generate a customized vocab quiz for the user based on their selected language

Data Fields: None​

Methods:​

  • init(self, ctx, user, quiz):

    • Initializes the quiz with context, user, and quiz data.
    • Pre-conditions: None
    • Parameters: self, ctx, user, quiz
    • Returns: None

  • get_question(self):

    • Gets a quiz question
    • Pre-conditions: None
    • Parameters: self
    • Returns: True, the ID # of the quiz, and the display of it in the discord UI

  • get_quiz_info(self):

    • Gets quiz information including score.
    • Pre-conditions: None
    • Parameters: self
    • Returns: Quiz ID #, Quiz Name, Quiz Score, User Token, User Language

SpeechRecognition​

Class Purpose:​

To show the user and display the result in a text channel and to be interpreted by other functions

Data Fields: None​

Methods:​

  • new(cls):

    • Initializes a new instance of the user voice input to be generated
    • Pre-conditions: None
    • Parameters: cls
    • Returns: A successfully developed user instance

  • initAPI(self) -> None:

    • Initializes OpenAI to start analyzing user voice input
    • Pre-conditions: None
    • Parameters: self
    • Returns: A successful call for the recognizer within OpenAI to start

  • speech_to_text(self, filename, language):

    • Converts the waveform speech into text
    • Pre-conditions: None
    • Parameters: self, filename, language
    • Returns: An array with a transcript of the user voice text

HelpCommand​

Class Purpose:​

To allow the user to use the /help command

Data Fields: None​

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: Sends an instance of the bot to the user

  • on_ready(self):

    • An event handler called when the cog is ready.
    • Pre-conditions: None
    • Parameters: self
    • Returns: Prints a success message to the console

  • help(self, ctx):

    • A command that displays help information as an embedded message in Discord.
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Displays all text for the user in the Discord Chat

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds feature to the cogs command archive

MyScores​

Class Purpose:​

To display the user scores of everyone on a server

Data Fields:​

  • database: An instance of the Database class

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: An active instance of the bot

  • on_ready(self):

    • An event handler called when the cog is ready.
    • Pre-conditions: None
    • Parameters: self
    • Returns: A success message to the console

  • myScores(self, ctx):

    • A command that allows the bot to display in the Discord Chat the scores of all users
    • Pre-conditions: None
    • Parameters: self, ctx, userprompt: str
    • Returns: A successful call to the database to display user scores

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds feature to the cogs command archive

Leaderboard​

Class Purpose:​

To display the top user scores on a given server

Data Fields:​

  • database: An instance of the Database class

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: An active instance of the bot

  • leaderboard(self, ctx):

    • Displays a leaderboard trophy next to the user with the highest score
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: A displayed image to the Discord UI indicating the highest-scored user

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds feature to the cogs command archive

ChangeLanguage​

Class Purpose:​

To allow the user to change its current learning language to any other on the "constant.py" file (either Spanish or French).

Data Fields:​

  • database: An instance of the Database class

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: An active instance of the bot

  • on_ready(self):

    • An event handler called when the cog is ready.
    • Pre-conditions: None
    • Parameters: self
    • Returns: A success message to the console

  • changeLanguage(self, ctx, userprompt: str):

    • A command that allows the user to change languages.
    • Pre-conditions: None
    • Parameters: self, ctx, userprompt: str
    • Returns: A successful call to the database to alter language

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds feature to the cogs command archive

StartVocabQuiz​

Class Purpose:​

To start the vocab quiz practice for a user in a text channel

Data Fields:​

  • database: An instance of the Database class

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: An active instance of the bot

  • on_ready(self):

    • An event handler called when the cog is ready.
    • Pre-conditions: None
    • Parameters: self
    • Returns: A success message to the console

  • startVocabQuiz(self, ctx):

    • A command that starts a vocabulary quiz.
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Sends a vocab quiz formatted to the Discord UI for the user to complete

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds the feature to the cogs command archive

StartVoiceQuiz​

Class Purpose:​

To start the voice quiz practice for a user in a voice channel

Data Fields:​

  • database: An instance of the Database class

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: An active instance of the bot

  • on_ready(self):

    • An event handler called when the cog is ready.
    • Pre-conditions: None
    • Parameters: self
    • Returns: A success message to the console

  • startVoiceQuiz(self, ctx):

    • A command that starts a voice quiz.
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Sends a voice quiz formatted to the Discord UI for the user to complete

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds the feature to the cogs command archive

Constant​

Class Purpose:​

Display all attributes that are considered constants throughout the entire codespace

Data Fields:​

  • LANGUAGE: What languages are available to the user
  • USER_LANGUAGE: What the user-selected language is
  • USER_TOTALSCORE: What the user's score is
  • USER_QUIZZES: The database array of all the quizzes
  • USER_TOOKON: The user's specific token
  • QUIZ_QUESTIONS: The database array of all the quiz questions
  • QUIZ_QUESTION: The array index of a specific question within a quiz
  • QUIZ_ANSWERS: The database array of all the quiz answers
  • QUIZ_ANSWER: The array index of a specific answer within a quiz
  • QUIZ_ISCORRECT: A boolean on whether a quiz answer was true or false
  • QUIZ_SCORE: An integer on what the user score was after a quiz is completed
  • QUIZ_NAME: The string name of a specific quiz
  • FILL_IN_THE_BLANKS_SET: The string name of the FITB set
  • FILL_IN_THE_BLANKS_QUESTION: The string name of the FITB question
  • FILL_IN_THE_BLANKS_CORRECT_ANSWER: The string answer of the FITB question
  • FILL_IN_THE_BLANKS_CHOICES: The string choices of the FITB choices
  • FILL_IN_THE_BLANKS_ENGLISH_MEANING: The string of the final FITB meaning
  • COLLECTION_ID: The integer ID of a specific user
  • DATE_FORMAT = "%d/%m/%Y %H:%M:%S": The string date format for date-based instances

Methods: none​

MatchResult​

Class Purpose:​

To calculate the number of correct words that a user said during a given pronunciation quiz

Data Fields: None​

Methods:​

  • match_sentence(expected_sentence,actual_sentence):

    • Calculates the # of correct words in a given pronunciation quiz
    • Pre-conditions: None
    • Parameters: expected_sentence, actual_sentence
    • Returns: The number of correct words said by the user divided by the length of the expected words in the given phrase

  • highlight_errors(expected_sentence,actual_sentence):

    • A method that highlights the errors present in user input within a pronunciation test
    • Pre-conditions: None
    • Parameters: expected_sentence, actual_sentence
    • Returns: Displays all errors occurring in user input on-screen

  • match_word(word, words):

    • A method that sends a boolean if the word is a match or not
    • Pre-conditions: None
    • Parameters: word, words
    • Returns: True if the user said word is a match

PronounPractice​

Class Purpose:​

A method that displays the Pronunciation Practice for the user for a given language.

Data Fields: None​

Methods:​

  • init(self, ctx, user, practice, textToSpeech, progressId = ""):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, ctx, user, practice, textToSpeech, progressId = ""
    • Returns: a setup instance of the bot with pre-assigned values aka "self"

  • play_sentence(self):

    • A method that played the selected sentence through the current user's voice channel
    • Pre-conditions: None
    • Parameters: self
    • Returns: Successfully plays the text-to-speech audio back to the user

  • get_question(self):

    • A method that collects a question response from the user's voice input
    • Pre-conditions: None
    • Parameters: self
    • Returns: True, the current sentence that the bot displayed for the user and displaying it on the Discord UI

  • once_done(self, sink: discord.sinks, channel: discord.TextChannel, *args):

    • A method to scan for user input during a pronunciation quiz to present the next question to the user.
    • Pre-conditions: None
    • Parameters: self, sink: discord.sinks, channel: discord.TextChannel, *args
    • Returns: Sends the next question to the user on the Discord UI

PronounTest​

Class Purpose:​

To scan the waveform and parse the user voice input into comparable strings

Data Fields:​

  • database: An instance of the Database class

Methods:​

  • init(self, ctx, user, practice):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, ctx, user, practice
    • Returns: a setup instance of the bot with pre-assigned values aka "self"

  • get_question(self):

    • A method that collects a question response from the user's voice input
    • Pre-conditions: None
    • Parameters: self
    • Returns: True, the current sentence that the bot displayed for the user and displaying it on the Discord UI

  • once_done(self, sink: discord.sinks, channel: discord.TextChannel, *args):

    • A method to scan for user input during a pronunciation quiz to present the next question to the user.
    • Pre-conditions: None
    • Parameters: self, sink: discord.sinks, channel: discord.TextChannel, *args
    • Returns: Sends the next question to the user on the Discord UI

  • get_quiz_info(self):

    • A method to collect all the info for the current quiz
    • Pre-conditions: None
    • Parameters: self
    • Returns: returns a full index of the current quiz

Test_Database​

Class Purpose:​

To test the different attributes of the database

Data Fields: None​

Methods:​

  • setUp(self):

    • Sets up the database with testing values
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_findUser_not_found(self):

    • A method to test if a user is not found
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_findUser_found(self):

    • A method to test if a user is found
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_insertUser(self):

    • A method to test if a user can be inserted into the database
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_changeLanguage(self):

    • A method to test if a set language can be changed
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getQuizzes_no_record(self):

    • A method to test if there are no records for a specific quiz
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getQuizzes_has_record(self):

    • A method to test if there are records for a specific quiz
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getRandomQuiz_no_record(self):

    • A method to test if there are no records for a random quiz
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getRandomQuiz_has_record(self):

    • A method to test if there are records for a random quiz
    • Pre-conditions: None
    • Parameters: self, sink: discord.sinks, channel: discord.TextChannel, *args
    • Returns: a successful test case

  • test_updateUserQuiz(self):

    • A method to test if you can update a user-given quiz
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_updateUserQuiz_raise_exception(self):

    • A method to test if you can update a user-given quiz with an added exception by modification
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getPractices_no_record(self):

    • A method to test if there are no records from a given practice
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getPractices_has_record(self):

    • A method to test if there are records from a given practice
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getRandomPractice_no_record(self):

    • A method to test if there are no records from a random practice
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_getRandomPractice_has_record(self):

    • A method to test if there are records from a random practice
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

  • test_readUser_throw_exception(self):

    • A method to test if an exception can be thrown when reading a user
    • Pre-conditions: None
    • Parameters: self
    • Returns: a successful test case

Test_HelpCommand​

Class Purpose:​

To test the different attributes of the help command

Data Fields: None​

Methods:​

  • ping(self, ctx):

    • To ping the bot to display a help command (in a testing context)
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Display successful in console

  • echo(self, ctx, text: str):

    • To echo or repeat the current ping to the console
    • Pre-conditions: None
    • Parameters: self, ctx, text: str
    • Returns: Send successful echo test to the console

  • bot():

    • An initializer method to set a simple instance of the bot and then teardown its global default message
    • Pre-conditions: None
    • Parameters: None
    • Returns: None

  • test_ping(bot):

    • To ping the bot to display a help command (in a testing context)
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Display successful in console

  • test_echo(bot):

    • To echo or repeat the current ping to the bot
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Send successful echo test to the bot

Test_Match​

Class Purpose:​

To test the attributes of the pronunciation test input

Data Fields: None​

Methods:​

  • test_score(self):

    • Tests a given sentence score between two strings
    • Pre-conditions: None
    • Parameters: self
    • Returns: A successful score between the two strings

  • test_score_exactmatch(self):

    • Tests a given sentence score between two exact strings
    • Pre-conditions: None
    • Parameters: self
    • Returns: A successful score between the two exact strings

Test_Voice​

Class Purpose:​

To test the attributes of the user voice input

Data Fields: None​

Methods:​

  • ping(self, ctx):

    • To ping the bot to start the voice test command
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Display successful in console

  • startVoiceQuiz(self, ctx):

    • To move to the user voice channel and begin the procedure
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Display a successful message to the user saying "Bot has joined (channel here)"

  • bot():

    • An initializer method to set a simple instance of the bot and then teardown its global default message
    • Pre-conditions: None
    • Parameters: None
    • Returns: None

  • test_ping(bot):

    • To ping the bot to start the voice command
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Display successful in console

  • test_startVoiceQuiz_notinvc(bot):

    • To test if the user is not in a voice channel to be recorded
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Display successful in the console that the user isn't in a channel

  • test_startVoiceQuiz_invc(bot):

    • To test if the user is in a voice channel to be recorded
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Display successfully in the console that the user is in a channel

Record​

Class Purpose:​

To record the user voice input and store it as a .wav file in the current instance

Data Fields: None​

Methods:​

  • once_done(sink: discord.sinks, channel: discord.TextChannel, *args):

    • A method to verify that voice input from the user is all collected
    • Pre-conditions: None
    • Parameters: sink: discord.sinks, channel: discord.TextChannel, *args
    • Returns: Successful print message to the discord UI saying that message has been recorded and verified

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: a setup instance of the bot with pre-assigned values aka "self"

  • record(self, ctx):

    • Records the user voice as an input to be analyzed and collected
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: A successful print message saying that the bot has started recording

  • stop(self, ctx):

    • To stop the recording and send it to other functions to be analyzed
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Sends successful response call to once_done() method above for verification

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds the feature to the cogs command archive

TextToSpeech​

Class Purpose:​

To activate the text-to-speech for a given text (regardless of language) to be audited to the user.

Data Fields: None​

Methods:​

  • init(self, language):

    • Initializes the method with a reference to all possible language output.
    • Pre-conditions: None
    • Parameters: self, language
    • Returns: a setup instance of the method with pre-assigned languages like "English"

  • text_to_speech(self, text):

    • Activates the Google gTTS instance of that text given to the user
    • Pre-conditions: None
    • Parameters: self, text
    • Returns: A successful save of the TTS recording saved to "audios/voice.mp3"

FillInTheBlanks​

Class Purpose:​

To generate the Fill-in-the-blank activity for the user to interact with via the bot.

Data Fields: None​

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: a setup instance of the bot with pre-assigned values aka "self"

  • on_ready(): void

    • An event handler called when the Discord bot is ready. It prints a message to the console and sends a message to a specific channel.
    • Pre-conditions: None
    • Parameters: None
    • Returns: Prints "Hello, I'm now online!" string if the channel is active for the bot to enter.

  • fill_in_the_blanks(self, ctx, *, language: str = None):

    • Presents the fill-in-the-blanks ordered question to the user in the current discord text channel.
    • Pre-conditions: None
    • Parameters: self, ctx, *, language: str = None
    • Returns: Successfully prints to the user's current text channel

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds the feature to the cogs command archive

MyProgress​

Class Purpose:​

To generate the current progression for a specific user.

Data Fields: None​

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: a setup instance of the bot with pre-assigned values aka "self"

  • on_ready(): void

    • An event handler called when the Discord bot is ready. It prints a message to the console and sends a message to a specific channel.
    • Pre-conditions: None
    • Parameters: None
    • Returns: Prints "MyProgress command is online." string if the channel is active for the bot to enter.

  • myProgress(self, ctx):

    • Presents the current progress in the language course for a user.
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Successfully prints the user's current progress of the course within their text channel

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds the feature to the cogs command archive

StartFlash​

Class Purpose:​

To generate the Flashcard activity for the user to interact with via the bot.

Data Fields: None​

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: a setup instance of the bot with pre-assigned values aka "self"

  • on_ready(self):

    • An event handler called when the Discord bot is ready. It prints a message to the console and sends a message to a specific channel.
    • Pre-conditions: None
    • Parameters: self
    • Returns: Prints "MyProgress command is online." string if the channel is active for the bot to enter.

  • startFlash(self, ctx):

    • Presents the flashcard activity for a user in their current text channel.
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Successfully prints the user's current progress of the course within their text channel

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds the feature to the cogs command archive

StartListeningQuiz​

Class Purpose:​

To generate the Listening Quiz activity for the user to interact with via the bot.

Data Fields: None​

Methods:​

  • init(self, bot):

    • Initializes the cog with a reference to the bot.
    • Pre-conditions: None
    • Parameters: self, bot
    • Returns: a setup instance of the bot with pre-assigned values aka "self"

  • on_ready(self):

    • An event handler called when the Discord bot is ready. It prints a message to the console and sends a message to a specific channel.
    • Pre-conditions: None
    • Parameters: self
    • Returns: Prints "MyProgress command is online." string if the channel is active for the bot to enter.

  • startListeningQuiz(self, ctx):

    • Presents the listening quiz activity for a user in their current text channel.
    • Pre-conditions: None
    • Parameters: self, ctx
    • Returns: Successfully presents the listening quiz activity to the user

  • setup(bot):

    • Internal method for setting up the cog.
    • Pre-conditions: None
    • Parameters: bot
    • Returns: Prints a success message to the console and adds the feature to the cogs command archive
Edit this page
Revision Historynothing
AuthorRevisionDate
Last updated by Alan Saji