Passer au contenu principal
Les méthodes qui créent ou modifient quelque chose prennent un objet d’options. Ses champs sont ceux de Discord, écrits en camelCase ; votre éditeur les complète.
Ces options appartiennent aux actions de Guild, des salons et de Role. Ce que prend un message est dans Options des messages, ce que prend un membre dans GuildMember.
Quelques règles valent partout :
  • À la modification, seul ce que vous passez change. null retire une valeur quand le type le permet.
  • Les images sont des data URI : data:image/png;base64,....
  • Les identifiants sont des Snowflake : l’id d’une structure, ou le texte copié depuis Discord.
  • Les permissions s’écrivent par leur nom ('ManageThreads'), jamais sous forme de nombres : voir Permissions.

GuildEditOptions

Ce que prend edit() sur un serveur : seul ce qui est passé change. Les images sont des data URI (data:image/png;base64,...).
string
Le nom du serveur.
VerificationLevel | null
Ce que Discord demande aux nouveaux membres avant qu’ils puissent écrire : une valeur de VerificationLevel.
DefaultMessageNotificationLevel | null
Si les membres reçoivent par défaut une notification pour chaque message ou seulement quand ils sont mentionnés : une valeur de DefaultMessageNotificationLevel.
ExplicitContentFilterLevel | null
Les images et vidéos de qui Discord analyse à la recherche de contenu explicite : une valeur de ExplicitContentFilterLevel.
Snowflake | null
L’identifiant du salon vocal où sont déplacés les membres inactifs.
number
Au bout de combien de secondes d’inactivité un membre y est déplacé : 60, 300, 900, 1800 ou 3600.
string | null
L’icône : un PNG, JPEG ou GIF de 1024x1024 (un GIF animé seulement quand le serveur a la fonctionnalité ANIMATED_ICON).
string | null
L’arrière-plan de la page d’invitation : un PNG ou JPEG en 16:9 (quand le serveur a la fonctionnalité INVITE_SPLASH).
string | null
L’arrière-plan affiché dans la découverte de serveurs : un PNG ou JPEG en 16:9 (quand le serveur a la fonctionnalité DISCOVERABLE).
string | null
La bannière : un PNG ou JPEG en 16:9 (quand le serveur a la fonctionnalité BANNER ; un GIF animé quand il a la fonctionnalité ANIMATED_BANNER).
Snowflake | null
L’identifiant du salon où Discord publie les messages de bienvenue et les avis de boost.
number
Lesquels de ces avis sont masqués, sous forme de champ de bits.
Snowflake | null
L’identifiant du salon qui affiche le règlement, sur un serveur Communauté.
Snowflake | null
L’identifiant du salon où les administrateurs et modérateurs d’un serveur Communauté reçoivent les avis de Discord.
Locale | null
La langue d’un serveur Communauté, utilisée dans la découverte de serveurs et dans les avis qu’envoie Discord ; 'en-US' par défaut. Une valeur de Locale.
GuildFeature[]
Les fonctionnalités activées sur le serveur : voir GuildFeature.
string | null
La description du serveur.
boolean
Si la barre de progression des boosts est affichée.
Snowflake | null
L’identifiant du salon où les administrateurs et modérateurs d’un serveur Communauté reçoivent les alertes de sécurité de Discord.
Documentation de Discord

ChannelCreateOptions

Ce que prend createChannel() : un nom, un type, et les réglages de cette sorte de salon.
Seul name est nécessaire : sans type, Discord crée un salon textuel. Les autres champs ne s’appliquent qu’à la sorte de salon qu’ils décrivent.
string
requis
Le nom du salon (1 à 100 caractères).
ChannelType | null
La sorte de salon : une valeur de ChannelType.
string | null
Le sujet affiché en haut du salon (0 à 1024 caractères).
number | null
La qualité audio d’un salon vocal ou de conférence, en bits par seconde ; 8000 au moins.
number | null
Combien de personnes peuvent rejoindre un salon vocal.
number | null
Mode lent : combien de secondes un membre attend entre deux messages (0 à 21600). Les bots et les membres avec la permission BypassSlowmode ne sont pas concernés.
number | null
Où se trouve le salon dans la liste (les salons de même position sont triés par identifiant).
object[] | null
Ce que les rôles et les membres ont le droit ou non de faire dans le salon.
Snowflake | null
L’identifiant de la catégorie où mettre le salon.
boolean | null
Si le salon est soumis à une limite d’âge.
string | null
La région vocale d’un salon vocal ou de conférence ; null laisse Discord la choisir.
VideoQualityMode | null
La qualité des caméras d’un salon vocal : une valeur de VideoQualityMode.
number | null
Au bout de combien de minutes sans activité l’app Discord propose d’archiver un nouveau fil du salon.
object | null
L’emoji du bouton « ajouter une réaction » sur les publications d’un salon forum ou média.
ForumTag[] | null
Les étiquettes que peuvent avoir les publications d’un salon forum ou média : voir ForumTag. Une nouvelle étiquette n’a pas encore d’id : Discord lui en donne un.
ForumSortOrderType | null
Comment sont triées les publications d’un salon forum ou média : une valeur de ForumSortOrderType.
ForumLayoutType | null
Comment sont affichées les publications d’un forum : une valeur de ForumLayoutType.
number | null
Le mode lent donné aux nouveaux fils du salon. Il est copié à la création du fil et ne suit pas les changements ultérieurs.
number | null
Les drapeaux du salon, sous forme de champ de bits.
Documentation de Discord

