Aller au contenu principal

LevelRoles

Cette classe gère les rôles attribués selon le niveau. Elle permet d'ajouter, supprimer, lister et rechercher des level-roles, et fonctionne avec MongoDB et SQLite via l'API db partagée.

Methods

LevelRoles.add()

Ajoute des rôles à un niveau. Si le niveau existe déjà, les rôles fournis sont fusionnés (doublons retirés).

Parameters

ParameterTypeRequiredDescription
guildIdstringL'ID de la guilde.
optionsLevelRoleLe niveau et les rôles à ajouter.

Returns

  • Promise<boolean> - true si l'opération a réussi.

Throws

  • XpFatal - Si des paramètres invalides sont fournis.

LevelRoles.delete()

Supprime certains ou tous les rôles d'un niveau. Si options.roles est omis, tous les rôles du niveau sont supprimés.

Parameters

ParameterTypeRequiredDescription
guildIdstringL'ID de la guilde.
optionsLevelRoleLe niveau et les rôles à supprimer.

Returns

  • Promise<boolean> - true si l'opération a réussi.

LevelRoles.deleteAll()

Supprime toutes les entrées level-role pour une guilde.

Parameters

ParameterTypeRequiredDescription
guildIdstringL'ID de la guilde.

Returns

  • Promise<boolean> - true si l'opération a réussi.

LevelRoles.getGuildRoles()

Récupère toutes les entrées level-role d'une guilde.

Parameters

ParameterTypeRequiredDescription
guildIdstringL'ID de la guilde.

Returns


LevelRoles.getUserRoles()

Retourne les IDs de rôles applicables au niveau d'un utilisateur. Les options déterminent si les rôles du niveau actuel, suivant ou précédent sont inclus. Par défaut, seul le niveau actuel est pris en compte.

Parameters

ParameterTypeRequiredDescription
userIdstringL'ID de l'utilisateur.
guildIdstringL'ID de la guilde.
optionsGetRolesOptionsOptions pour inclure le niveau suivant/précédent.

Returns

  • Promise<string[]> - Tableau d'IDs de rôles (ou tableau vide).

LevelRoles.set()

Définit (écrase) les rôles pour un niveau spécifique.

Parameters

ParameterTypeRequiredDescription
guildIdstringL'ID de la guilde.
optionsLevelRoleLe niveau et les rôles à définir.

Returns

  • Promise<boolean> - true si l'opération a réussi.