IMember class abstract

Implemented types

Constructors

IMember()

Properties

avatarHash String?
Member's avatar in IGuild
read-only
boostingSince DateTime?
When the user starting boosting the guild
read-only
client INyxx
Reference to client
read-only
createdAt DateTime
Gets creation timestamp included in Snowflake
read-onlyinherited
deaf bool
Weather or not the member is deafened.
read-only
effectivePermissions Future<IPermissions>
Returns total permissions of user.
read-only
flags IMemberFlags
Guild member flags
read-only
guild Cacheable<Snowflake, IGuild>
Cacheable of guild where member is located
read-only
hashCode int
The hash code for this object.
read-onlyinherited
id Snowflake
ID of entity as Snowflake
finalinherited
isPending bool
True if member is currently pending by Membership Screening. When completed, an IGuildMemberUpdateEvent will be fired with isPending set to false.
read-only
isTimedOut bool
True if user is timed out
read-only
joinedAt DateTime
When the member joined the guild.
read-only
mention String
The channel's mention string.
read-onlyoverride
mute bool
Weather or not the member is muted.
read-only
nickname String?
The members nickname, null if not set.
read-only
roles Iterable<Cacheable<Snowflake, IRole>>
Roles of member
read-only
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
timeoutUntil DateTime?
When the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out
read-only
user Cacheable<Snowflake, IUser>
Cacheable for this Guild member
read-only
voiceState IVoiceState?
Voice state of member. Null if not connected to channel or voice state not cached
read-only

Methods

addRole(SnowflakeEntity role, {String? auditReason}) Future<void>
Adds role to user.
avatarUrl({String format = 'webp', int? size, bool animated = true}) String?
The member's avatar, represented as URL. With given format and size. If animated is set as true, if available, the url will be a gif, otherwise the format or fallback to "webp".
ban({int? deleteMessageDays, String? reason, String? auditReason}) Future<void>
Bans the member and optionally deletes deleteMessageDays days worth of messages.
edit({required MemberBuilder builder, 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