GuildChannelEditOptions

Ce que prend edit() sur un salon d’un serveur.
Cela fonctionne sur chaque salon d’un serveur qui n’est pas un fil : salons textuels, vocaux, catégories et forums. Un champ qui ne s’applique pas à la sorte de salon est refusé par Discord.
string
Le nom du salon (1 à 100 caractères).
ChannelType
La sorte de salon : une valeur de ChannelType. Seul un salon textuel peut devenir un salon d’annonces et inversement, sur un serveur qui a la fonctionnalité NEWS.
number | null
Où se trouve le salon dans la liste (les salons de même position sont triés par identifiant).
string | null
Le sujet affiché en haut du salon : 0 à 1024 caractères, ou 0 à 4096 pour un salon forum ou média.
boolean | null
Si le salon est soumis à une limite d’âge.
number | null
Mode lent : combien de secondes un membre attend entre deux messages (0 à 21600). Les bots et les membres avec la permission BypassSlowmode ne sont pas concernés.
number | null
La qualité audio d’un salon vocal ou de conférence, en bits par seconde ; 8000 au moins.
number | null
Combien de personnes peuvent rejoindre : jusqu’à 99 dans un salon vocal, 10 000 dans un salon de conférence ; 0 veut dire pas de limite.
object[] | null
Ce que les rôles et les membres ont le droit ou non de faire dans le salon ou la catégorie : les mêmes objets que dans ChannelCreateOptions.
Snowflake | null
L’identifiant de la catégorie où déplacer le salon.
string | null
La région vocale du salon ; null laisse Discord la choisir.
VideoQualityMode | null
La qualité des caméras d’un salon vocal : une valeur de VideoQualityMode.
number | null
Au bout de combien de minutes sans activité l’app Discord propose d’archiver un nouveau fil du salon.
number
Les drapeaux du salon, sous forme de champ de bits.
ForumTag[]
Les étiquettes que peuvent avoir les publications d’un salon forum ou média, 20 au plus : voir ForumTag. Une étiquette sans id est nouvelle ; les autres gardent le leur.
object | null
L’emoji du bouton « ajouter une réaction » sur les publications d’un salon forum ou média : { emojiId, emojiName }, comme dans ChannelCreateOptions.
number
Le mode lent donné aux nouveaux fils du salon. Il est copié à la création du fil et ne suit pas les changements ultérieurs.
ForumSortOrderType | null
Comment sont triées les publications d’un salon forum ou média : une valeur de ForumSortOrderType.
ForumLayoutType
Comment sont affichées les publications d’un forum : une valeur de ForumLayoutType.
Documentation de Discord

ThreadCreateOptions

Ce que prend startThread() sur un salon textuel.
Pour démarrer un fil depuis un message, utilisez plutôt message.startThread() : voir Message.
string
requis
Le nom du fil (1 à 100 caractères).
number
Au bout de combien de minutes sans activité le fil quitte la liste des salons : 60, 1440, 4320 ou 10080.
ChannelType
La sorte de fil : ChannelType.PublicThread, ChannelType.PrivateThread ou ChannelType.AnnouncementThread (voir ChannelType).
boolean
Si les membres qui ne sont pas modérateurs peuvent ajouter d’autres membres au fil. Seulement pour un fil privé.
number | null
Mode lent : combien de secondes un membre attend entre deux messages (0 à 21600).
Documentation de Discord

ThreadEditOptions

Ce que prend edit() sur un fil.
thread.archive() et thread.unarchive() sont des raccourcis pour { archived: true } et { archived: false }.
string
Le nom du fil (1 à 100 caractères).
boolean
Si le fil est archivé.
number
Au bout de combien de minutes sans activité le fil quitte la liste des salons : 60, 1440, 4320 ou 10080.
boolean
Si le fil est verrouillé : seuls les membres avec la permission ManageThreads peuvent alors le désarchiver.
boolean
Si les membres qui ne sont pas modérateurs peuvent ajouter d’autres membres au fil. Seulement pour un fil privé.
number | null
Mode lent : combien de secondes un membre attend entre deux messages (0 à 21600). Les bots et les membres avec la permission BypassSlowmode ne sont pas concernés.
number
Les drapeaux du fil, sous forme de champ de bits. Seule une publication d’un salon forum ou média peut être épinglée ainsi.
Snowflake[]
Les identifiants des étiquettes d’une publication d’un salon forum ou média, 5 au plus.
Documentation de Discord

