roleSetup
Cette classe fournit des méthodes permettant d'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 l'interrogation de documents, la suppression et l'interrogation de documents.
Méthodes
roleSetup.add()
Ajoute un rôle à la configuration des rôles.
Paramètres
| Paramètre | Type | Requis | Description | 
|---|---|---|---|
| guildId | string | ✅ | Le GuildID de la configuration des rôles. | 
| options | RoleSetupObject | ✅ | Les options pour la configuration des rôles. | 
Retours
- Promise<
boolean> - Si le rôle a été ajouté avec succès. 
Throws
XpFatal- Si un type ou une valeur invalide est fourni.
roleSetup.getRoles()
Récupère les rôles du niveau actuel de l'utilisateur, avec des options pour inclure plus de rôles.
Paramètres
| Paramètre | Type | Requis | Description | 
|---|---|---|---|
| userId | string | ✅ | L'ID de l'utilisateur. | 
| guildId | string | ✅ | Le GuildID de la configuration des rôles. | 
| options | GetRolesOptions | ❌ | Les options pour la configuration des rôles. | 
Retours
- Promise<
string[]> - Les rôles de l'utilisateur (ou un tableau vide s'il n'y en a pas). 
Throws
XpFatal- Si des paramètres invalides sont fournis.
roleSetup.find()
Trouve un rôle dans la configuration des rôles.
Paramètres
| Paramètre | Type | Requis | Description | 
|---|---|---|---|
| guildId | string | ✅ | Le GuildID de la configuration des rôles. | 
| levelNumber | number | ✅ | Le numéro de niveau de la configuration. | 
Retours
- Promise<
RoleSetupObject> - L'objet de configuration des rôles. 
Throws
XpFatal- Si un type ou une valeur invalide est fourni.
roleSetup.list()
Liste les rôles de la configuration des rôles.
Paramètres
| Paramètre | Type | Requis | Description | 
|---|---|---|---|
| guildId | string | ✅ | Le GuildID de la configuration des rôles. | 
Retours
- Promise<
RoleSetupObject[]> - Les objets de configuration des rôles. 
Throws
XpFatal- Si un type ou une valeur invalide est fourni.
roleSetup.remove()
Supprime un rôle de la configuration des rôles.
Paramètres
| Paramètre | Type | Requis | Description | 
|---|---|---|---|
| guildId | string | ✅ | Le GuildID de la configuration des rôles. | 
| levelNumber | number | ✅ | Le numéro de niveau de la configuration. | 
Retours
- Promise<
boolean> - Si le rôle a été supprimé avec succès. 
Throws
XpFatal- Si un type ou une valeur invalide est fourni.