public final class Member extends User
Constructor and Description |
---|
Member(ServiceMediator serviceMediator,
MemberBean data,
UserBean userData,
long guildId)
Constructs a
Member with an associated ServiceMediator and Discord data. |
Modifier and Type | Method and Description |
---|---|
Mono<Void> |
addRole(Snowflake roleId)
Requests to add a role to this member.
|
Mono<Void> |
addRole(Snowflake roleId,
String reason)
Requests to add a role to this member while optionally specifying the reason.
|
Mono<Member> |
asMember(Snowflake guildId)
Requests to retrieve this user as a
Member . |
Mono<Void> |
ban(Consumer<? super BanQuerySpec> spec)
Requests to ban this user.
|
Mono<Void> |
edit(Consumer<? super GuildMemberEditSpec> spec)
Requests to edit this member.
|
Mono<PermissionSet> |
getBasePermissions()
Requests to calculate the permissions granted to this member by his roles in the guild.
|
Mono<Color> |
getColor()
Requests to determine the
Color this member would be visually represented in the Discord client. |
String |
getDisplayName()
Gets the name that is displayed in client.
|
Mono<Guild> |
getGuild()
Requests to retrieve the guild this user is associated to.
|
Snowflake |
getGuildId()
Gets the ID of the guild this user is associated to.
|
Mono<Role> |
getHighestRole()
Requests to retrieve the user's highest guild role.
|
Instant |
getJoinTime()
Gets when the user joined the guild.
|
Optional<String> |
getNickname()
Gets the user's guild nickname (if one is set).
|
String |
getNicknameMention()
Gets the raw nickname mention.
|
Optional<Instant> |
getPremiumTime()
Gets when the user boost the guild, if present.
|
Mono<Presence> |
getPresence()
Requests to retrieve the presence for this user for this guild.
|
Set<Snowflake> |
getRoleIds()
Gets the user's guild roles' IDs.
|
Flux<Role> |
getRoles()
Requests to retrieve the user's guild roles.
|
Mono<VoiceState> |
getVoiceState()
Requests to retrieve this user's voice state for this guild.
|
Mono<Boolean> |
hasHigherRoles(Iterable<Role> otherRoles)
Requests to determine if the position of this member's highest role is greater than the highest position of the
provided roles or signal IllegalArgumentException if the provided roles are from a different guild than this
member.
|
Mono<Boolean> |
isHigher(Member otherMember)
Requests to determine if this member is higher in the role hierarchy than the provided member or signal
IllegalArgumentException if the provided member is in a different guild than this member.
|
Mono<Boolean> |
isHigher(Snowflake id)
Requests to determine if this member is higher in the role hierarchy than the member as represented
by the supplied ID or signal IllegalArgumentException if the member as represented by the supplied ID is in
a different guild than this member.
|
Mono<Void> |
kick()
Requests to kick this member.
|
Mono<Void> |
kick(String reason)
Requests to kick this member while optionally specifying the reason.
|
Mono<Void> |
removeRole(Snowflake roleId)
Requests to remove a role from this member.
|
Mono<Void> |
removeRole(Snowflake roleId,
String reason)
Requests to remove a role from this member while optionally specifying the reason.
|
String |
toString() |
Mono<Void> |
unban()
Requests to unban this user.
|
Mono<Void> |
unban(String reason)
Requests to unban this user while optionally specifying the reason.
|
equals, getAvatar, getAvatar, getAvatarUrl, getAvatarUrl, getClient, getDefaultAvatarUrl, getDiscriminator, getId, getMention, getPrivateChannel, getUsername, hasAnimatedAvatar, hashCode, isBot
public Member(ServiceMediator serviceMediator, MemberBean data, UserBean userData, long guildId)
Member
with an associated ServiceMediator and Discord data.serviceMediator
- The ServiceMediator associated to this object, must be non-null.data
- The raw data as represented by Discord, must be non-null.userData
- The user data as represented by Discord, must be non-null.guildId
- The ID of the guild this user is associated to.public Mono<Member> asMember(Snowflake guildId)
User
Member
.public Set<Snowflake> getRoleIds()
public Flux<Role> getRoles()
The returned Flux
will emit items in order based off their natural position, which is indicated
visually in the Discord client. For roles, the "lowest" role will be emitted first.
public Mono<Role> getHighestRole()
The highest role is defined to be the role with the highest position, based on Discord's ordering. This is the role that appears at the top in Discord's UI.
public Instant getJoinTime()
public Optional<Instant> getPremiumTime()
public Snowflake getGuildId()
public String getDisplayName()
public Optional<String> getNickname()
public String getNicknameMention()
public Mono<VoiceState> getVoiceState()
Mono
where, upon successful completion, emits a voice state
for this user
for this guild. If an error is received, it is emitted through the Mono
.store
does not save
VoiceStateBean
instances OR the bot is currently not logged in then the returned Mono
will
always be empty.public Mono<Presence> getPresence()
Mono
where, upon successful completion, emits a presence
for this user for
this guild. If an error is received, it is emitted through the Mono
.store
does not save
PresenceBean
instances OR the bot is currently not logged in then the returned Mono
will
always be empty.public Mono<Void> kick()
Mono
where, upon successful completion, emits nothing; indicating the member was kicked. If an
error is received, it is emitted through the Mono
.public Mono<Void> kick(@Nullable String reason)
reason
- The reason, if present.Mono
where, upon successful completion, emits nothing; indicating the member was kicked. If an
error is received, it is emitted through the Mono
.public Mono<Void> ban(Consumer<? super BanQuerySpec> spec)
spec
- A Consumer
that provides a "blank" BanQuerySpec
to be operated on.Mono
where, upon successful completion, emits nothing; indicating this user was banned. If an
error is received, it is emitted through the Mono
.public Mono<Void> unban()
Mono
where, upon successful completion, emits nothing; indicating this user was unbanned. If an
error is received, it is emitted through the Mono
.public Mono<Void> unban(@Nullable String reason)
reason
- The reason, if present.Mono
where, upon successful completion, emits nothing; indicating this user was unbanned. If an
error is received, it is emitted through the Mono
.public Mono<Void> addRole(Snowflake roleId)
roleId
- The ID of the role to add to this member.Mono
where, upon successful completion, emits nothing; indicating the role was added to this
member. If an error is received, it is emitted through the Mono
.public Mono<Void> addRole(Snowflake roleId, @Nullable String reason)
roleId
- The ID of the role to add to this member.reason
- The reason, if present.Mono
where, upon successful completion, emits nothing; indicating the role was added to this
member. If an error is received, it is emitted through the Mono
.public Mono<Void> removeRole(Snowflake roleId)
roleId
- The ID of the role to remove from this member.Mono
where, upon successful completion, emits nothing; indicating the role was removed from
this member. If an error is received, it is emitted through the Mono
.public Mono<Void> removeRole(Snowflake roleId, @Nullable String reason)
roleId
- The ID of the role to remove from this member.reason
- The reason, if present.Mono
where, upon successful completion, emits nothing; indicating the role was removed from
this member. If an error is received, it is emitted through the Mono
.public Mono<PermissionSet> getBasePermissions()
public Mono<Boolean> isHigher(Member otherMember)
otherMember
- The member to compare in the role hierarchy with this member.Mono
where, upon successful completion, emits true
if this member is higher in the
role hierarchy than the provided member, false
otherwise. If an error is received, it is emitted
through the Mono
.public Mono<Boolean> isHigher(Snowflake id)
id
- The ID of the member to compare in the role hierarchy with this member.Mono
where, upon successful completion, emits true
if this member is higher in the role
hierarchy than the member as represented by the supplied ID, false
otherwise. If an error is received,
it is emitted through the Mono
.public Mono<Boolean> hasHigherRoles(Iterable<Role> otherRoles)
otherRoles
- The list of roles to compare in the role hierarchy with this member's roles.Mono
where, upon successful completion, emits true
if the position of this member's
highest role is greater than the highest position of the provided roles, false
otherwise.
If an error is received it is emitted through the Mono
.public Mono<Color> getColor()
Color
this member would be visually represented in the Discord client.Mono
where, upon successful completion, emits the Color
this member would be visually
represented in the Discord client. If an error is received, it is emitted through the Mono
.public Mono<Void> edit(Consumer<? super GuildMemberEditSpec> spec)
spec
- A Consumer
that provides a "blank" GuildMemberEditSpec
to be operated on.Mono
where, upon successful completion, emits nothing; indicating the member has been edited.
If an error is received, it is emitted through the Mono
.