ForumPostOptions

Ce que prend createPost().
string
requis
Le titre de la publication.
MessageInput
requis
Le premier message de la publication : un texte, ou tout ce qu’un message peut contenir (voir MessageInput).
Snowflake[]
Les identifiants des étiquettes de la publication.
60 | 1440 | 4320 | 10080
Au bout de combien de minutes sans activité la publication est archivée.
number
Mode lent de la publication, en secondes.
Le message est vérifié comme n’importe quel autre avant d’être envoyé : voir Options des messages. Documentation de Discord

RoleCreateOptions

Ce que prend createRole(). Les permissions se donnent par leur nom, sous forme de liste de noms ou d’ensemble Permissions.
Chaque champ peut être laissé de côté : guild.createRole() crée un rôle avec les valeurs par défaut de Discord.
string
Le nom du rôle, 100 caractères au plus.
PermissionResolvable | string
Ce que le rôle permet : un nom, une liste de noms, un ensemble Permissions, ou le texte qu’utilise Discord. Voir PermissionResolvable.
object
Les couleurs du rôle.
boolean
Si les membres qui ont le rôle sont affichés à part dans la liste des membres.
string | null
L’icône du rôle, sous forme de data URI (quand le serveur a la fonctionnalité ROLE_ICONS).
string | null
Un emoji standard affiché comme icône du rôle (quand le serveur a la fonctionnalité ROLE_ICONS).
boolean
Si tout le monde peut mentionner le rôle.
Documentation de Discord

RoleEditOptions

Ce que prend edit() sur un rôle : seul ce qui est passé change. Les permissions se donnent par leur nom, sous forme de liste de noms ou d’ensemble Permissions.
string
Le nom du rôle, 100 caractères au plus.
PermissionResolvable | string
Ce que le rôle permet : un nom, une liste de noms, un ensemble Permissions, ou le texte qu’utilise Discord. Cela remplace les permissions du rôle : partez de role.permissions.add() ou .remove() pour en changer une. Voir PermissionResolvable.
object
Les couleurs du rôle : { primaryColor, secondaryColor, tertiaryColor }, comme dans RoleCreateOptions.
boolean
Si les membres qui ont le rôle sont affichés à part dans la liste des membres.
string
L’icône du rôle, sous forme de data URI (quand le serveur a la fonctionnalité ROLE_ICONS).
string
Un emoji standard affiché comme icône du rôle (quand le serveur a la fonctionnalité ROLE_ICONS).
boolean
Si tout le monde peut mentionner le rôle.
Documentation de Discord

InviteCreateOptions

Ce que prend createInvite().
Chaque champ peut être laissé de côté : channel.createInvite() crée une invitation avec les valeurs par défaut de Discord.
number
Au bout de combien de secondes l’invitation expire, de 0 (jamais) à 604800 (7 jours).
number
Combien de fois elle peut être utilisée, de 0 (pas de limite) à 100.
boolean
Si l’invitation ne donne qu’une adhésion temporaire : les membres qui arrivent avec elle sont expulsés quand ils se déconnectent.
boolean
true pour toujours créer un nouveau lien, au lieu de réutiliser un lien semblable qui existe déjà. Utile pour beaucoup de liens à usage unique.
1 | 2
Ce qu’ouvre une invitation vers un salon vocal : 1 un stream, 2 une activité intégrée.
Snowflake
L’identifiant de l’utilisateur dont montrer le stream. Nécessaire quand targetType vaut 1 ; l’utilisateur doit être en train de streamer dans le salon.
Snowflake
L’identifiant de l’activité à ouvrir. Nécessaire quand targetType vaut 2 ; l’application doit avoir le drapeau EMBEDDED.
Snowflake[]
Les identifiants des seuls utilisateurs qui peuvent voir et accepter l’invitation, 1000 au plus.
Snowflake[]
Les identifiants des rôles donnés à qui arrive avec l’invitation.
Documentation de Discord

FetchMessagesOptions

Ce que prend fetchMessages() : combien de messages, et à partir d’où.
number
Combien de messages, de 1 à 100. Par défaut : 50.
Snowflake | { id: Snowflake }
Seulement les messages avant celui-ci.
Snowflake | { id: Snowflake }
Seulement les messages après celui-ci.
Snowflake | { id: Snowflake }
Les messages autour de celui-ci.
limit est vérifié avant tout envoi. Une mauvaise valeur lève une RangeError :
Pour partir d’une date plutôt que d’un message, transformez la date en identifiant avec snowflakeFromTimestamp(). Documentation de Discord