Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GuildMemberModifyOptions

The options for {@link GuildMember#modify}.

since

0.0.1

see

https://discord.com/developers/docs/resources/guild#modify-guild-member-json-params

Hierarchy

  • GuildMemberModifyOptions

Index

Properties

Optional channel_id

channel_id: string | null

Id of channel to move user to (if they are connected to a voice channel).

since

0.0.1

Optional deaf

deaf: undefined | false | true

Whether the user is deafened in voice channels, will throw an error if the user is not in a voice channel.

since

0.0.1

Optional mute

mute: undefined | false | true

Whether the user is muted in voice channels, will throw an error if the user is not in a voice channel.

since

0.0.1

Optional nick

nick: undefined | string

Value to set user's nickname to.

since

0.0.1

Optional roles

roles: keyof string[]

Array of role IDs the member is assigned.

since

0.0.1

Generated using TypeDoc