Member class

The representation of a User in a Guild.

Inheritance

Properties

avatar CdnAsset?
This member's avatar.
no setter
avatarHash String?
The hash of this member's avatar image.
final
communicationDisabledUntil DateTime?
The time until which this member is timed out.
final
flags MemberFlags
A set of flags associated with this member.
final
hashCode int
The hash code for this object.
no setterinherited
id Snowflake
The id of this entity.
finalinherited
isDeaf bool?
Whether this member is deafened in voice channels.
final
isMute bool?
Whether this member is muted in voice channels.
final
isPending bool
Whether this member has not yet passed the guild's membership screening requirements.
final
joinedAt DateTime
The time at which this member joined the guild.
final
manager MemberManager
The manager for this entity.
finalinherited
nick String?
This member's nickname.
final
permissions Permissions?
In an interaction payload, the computed permissions of this member in the current channel.
final
premiumSince DateTime?
The time at which this member started boosting the guild.
final
roleIds List<Snowflake>
A list of the IDs of the roles this member has.
final
roles List<PartialRole>
The roles this member has.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
user User?
The User this member represents.
final

Methods

addRole(Snowflake roleId, {String? auditLogReason}) Future<void>
Add a role to this member.
inherited
ban({String? auditLogReason}) Future<void>
Ban this member.
inherited
defaultToString() String
Same as toString, but only called when dart:mirrors is not available.
inherited
delete({String? auditLogReason}) Future<void>
Kick this member.
inherited
fetch() Future<Member>
Fetch this entity from the API.
inherited
get() Future<Member>
If this entity exists in the manager's cache, return the cached instance. Otherwise, fetch this entity and return it.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeRole(Snowflake roleId, {String? auditLogReason}) Future<void>
Remove a role from this member.
inherited
toString() String
A string representation of this object.
inherited
unban({String? auditLogReason}) Future<void>
Unban this member.
inherited
update(covariant MemberUpdateBuilder builder, {String? auditLogReason}) Future<Member>
Update this member, returning the updated member.
inherited

Operators

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