GuildMember

Un GuildMember est un utilisateur en tant que membre d’un serveur : la même personne a un seul User, et un GuildMember par serveur où elle se trouve. Vous en obtenez un comme member d’une commande utilisée sur un serveur, avec les événements sur les membres et les messages, et depuis guild.members ou guild.fetchMember().

import type { GuildMember } from 'chapterjs';

async function mute(member: GuildMember, moderator: GuildMember) {
  if (!moderator.permissions.has('ModerateMembers')) return 'Vous n’avez pas le droit de faire cela.';
  if (!moderator.isHigherThan(member)) return 'Vous ne pouvez exclure que les membres en dessous de vous.';
  await member.timeout(10 * 60 * 1000, `Exclu par ${moderator.displayName}`);
  return `${member.displayName} est exclu pour 10 minutes.`;
}

Comment vos fonctions reçoivent un membre est dans Commandes et Événements. De quels membres le bot se souvient est dans Mémoire.

Propriétés

Snowflake

L’identifiant du serveur.

User

Le compte du membre.

Snowflake

L’identifiant de l’utilisateur.

Guild

Le serveur où se trouve le membre.

string | null

Le surnom du membre sur ce serveur, quand il en a un.

string

Le nom à afficher : le surnom, sinon le nom d’affichage, sinon le nom d’utilisateur.

readonly Snowflake[]

Les identifiants des rôles du membre (@everyone n’est pas listé).

Role[]

Les rôles du membre, @everyone compris, le plus haut en premier.

Role

Le rôle le plus haut du membre dans la hiérarchie ; @everyone au moins.

VoiceChannel | null

Le salon vocal où se trouve le membre ; null quand il n’est dans aucun. Le bot le sait quand Discord lui envoie les états vocaux : dans un projet avec un fichier qui rejoint un salon vocal ou écoute un événement vocal.

Date | null

Quand le membre a rejoint le serveur.

Date | null

Depuis quand le membre booste le serveur.

boolean

Si le membre n’a pas encore passé le filtrage d’adhésion.

Date | null

Jusqu’à quand le membre est exclu temporairement ; null quand il ne l’est pas.

boolean

Si le membre est exclu temporairement en ce moment.

boolean

Si le serveur appartient au membre.

Permissions

Ce que le membre peut faire sur le serveur (les salons peuvent le changer : voir permissionsIn). Voir Permissions.

Helpers

Ils lisent ce dont le bot se souvient : ils n’envoient jamais de requête.

permissionsIn()

permissionsIn(channel: GuildChannel): Permissions

Ce que le membre peut faire dans un salon du serveur.

avatarURL()

avatarURL(options?: ImageOptions): string

L’avatar du membre sur ce serveur, sinon celui de son compte. Voir ImageOptions.

isHigherThan()

isHigherThan(other: GuildMember): boolean

Si ce membre est au-dessus d’un autre dans la hiérarchie des rôles, ce qui permet de l’expulser, de le bannir ou de le renommer. Documentation de Discord

hasRole()

hasRole(role: Snowflake | Role): boolean

Si le membre a un rôle.

toString()

toString(): string

<@id> : mentionne le membre quand il est mis dans un message.

toJSON()

toJSON(): object

Les données de Discord sous forme d’objet simple, avec des noms en camelCase.

Actions

edit()

edit(options: MemberEditOptions, reason?: string): Promise<GuildMember>

Modifie le membre. Voir MemberEditOptions. Documentation de Discord

setNick()

setNick(nick: string | null, reason?: string): Promise<GuildMember>

Change le surnom du membre ; null le retire.

addRole()

addRole(role: Snowflake | Role, reason?: string): Promise<void>

Donne un rôle au membre. Documentation de Discord

removeRole()

removeRole(role: Snowflake | Role, reason?: string): Promise<void>

Retire un rôle au membre. Documentation de Discord

timeout()

timeout(duration: number, reason?: string): Promise<GuildMember>

Empêche le membre d’écrire, de réagir et de parler pendant un moment. duration est la durée, en millisecondes (28 jours au plus).

removeTimeout()

removeTimeout(reason?: string): Promise<GuildMember>

Met fin à l’exclusion temporaire du membre.

kick()

kick(reason?: string): Promise<void>

Retire le membre du serveur ; il peut revenir avec une invitation. Documentation de Discord

ban()

ban(options?: BanOptions): Promise<void>

Bannit le membre du serveur. Voir BanOptions. Documentation de Discord

send()

send(message: MessageInput): Promise<Message>

Envoie un message privé au membre. Voir MessageInput.

Types

BanOptions

Ce que prend ban(), sur un membre ou sur un serveur. Chaque champ peut être laissé de côté.

string

Pourquoi, affiché dans le journal d’audit du serveur.

number

Supprime aussi les messages que l’utilisateur a envoyés pendant les dernières secondes données : de 0 (par défaut, rien) à 604800 (7 jours).

MemberEditOptions

Ce que prend edit(). Chaque champ peut être laissé de côté : seul ce que vous passez change.

string | null

Le surnom ; null le retire.

(Snowflake | Role)[]

Remplace tous les rôles du membre.

boolean

Rend le membre muet dans les salons vocaux.

boolean

Rend le membre sourd dans les salons vocaux.

Snowflake | { id: Snowflake } | null

Déplace le membre vers un autre salon vocal ; null le déconnecte.

Date | null

Jusqu’à quand le membre est exclu temporairement ; null met fin à l’exclusion.

Référence

Vos fichiers

Structures

Types

CLI

Propriétés

Helpers

permissionsIn()

avatarURL()

isHigherThan()

hasRole()

toString()

toJSON()

Actions

edit()

setNick()

addRole()

removeRole()

timeout()

removeTimeout()

kick()

ban()

send()

Types

BanOptions

MemberEditOptions