LeaderboardRoles

Extends

• BaseHandler

Constructors

new LeaderboardRoles()

new LeaderboardRoles(handler): LeaderboardRoles

Parameters

Parameter	Type
handler	RequestHandler

Returns

LeaderboardRoles

Inherited from

BaseHandler.constructor

Properties

Property	Modifier	Type	Inherited from
_handler	public	RequestHandler	BaseHandler._handler

Methods

clearLeaderboardRoles()

clearLeaderboardRoles(guildId): Promise<SuccessResponse>

Delete all leaderboard roles for a guild

Parameters

Parameter	Type	Description
guildId	string	The guild ID to delete roles from

Returns

Promise<SuccessResponse>

---

createLeaderboardRole()

createLeaderboardRole(guildId, data): Promise<SuccessResponse>

Create a new leaderboard role

Parameters

Parameter	Type	Description
guildId	string	The guild ID to create the role in
data	Omit<LeaderboardRole, "id" | "guildId">	The role data

Returns

Promise<SuccessResponse>

---

deleteLeaderboardRole()

deleteLeaderboardRole(guildId, roleId): Promise<SuccessResponse>

Delete a specific leaderboard role

Parameters

Parameter	Type	Description
guildId	string	The guild ID the role is in
roleId	string	The role ID to delete

Returns

Promise<SuccessResponse>

---

getLeaderboardRoles()

getLeaderboardRoles(guildId): Promise<LeaderboardRole[]>

Get all leaderboard roles for a guild

Parameters

Parameter	Type	Description
guildId	string	The guild ID to get roles for

Returns

Promise<LeaderboardRole[]>