CacheMember class

A user with Guild context.

Inheritance
Implemented types

Properties

avatar String
The user's avatar hash.
read / write, final, late, inherited
bot bool
Whether the user belongs to an OAuth2 application
read / write, final, late, inherited
client Nyxx
Reference to Nyxx instance
final, inherited
color DiscordColor
Color of highest role of user
read-only
createdAt DateTime
Gets creation timestamp included in Snowflake
read-only, inherited
deaf bool
Weather or not the member is deafened.
read / write, final, late, inherited
discriminator int
The user's discriminator.
read / write, final, late, inherited
dmChannel Future<DMChannel>
Gets the DMChannel for the user.
read-only, inherited
effectivePermissions Permissions
Returns total permissions of user.
read-only
formattedDiscriminator String
Formatted discriminator with leading zeros if needed
read-only, inherited
guild Guild
The guild that the member is a part of.
read / write, override-getter
guildId Snowflake
Id of guild
final, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
highestRole IRole
Returns highest role for member
read-only
hoistedRole IRole
Highest role of member
read / write, inherited
id Snowflake
ID of entity as Snowflake
final, inherited
joinedAt DateTime
When the member joined the guild.
read / write, final, late, inherited
mention String
The string to mention the user.
read-only, inherited
mute bool
Weather or not the member is muted.
read / write, final, late, inherited
nickname String
The members nickname, null if not set.
read / write, inherited
nitroType NitroType
Premium types denote the level of premium a user has.
read / write, inherited
presence Activity
The member's presence.
read / write, inherited
roles Iterable<IRole>
Roles of member. It will contain instance of IRole if CachelessMember or instance of Role if instance of CacheMember
read / write, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
status ClientStatus
The member's status. offline, online, idle, or dnd.
read / write, inherited
system bool
Whether the user is an Official Discord System user (part of the urgent message system)
read / write, final, late, inherited
tag String
Returns String with username#discriminator
read-only, inherited
userFlags UserFlags
Additional flags associated with user account. Describes if user has certain features like joined into one of houses or is discord employee.
read / write, inherited
username String
The user's username.
read / write, final, late, inherited
voiceState VoiceState
Voice state of member
read-only

Methods

addRole(IRole role, {String auditReason}) Future<void>
Adds role to user. [...]
inherited
avatarURL({String format: "webp", int size: 128}) String
The user's avatar, represented as URL. In case if user does not have avatar, default discord avatar will be returned with specified size and png format.
inherited
ban({int deleteMessageDays, String reason, String auditReason}) Future<void>
Bans the member and optionally deletes deleteMessageDays days worth of messages.
inherited
edit({String nick, List<IRole> roles, bool mute, bool deaf, VoiceChannel channel, String auditReason}) Future<void>
Edits members. Allows to move user in voice channel, mute or deaf, change nick, roles.
inherited
hasRole(bool func(IRole role)) bool
Checks if member has specified role. Returns true if user is assigned to given role.
inherited
kick({String auditReason}) Future<void>
Kicks the member from guild
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
removeRole(IRole role, {String auditReason}) Future<void>
Removes role from user.
inherited
send({dynamic content, List<AttachmentBuilder> files, EmbedBuilder embed, bool tts, AllowedMentions allowedMentions, MessageBuilder builder}) Future<Message>
Sends a message to user.
inherited
toString() String
Returns a mention of user
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited