Members
Methods
# async static createAdminChannels(guild, adminRole, everyoneRole) → {Promise.<{TextChannel, TextChannel}>}
Will create the admin channels with the correct roles.
Parameters:
| Name | Type | Description |
|---|---|---|
guild |
Guild | |
adminRole |
Role | |
everyoneRole |
Role |
- {Admin Console, Admin Log Channel}
Promise.<{TextChannel, TextChannel}>
# addStamp(roleId, stampNumber)
Adds a stamp to the stamp collection. Does not save the mongoose document!
Parameters:
| Name | Type | Description |
|---|---|---|
roleId |
String | |
stampNumber |
Number |
# async readyUp(botGuildInfo, client) → {Promise.<BotGuild>}
Will set the minimum required information for the bot to work on this guild.
Parameters:
| Name | Type | Description |
|---|---|---|
botGuildInfo |
BotGuildInfo | |
client |
CommandoClient |
Promise.<BotGuild>
# async setCommandStatus(client)
Will enable and disable the appropriate commands by looking at what is enabled in the botGuild.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
CommandoClient |
# async setUpAnnouncements(client, announcementChannelID)
Will set up the firebase announcements.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
CommandoClient | |
announcementChannelID |
String |
# async setUpAsk(client)
Will enable the ask command.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
CommandoClient |
# async setUpAttendance(client, attendeeRoleID) → {Promise.<BotGuild>}
Sets up the attendance functionality.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
CommandoClient | |
attendeeRoleID |
String |
Promise.<BotGuild>
# async setUpReport(client, incomingReportChannelID) → {Promise.<BotGuild>}
Enables the report commands and sends the reports to the given channel.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
CommandoClient | |
incomingReportChannelID |
String |
Promise.<BotGuild>
# async setUpStamps(client, stampAmountopt, stampCollectionTimeopt, stampRoleIDsopt) → {Promise.<BotGuild>}
Creates the stamps roles and adds them to this BotGuild. If stamps roles are given
then no roles are created!
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
client |
CommandoClient | |||
stampAmount |
Number |
<optional> |
0 | amount of stamps to create |
stampCollectionTime |
Number |
<optional> |
60 | time given to users to send password to get stamp |
stampRoleIDs |
Array.<String> |
<optional> |
current stamp roles to use |
Promise.<BotGuild>
# async setUpVerification(client, guestRoleId, types, verificationChannelsopt) → {Promise.<BotGuild>}
Will set up the verification process.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
client |
CommandoClient | |||
guestRoleId |
String | |||
types |
Array.<TypeInfo> | |||
verificationChannels |
VerificationChannels |
<optional> |
null |
Promise.<BotGuild>
# validateBotGuildInfo(botGuildInfo)
Validate the information.
Parameters:
| Name | Type | Description |
|---|---|---|
botGuildInfo |
BotGuildInfo | the information to validate |
Error if the botGuildInfo is incomplete