Member class

Inheritance
Implemented types

Properties

avatarHash String?
Member's avatar in Guild
latefinal
boostingSince DateTime?
When the user starting boosting the guild
getter/setter pair
client INyxx
Reference to client
final
createdAt DateTime
Gets creation timestamp included in Snowflake
no setterinherited
deaf bool
Weather or not the member is deafened.
latefinal
effectivePermissions Future<Permissions>
Returns total permissions of user.
no setter
guild Cacheable<Snowflake, Guild>
Cacheable of guild where member is located
latefinal
hashCode int
The hash code for this object.
no setterinherited
highestRole Role
Returns highest role of member. Uses ! on nullable properties and will throw if anything is missing from cache
no setter
hoistedRole Cacheable<Snowflake, Role>
Highest role of member
latefinal
id Snowflake
ID of entity as Snowflake
finalinherited
joinedAt DateTime
When the member joined the guild.
latefinal
mention String
The channel's mention string.
no setteroverride
mute bool
Weather or not the member is muted.
latefinal
nickname String?
The members nickname, null if not set.
getter/setter pair
pending bool?
Whether the user has not yet passed the guild's Membership Screening requirements
latefinal
roles Iterable<Cacheable<Snowflake, Role>>
Roles of member
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
user Cacheable<Snowflake, User>
Cacheable for this Guild member
latefinal
voiceState VoiceState?
Voice state of member. Null if not connected to channel or voice state not cached
no setter

Methods

addRole(SnowflakeEntity role, {String? auditReason}) Future<void>
Adds role to user.
avatarURL({String format = "webp"}) String?
Returns url to member avatar
ban({int? deleteMessageDays, String? reason, String? auditReason}) Future<void>
Bans the member and optionally deletes deleteMessageDays days worth of messages.
edit({String? nick = "", List<SnowflakeEntity>? roles, bool? mute, bool? deaf, Snowflake? channel = const Snowflake.zero(), String? auditReason}) Future<void>
Edits members. Allows to move user in voice channel, mute or deaf, change nick, roles.
kick({String? auditReason}) Future<void>
Kicks the member from guild
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeRole(SnowflakeEntity role, {String? auditReason}) Future<void>
Removes role from user.
toString() String
A string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator.
inherited