API Documentation Github

Class

TeamFormation

TeamFormation(teamFormationInfo)

TeamFormation The team formation class represents the team formation activity. It helps teams and prospects find each other by adding their respective information to a catalogue of sorts. Admins have the ability to customize the messages sent, emojis used, and if they want users to be notified of new posts in the catalogue.
Constructor

# new TeamFormation(teamFormationInfo)

Create a new team formation.
Parameters:
Name Type Description
teamFormationInfo TeamFormationInfo the team formation information

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

Members

TeamFormationChannels

# channels

The channels that a team formation activity needs.

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

Boolean

# isNotificationEnabled

True if the parties will be notified when the opposite party has a new post.

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

TeamFormationPartyInfo

# prospectInfo

The prospect info, those solo users that want to join a team will use this info.

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

SignupEmbedCreator

# signupEmbedCreator

A creator of the info embed in case you want it to be different.

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

TeamFormationPartyInfo

# teamInfo

The team information, those teams willing to join will use this.

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

Methods

# async static createProspectRole(roleManager) → {Promise.<Role>}

Creates the prospect role and returns it.
Parameters:
Name Type Description
roleManager RoleManager

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

Promise.<Role>

# async static createTeamRole(roleManager) → {Promise.<Role>}

Creates the team role and returns it.
Parameters:
Name Type Description
roleManager RoleManager

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

Promise.<Role>

# async createChannels()

Will create the TeamFormationChannels object with new channels to use with a new TeamFormation

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

# async gatherForm(user, isTeam) → {Promise.<Message>}

Will gather the form from a user to add to the catalogues and send it to the correct channel.
Parameters:
Name Type Description
user User the user being prompted
isTeam Boolean true if the user is a team looking for members

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

Error if user cancels or takes too long to respond to prompt
- the catalogue message
Promise.<Message>

# async reachOutToUser(user, isTeam)

Will reach out to the user to ask for the form response to add to the catalogue.
Parameters:
Name Type Description
user User the user joining the team formation activity
isTeam Boolean true if the user represents a team, else false

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

# async start(signupEmbedCreatoropt)

Will start the activity!
Parameters:
Name Type Attributes Default Description
signupEmbedCreator SignupEmbedCreator <optional>
 null embed creator for the sign in

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