Aller au contenu principal
Version: v1

roleSetup

Cette classe fournit des méthodes pour interagir avec la base de données. Elle est utilisée pour effectuer des opérations telles que la création, la mise à jour, la suppression et la consultation de documents.

info

La v2 a ajouté les Tableaux de rôles.

En conséquence, il est recommandé de gérer à la fois les tableaux et les chaînes pour les méthodes find et fetch, surtout si vous avez déjà utilisé la v2.

Méthodes

roleSetup.add()

Ajoute un rôle à la configuration des rôles.

Paramètres

ParamètreTypeRequisDescription
clientClientLe client Discord.
guildIdstringL'ID de la guilde de la configuration des rôles.
optionsLevelAddOptionsLes options pour l'ajout du rôle.

Retour

  • Promise<boolean> - true si le rôle a été ajouté avec succès.

Erreurs

  • new Error() - Si un type ou une valeur invalide est fourni.

roleSetup.find()

Recherche un rôle dans la configuration des rôles.

Paramètres

ParamètreTypeRequisDescription
guildIdstringL'ID de la guilde de la configuration des rôles.
levelnumberLe numéro du niveau recherché.

Retour

  • Promise<{ lvl: number, role: string || string[] }> - L'objet de configuration du rôle trouvé.

Erreurs

  • new Error() - Si un type ou une valeur invalide est fourni.

roleSetup.fetch()

Liste tous les rôles de niveau d'une guilde.

Paramètres

ParamètreTypeRequisDescription
clientClientLe client Discord.
guildIdstringL'ID de la guilde.

Retour

  • Promise<Array<{ lvl: number, role: string || string[] }>> - Tableau des objets de configuration des rôles.

Erreurs

  • XpFatal - S'il n'y a aucun rôle de niveau dans la guilde.

roleSetup.remove()

Supprime un rôle de la configuration des rôles.

Paramètres

ParamètreTypeRequisDescription
clientClientLe client Discord.
guildIdstringL'ID de la guilde.
optionsLevelRemoveOptionsLes options pour la suppression du rôle.

Retour

  • Promise<boolean> - true si le rôle a été supprimé avec succès.

Erreurs

  • new Error() - Si un type ou une valeur invalide est fourni.

LevelAddOptions

OptionsTypeRequisDescription
levelnumberNiveau auquel ajouter le rôle.
roleRole IDID du rôle à ajouter.

LevelRemoveOptions

OptionsTypeRequisDescription
levelnumberNiveau depuis lequel retirer les rôles.