API Documentation Github

Class

CoffeeChats

CoffeeChats(activityInfo, numOfTeams)

A CoffeeChat is a special activity where teams get shuffled around voice channels to talk with other teams or members like mentors. Users can join the activity by reacting to a message. Groups are of unlimited size but must be pre-made. The activity will not create groups. Admins get additional features to run this activity. These features let shuffle the groups around the available voice channels.
Constructor

# new CoffeeChats(activityInfo, numOfTeams)

Basic constructor for a coffee chats.
Parameters:
Name Type Description
activityInfo Activity.ActivityInfo
numOfTeams Number

View Source classes/activities/coffee-chats.js, line 14

Extends

Members

Console

# adminConsole

The admin console with activity features.
Overrides:

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

BotGuildModel

# botGuild

The mongoose BotGuildModel Object
Overrides:

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

Guild

# guild

The guild this activity is in.
Overrides:

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

TextChannel

# joinActivityChannel

The channel where users join the activity.

View Source classes/activities/coffee-chats.js, line 40

VoiceChannel

# mainVoiceChannel

The main voice channel where everyone starts.

View Source classes/activities/coffee-chats.js, line 46

VoiceChannel

# mainVoiceChannel

View Source classes/activities/coffee-chats.js, line 62

string

# name

The name of this activity.
Overrides:

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

Number

# numOfTeams

The number of groups available in this coffee chat

View Source classes/activities/coffee-chats.js, line 34

Room

# room

The room this activity lives in.
Overrides:

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

Collection.<Number, Array.<GuildMember>>

# teams

A collection of the groups that will attend this coffee chat.

View Source classes/activities/coffee-chats.js, line 28

Methods

# async addChannel(channel, userId)

Add a channel to the activity, prompts user for info and name.
Parameters:
Name Type Description
channel TextChannel channel to prompt user for specified voice channel
userId String user to prompt for specified voice channel
Overrides:

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

# protected addDefaultFeatures()

Adds the default features to the activity, these features are available to all activities.
Overrides:

View Source classes/activities/coffee-chats.js, line 91

# addTeamSlot()

Add a team slot to the activity and adds a voice channel for them.

View Source classes/activities/coffee-chats.js, line 222

# async archive(archiveCategory)

Archive the activity. Move general text channel to archive category, remove all remaining channels and remove the category.
Parameters:
Name Type Description
archiveCategory CategoryChannel the category where the general text channel will be moved to
Overrides:

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

# async delete()

Delete all the channels and the category. Remove the workshop from firebase.
Overrides:

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

# async distributeStamp(channel, userId)

Will let hackers get a stamp for attending the activity.
Parameters:
Name Type Description
channel TextChannel channel to prompt user for specified voice channel
userId String user to prompt for specified voice channel
Overrides:

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

# groupShuffle()

Shuffle users from general voice to all other voice channel. Groups will stay on the same voice channel.

View Source classes/activities/coffee-chats.js, line 190

# async init(channel, userId) → {Promise.<CoffeeChats>}

Initializes the activity by creating the necessary channels.
Parameters:
Name Type Description
channel TextChannel
userId String
Overrides:

View Source classes/activities/coffee-chats.js, line 58

Promise.<CoffeeChats>

# async removeChannel(channel, userId)

Removes a channel from the activity, the user will decide which. Wont delete channels in the safeChannel map.
Parameters:
Name Type Description
channel TextChannel channel to prompt user for specified voice channel
userId String user to prompt for specified voice channel
Overrides:

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

# resetTeams()

Resets the teams to have no teams.

View Source classes/activities/coffee-chats.js, line 214

# async roleShuffle(channel, userId)

Shuffles users with a specific role throughout the activity's voice channels
Parameters:
Name Type Description
channel TextChannel channel to prompt user for specified voice channel
userId String user to prompt for specified voice channel
Overrides:

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

# async ruleValidation(channel, userId)

Will lock the channels behind an emoji collector.
Parameters:
Name Type Description
channel TextChannel channel to prompt user for specified voice channel
userId String user to prompt for specified voice channel
Overrides:

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

# async voiceCallBack(channel, userId)

Move all users back to a specified voice channel from the activity's voice channels.
Parameters:
Name Type Description
channel TextChannel channel to prompt user for specified voice channel
userId String user to prompt for specified voice channel
Overrides:

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