MemberManager class

A manager for Members.

Inheritance

Constructors

MemberManager(CacheConfig<Member> config, NyxxRest client, {required Snowflake guildId})

Properties

cache → Cache<Member>
The cache for this manager.
finalinherited
client → NyxxRest
The client this manager belongs to.
finalinherited
guildId → Snowflake
The ID of the Guild this manager is for.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addRole(Snowflake id, Snowflake roleId, {String? auditLogReason}) → Future<void>
Add a role to a member in the guild.
create(covariant MemberBuilder builder) → Future<Member>
Create a new instance of the type of this manager.
override
delete(Snowflake id, {String? auditLogReason}) → Future<void>
Kick a member.
override
fetch(Snowflake id) → Future<Member>
Fetch the item with the given id from the API.
override
get(Snowflake id) → Future<Member>
Get an item by its id from the cache if it exists, else fetch it from the API.
inherited
list({int? limit, Snowflake? after}) → Future<List<Member>>
List the members in the guild.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parse(Map<String, Object?> raw, {Snowflake? userId}) → Member
Parse the raw data received from the API into an instance of the type of this manager.
override
removeRole(Snowflake id, Snowflake roleId, {String? auditLogReason}) → Future<void>
Remove a role from a member in the guild.
Search for members whose username begins with query.
toString() → String
A string representation of this object.
inherited
update(Snowflake id, covariant MemberUpdateBuilder builder, {String? auditLogReason}) → Future<Member>
Update the item with the given id in the API.
override
updateCurrentMember(CurrentMemberUpdateBuilder builder, {String? auditLogReason}) → Future<Member>
Update the current member in the guild.

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](Snowflake id) → PartialMember
Return a partial instance of the entity with ID id containing no data.
override