Class: PermissionsManager

PermissionsManager

Handles permissions depending on roles.

Constructor

new PermissionsManager()

Source:

Members

adminRoles :Array.<string>

Array of admin role names
Type:
  • Array.<string>
Source:

admins :Array.<string>

Array of admin user IDs
Type:
  • Array.<string>
Source:

djRoles :Array.<string>

Array of DJ role names
Type:
  • Array.<string>
Source:

owner :Array.<string>

Array of owner user IDs
Type:
  • Array.<string>
Source:

Methods

hasRoles(roles, user, guild) → {boolean}

Checks if an user has certain roles (by name). Note: Only one of the roles passed is required for this to return a positive value.
Parameters:
Name Type Description
roles string | Array.<string> Role name(s) to check.
user object The user to check. Can also be a Discordie IGuildMember.
guild object The guild to check. Not needed if user is an IGuildMember.
Source:
Returns:
Type
boolean

isAdmin(user, guild, globalOnly) → {boolean}

Checks if an user has admin rights.
Parameters:
Name Type Description
user object The user to check. Can also be a Discordie IGuildMember.
guild object The guild to check. Not needed if user is an IGuildMember.
globalOnly boolean Check only for global admins.
Source:
Returns:
Type
boolean

isDJ(user, guild) → {boolean}

Checks if an user has DJ roles.
Parameters:
Name Type Description
user object The user to check. Can also be a Discordie IGuildMember.
guild object The guild to check. Not needed if user is an IGuildMember.
Source:
Returns:
Type
boolean

isGuildOwner(user, guild) → {boolean}

Checks if an user is the guild owner.
Parameters:
Name Type Description
user object The user or member to check
guild object The guild to check
Source:
Returns:
Type
boolean

isOwner(user) → {boolean}

Check if an user is the bot owner
Parameters:
Name Type Description
user object User to check
Source:
Returns:
Type
boolean