Member

Represents a Discord guild member.

Objects Accessible via Caches

• Roles

Properties Inherited From Container

Name	Type	Mutable	Description
client	Client		Client object to which the Discord object is known
parent	*		Parent Discord object

Properties Inherited From Snowflake

Name	Type	Mutable	Description
createdAt	number		Unix time in seconds at which the object was created by Discord
id	string		Shortcut for member.user.id

Class Properties

Name	Type	Mutable	Description
avatar	string		Shortcut for member.user.avatar
avatarUrl	string		Shortcut for member.user.avatarUrl
bot	string		Shortcut for member.user.bot
deaf	boolean	X	Whether the member is deafened
discriminator	string		Shortcut for member.user.discriminator
gameName	string		Name of the game set in the member's status (can be nil if not set)
guild	Guild		The guild in which this member exists
joinedAt	string		Date and time when the member joined the guild
mentionString	string		Shortcut for member.user.mentionString
mute	boolean	X	Whether the member is muted
name	string		The member's nickname if one is set. Otherwise, its username.
nickname	string	X	The member's nickname for the guild in which it exists (can be nil if not set)
roleCount	number		How many Roles are cached for the member.
roles	function		Iterator for the member's cached Roles.
status	string		Whether the member is online, offline, or idle
user	User		The base user associated with this member
username	string		Shortcut for member.user.username

Class Methods

Prototype	Description
addRoles(roles[, ...])	Adds a role or roles to the member.
ban([guild])	Shortcut for member.user:ban. The member's guild is used if none is provided.
getMembership([guild])	Shortcut for member.user:getMembership
kick([guild])	Shortcut for member.user:kick. The member's guild is used if none is provided.
removeRoles(roles[, ...])	Removes a role or roles from the member.
sendMessage(content[, mentions, tts, nonce])	Shortcut for member.user:sendMessage
setVoiceChannel(channel)	Moves a member to a voice channel if they are already in one.
unban([guild])	Shortcut for member.user:unban. The member's guild is used if none is provided.