Package net.dv8tion.jda.internal.entities

Class MemberImpl

java.lang.Object

net.dv8tion.jda.internal.entities.MemberImpl

All Implemented Interfaces:

Formattable, IDetachableEntity, IMentionable, IPermissionHolder, ISnowflake, Member, UserSnowflake, IDetachableEntityMixin, MemberMixin<MemberImpl>

public class MemberImpl
extends Object
implements Member, MemberMixin<MemberImpl>

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Member

Member.MemberFlag

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.Member

AVATAR_URL, MAX_TIME_OUT_LENGTH

Constructor Summary

Constructors

Constructor	Description
MemberImpl(GuildImpl guild, User user)

Method Summary

Modifier and Type	Method	Description
boolean	canInteract(RichCustomEmoji emoji)	Whether this Member can interact with the provided RichCustomEmoji (use in a message)
boolean	canInteract(Member member)	Whether this Member can interact with the provided Member (kick/ban/etc.)
boolean	canInteract(Role role)	Whether this Member can interact with the provided Role (kick/ban/move/modify/delete/etc.)
boolean	canSync(IPermissionContainer channel)	Whether the permissions of this PermissionHolder are good enough to sync the target channel with any other channel.
boolean	canSync(IPermissionContainer targetChannel, IPermissionContainer syncSource)	Whether the permissions of this PermissionHolder are good enough to sync the target channel with the sync source.
boolean	equals(Object o)
EnumSet<ClientType>	getActiveClients()	A Set of all active ClientTypes of this Member.
List<Activity>	getActivities()	The activities of the user.
String	getAsMention()	Retrieve a Mention for this Entity.
String	getAvatarId()	The Discord Id for this member's per guild avatar image.
long	getBoostDateRaw()
Color	getColor()	The Color of this Member's name in a Guild.
int	getColorRaw()	The raw RGB value for the color of this member.
String	getDefaultAvatarId()	The Discord ID for this user's default avatar image.
DefaultGuildChannelUnion	getDefaultChannel()	The default channel for a Member.
String	getEffectiveName()	Retrieves the Name displayed in the official Discord Client.
int	getFlagsRaw()	The raw flags bitset for this member.
GuildImpl	getGuild()	The Guild in which this Member is represented.
long	getIdLong()	The Snowflake id of this entity.
JDA	getJDA()	The JDA instance.
String	getNickname()	Returns the current nickname of this Member for the parent Guild.
OnlineStatus	getOnlineStatus()	Returns the OnlineStatus of the User.
OnlineStatus	getOnlineStatus(ClientType type)	The platform dependent OnlineStatus of this member.
EnumSet<Permission>	getPermissions()	The Guild-Wide Permissions this PermissionHolder holds.
EnumSet<Permission>	getPermissions(GuildChannel channel)	The Permissions this PermissionHolder holds in the specified GuildChannel.
EnumSet<Permission>	getPermissionsExplicit()	The explicitly granted permissions for this permission holder in the guild.
EnumSet<Permission>	getPermissionsExplicit(GuildChannel channel)	The explicitly granted permissions for this permission holder in the guild.
MemberPresenceImpl	getPresence()
List<Role>	getRoles()	The roles applied to this Member.
Set<Role>	getRoleSet()
OffsetDateTime	getTimeBoosted()	The time when this member boosted the guild.
OffsetDateTime	getTimeJoined()	The Time this Member joined the Guild.
OffsetDateTime	getTimeOutEnd()	The time this Member will be released from time out.
long	getTimeOutEndRaw()
Set<Role>	getUnsortedRoles()	The roles applied to this Member.
User	getUser()	The user wrapped by this Entity.
GuildVoiceStateImpl	getVoiceState()	The VoiceState of this Member.
int	hashCode()
boolean	hasPermission(GuildChannel channel, Permission... permissions)	Checks whether or not this PermissionHolder has the given Permissions in the specified GuildChannel.
boolean	hasPermission(Permission... permissions)	Checks whether or not this PermissionHolder has the given Permissions in the Guild.
boolean	hasTimeJoined()	Whether this member has accurate Member.getTimeJoined() information.
boolean	isBoosting()	Returns whether a member is boosting the guild or not.
boolean	isDetached()	Whether this entity is detached.
boolean	isOwner()	Checks whether this member is the owner of its related Guild.
boolean	isPending()	Checks whether this member has passed the Guild's Membership Screening requirements.
MemberImpl	setAvatarId(String avatarId)
MemberImpl	setBoostDate(long boostDate)
MemberImpl	setFlags(int flags)
MemberImpl	setJoinDate(long joinDate)
MemberImpl	setNickname(String nickname)
MemberImpl	setPending(boolean pending)
MemberImpl	setTimeOutEnd(long time)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.internal.entities.detached.mixin.IDetachableEntityMixin

checkAttached, detachedException, detachedRequiresChannelException

Methods inherited from interface net.dv8tion.jda.api.entities.IMentionable

formatTo

Methods inherited from interface net.dv8tion.jda.api.entities.IPermissionHolder

hasAccess, hasPermission, hasPermission

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.Member

ban, deafen, getAvatar, getAvatarUrl, getEffectiveAvatar, getEffectiveAvatarUrl, getFlags, isTimedOut, kick, modifyFlags, modifyNickname, mute, removeTimeout, timeoutFor, timeoutFor, timeoutUntil

Methods inherited from interface net.dv8tion.jda.api.entities.UserSnowflake

getDefaultAvatar, getDefaultAvatarUrl

Constructor Details

MemberImpl

public MemberImpl(GuildImpl guild,
 User user)

Method Details

isDetached

public boolean isDetached()

Description copied from interface: IDetachableEntity

Whether this entity is detached.

If this returns true, this entity cannot be retrieved, will never be updated, and most methods that would otherwise return a RestAction will throw a DetachedEntityException instead.

Specified by:

isDetached in interface IDetachableEntity

Returns:

True, if the entity is detached

getPresence

public MemberPresenceImpl getPresence()

getUser

@Nonnull
public User getUser()

Description copied from interface: Member

The user wrapped by this Entity.

Specified by:

getUser in interface Member

Returns:

User

getGuild

@Nonnull
public GuildImpl getGuild()

Description copied from interface: Member

The Guild in which this Member is represented.

Specified by:

getGuild in interface IPermissionHolder

Specified by:

getGuild in interface Member

Returns:

Guild

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: Member

The JDA instance.

Specified by:

getJDA in interface Member

Returns:

The current JDA instance.

getTimeJoined

@Nonnull
public OffsetDateTime getTimeJoined()

Description copied from interface: Member

The Time this Member joined the Guild.
If the member was loaded through a presence update (lazy loading) this will be identical to the creation time of the guild. You can use Member.hasTimeJoined() to test whether this time can be relied on.

You can use guild.retrieveMemberById(member.getId()) to load the join time.

Specified by:

getTimeJoined in interface Member

Returns:

The time at which this user has joined the guild.

hasTimeJoined

public boolean hasTimeJoined()

Description copied from interface: Member

Whether this member has accurate Member.getTimeJoined() information.
Discord doesn't always provide this information when we load members so we have to fallback to the Guild creation time.

You can use guild.retrieveMemberById(member.getId()) to load the join time.

Specified by:

hasTimeJoined in interface Member

Returns:

True, if Member.getTimeJoined() is accurate

getTimeBoosted

@Nullable
public OffsetDateTime getTimeBoosted()

Description copied from interface: Member

The time when this member boosted the guild.
Null indicates this member is not currently boosting the guild.

Specified by:

getTimeBoosted in interface Member

Returns:

The boosting time, or null if the member is not boosting

isBoosting

public boolean isBoosting()

Description copied from interface: Member

Returns whether a member is boosting the guild or not.

Specified by:

isBoosting in interface Member

Returns:

True, if it is boosting

getTimeOutEnd

@Nullable
public OffsetDateTime getTimeOutEnd()

Description copied from interface: Member

The time this Member will be released from time out.
If this Member is not in time out, this returns null. This may also return dates in the past, in which case the time out has expired.

Specified by:

getTimeOutEnd in interface Member

Returns:

The time this Member will be released from time out or null if not in time out

getVoiceState

public GuildVoiceStateImpl getVoiceState()

Description copied from interface: Member

The VoiceState of this Member.
This will be null when the CacheFlag.VOICE_STATE is disabled manually

This can be used to get the Member's VoiceChannel using GuildVoiceState.getChannel().

Voice states are only cached while the member is connected to a channel. When the member is disconnected, this either returns null or an empty voice state.

Specified by:

getVoiceState in interface Member

Returns:

GuildVoiceState

getActivities

@Nonnull
public List<Activity> getActivities()

Description copied from interface: Member

The activities of the user.
If the user does not currently have any activity, this returns an empty list.

This requires CacheFlag.ACTIVITY to be enabled!

Specified by:

getActivities in interface Member

Returns:

Immutable list of Activities for the user

getOnlineStatus

@Nonnull
public OnlineStatus getOnlineStatus()

Description copied from interface: Member

Returns the OnlineStatus of the User.
If the OnlineStatus is unrecognized, will return UNKNOWN.

This will always return OnlineStatus.OFFLINE if CacheFlag.ONLINE_STATUS is disabled.

Specified by:

getOnlineStatus in interface Member

Returns:

The current OnlineStatus of the User.

getOnlineStatus

@Nonnull
public OnlineStatus getOnlineStatus(@Nonnull
 ClientType type)

Description copied from interface: Member

The platform dependent OnlineStatus of this member.
Since a user can be connected from multiple different devices such as web and mobile, discord specifies a status for each ClientType.

If a user is not online on the specified type, OFFLINE is returned.

This requires CacheFlag.CLIENT_STATUS to be enabled!

Specified by:

getOnlineStatus in interface Member

Parameters:

type - The type of client

Returns:

The status for that specific client or OFFLINE

getActiveClients

@Nonnull
public EnumSet<ClientType> getActiveClients()

Description copied from interface: Member

A Set of all active ClientTypes of this Member. Every OnlineStatus other than OFFLINE and UNKNOWN is interpreted as active. Since INVISIBLE is only possible for the SelfUser, other Members will never have ClientTypes show as active when actually being INVISIBLE, since they will show as OFFLINE.
If the Member is currently not active with any Client, this returns an empty Set.
When CacheFlag.CLIENT_STATUS is disabled, active clients will not be tracked and this will always return an empty Set.
Since a user can be connected from multiple different devices such as web and mobile, discord specifies a status for each ClientType.

Specified by:

getActiveClients in interface Member

Returns:

EnumSet of all active ClientTypes

getNickname

public String getNickname()

Description copied from interface: Member

Returns the current nickname of this Member for the parent Guild.

This can be changed using modifyNickname(Member, String).

Specified by:

getNickname in interface Member

Returns:

The nickname or null, if no nickname is set.

getAvatarId

public String getAvatarId()

Description copied from interface: Member

The Discord Id for this member's per guild avatar image. If the member has not set a per guild avatar, this will return null.

Specified by:

getAvatarId in interface Member

Returns:

Possibly-null String containing the Member per guild avatar id.

getEffectiveName

@Nonnull
public String getEffectiveName()

Description copied from interface: Member

Retrieves the Name displayed in the official Discord Client.

Specified by:

getEffectiveName in interface Member

Returns:

The guild nickname of this Member or the effective user name if no guild nickname is present.

getRoles

@Nonnull
public List<Role> getRoles()

Description copied from interface: Member

The roles applied to this Member.
The roles are ordered based on their position. The highest role being at index 0 and the lowest at the last index. Prefer Member.getUnsortedRoles() if the order is not relevant.

A Member's roles can be changed using the Guild.addRoleToMember(UserSnowflake, Role), Guild.removeRoleFromMember(UserSnowflake, Role), and Guild.modifyMemberRoles(Member, Collection, Collection) methods in Guild.

The Public Role (@everyone) is not included in the returned immutable list of roles
It is implicit that every member holds the Public Role in a Guild thus it is not listed here!

Specified by:

getRoles in interface Member

Returns:

An immutable List of Roles for this Member.

See Also:

• Guild.addRoleToMember(UserSnowflake, Role)
• Guild.removeRoleFromMember(UserSnowflake, Role)
• Guild.modifyMemberRoles(Member, Collection, Collection)

getUnsortedRoles

@Nonnull
public Set<Role> getUnsortedRoles()

Description copied from interface: Member

The roles applied to this Member.
This is an unmodifiable reference to the role set of this member. This set has no defined order, use Member.getRoles() to get an ordered list.

A Member's roles can be changed using the Guild.addRoleToMember(UserSnowflake, Role), Guild.removeRoleFromMember(UserSnowflake, Role), and Guild.modifyMemberRoles(Member, Collection, Collection) methods in Guild.

The Public Role (@everyone) is not included in the returned immutable set of roles
It is implicit that every member holds the Public Role in a Guild thus it is not listed here!

Specified by:

getUnsortedRoles in interface Member

Returns:

An unmodifiable reference to the Set of Roles for this Member.

See Also:

• Member.getRoles()
• Guild.addRoleToMember(UserSnowflake, Role)
• Guild.removeRoleFromMember(UserSnowflake, Role)
• Guild.modifyMemberRoles(Member, Collection, Collection)

getColor

public Color getColor()

Description copied from interface: Member

The Color of this Member's name in a Guild.

This is determined by the color of the highest role assigned to them that does not have the default color.
If all roles have default color, this returns null.

Specified by:

getColor in interface Member

Returns:

The display Color for this Member.

See Also:

• Member.getColorRaw()

getColorRaw

public int getColorRaw()

Description copied from interface: Member

The raw RGB value for the color of this member.
Defaulting to Role.DEFAULT_COLOR_RAW if this member uses the default color (special property, it changes depending on theme used in the client)

Specified by:

getColorRaw in interface Member

Returns:

The raw RGB value or the role default

getFlagsRaw

public int getFlagsRaw()

Description copied from interface: Member

The raw flags bitset for this member.

Specified by:

getFlagsRaw in interface Member

Returns:

The raw flag bitset

getPermissions

@Nonnull
public EnumSet<Permission> getPermissions()

Description copied from interface: IPermissionHolder

The Guild-Wide Permissions this PermissionHolder holds.
Changes to the returned set do not affect this entity directly.

Specified by:

getPermissions in interface IPermissionHolder

Returns:

An EnumSet of Permissions granted to this PermissionHolder.

getPermissions

@Nonnull
public EnumSet<Permission> getPermissions(@Nonnull
 GuildChannel channel)

Description copied from interface: IPermissionHolder

The Permissions this PermissionHolder holds in the specified GuildChannel.
Permissions returned by this may be different from IPermissionHolder.getPermissions() due to the GuildChannel's PermissionOverrides.
Changes to the returned set do not affect this entity directly.

Specified by:

getPermissions in interface IPermissionHolder

Parameters:

channel - The GuildChannel of which to get Permissions for

Returns:

Set of Permissions granted to this Permission Holder in the specified channel.

getPermissionsExplicit

@Nonnull
public EnumSet<Permission> getPermissionsExplicit()

Description copied from interface: IPermissionHolder

The explicitly granted permissions for this permission holder in the guild.
This disregards owner and administrator privileges. For a role this is identical to IPermissionHolder.getPermissions() and members have all their roles taken into consideration.
Changes to the returned set do not affect this entity directly.

Specified by:

getPermissionsExplicit in interface IPermissionHolder

Returns:

EnumSet of the explicitly granted permissions

getPermissionsExplicit

@Nonnull
public EnumSet<Permission> getPermissionsExplicit(@Nonnull
 GuildChannel channel)

Description copied from interface: IPermissionHolder

The explicitly granted permissions for this permission holder in the guild.
This disregards owner and administrator privileges.
Permissions returned by this may be different from IPermissionHolder.getPermissionsExplicit() due to the GuildChannel's PermissionOverrides.
Changes to the returned set do not affect this entity directly.

Specified by:

getPermissionsExplicit in interface IPermissionHolder

Parameters:

channel - The GuildChannel of which to get Permissions for

Returns:

EnumSet of the explicitly granted permissions in the specified channel

hasPermission

public boolean hasPermission(@Nonnull
 Permission... permissions)

Description copied from interface: IPermissionHolder

Checks whether or not this PermissionHolder has the given Permissions in the Guild.

Specified by:

hasPermission in interface IPermissionHolder

Parameters:

permissions - Permissions to check for.

Returns:

True, if all of the specified Permissions are granted to this PermissionHolder.

hasPermission

public boolean hasPermission(@Nonnull
 GuildChannel channel,
 @Nonnull
 Permission... permissions)

Description copied from interface: IPermissionHolder

Checks whether or not this PermissionHolder has the given Permissions in the specified GuildChannel.

Specified by:

hasPermission in interface IPermissionHolder

Parameters:

channel - The GuildChannel in which to check.

permissions - Permissions to check for.

Returns:

True, if all of the specified Permissions are granted to this PermissionHolder in the provided GuildChannel.

See Also:

• EnumSet

canSync

public boolean canSync(@Nonnull
 IPermissionContainer targetChannel,
 @Nonnull
 IPermissionContainer syncSource)

Description copied from interface: IPermissionHolder

Whether the permissions of this PermissionHolder are good enough to sync the target channel with the sync source.
This checks what permissions would be changed by the overrides of the sync source and whether the permission holder is able to set them on the target channel.

If the permission holder had Permission.MANAGE_PERMISSIONS in an override on the target channel or Permission.ADMINISTRATOR on one of its roles, then it can set any permission on the target channel. Otherwise, the permission holder can only set permissions it also has in the channel.

Specified by:

canSync in interface IPermissionHolder

Parameters:

targetChannel - The target channel to check

syncSource - The sync source, for example the parent category (see ICategorizableChannel.getParentCategory())

Returns:

True, if the channels can be synced

canSync

public boolean canSync(@Nonnull
 IPermissionContainer channel)

Description copied from interface: IPermissionHolder

Whether the permissions of this PermissionHolder are good enough to sync the target channel with any other channel.
This checks whether the permission holder has local administrator.

If the permission holder had Permission.MANAGE_PERMISSIONS in an override on the target channel or Permission.ADMINISTRATOR on one of its roles, then it can set any permission on the target channel.

Specified by:

canSync in interface IPermissionHolder

Parameters:

channel - The target channel to check

Returns:

True, if the channel can be synced

canInteract

public boolean canInteract(@Nonnull
 Member member)

Description copied from interface: Member

Whether this Member can interact with the provided Member (kick/ban/etc.)

Specified by:

canInteract in interface Member

Parameters:

member - The target Member to check

Returns:

True, if this Member is able to interact with the specified Member

canInteract

public boolean canInteract(@Nonnull
 Role role)

Description copied from interface: Member

Whether this Member can interact with the provided Role (kick/ban/move/modify/delete/etc.)

If this returns true this member can assign the role to other members.

Specified by:

canInteract in interface Member

Parameters:

role - The target Role to check

Returns:

True, if this member is able to interact with the specified Role

canInteract

public boolean canInteract(@Nonnull
 RichCustomEmoji emoji)

Description copied from interface: Member

Whether this Member can interact with the provided RichCustomEmoji (use in a message)

Specified by:

canInteract in interface Member

Parameters:

emoji - The target emoji to check

Returns:

True, if this Member is able to interact with the specified emoji

isOwner

public boolean isOwner()

Description copied from interface: Member

Checks whether this member is the owner of its related Guild.

Specified by:

isOwner in interface Member

Returns:

True, if this member is the owner of the attached Guild.

isPending

public boolean isPending()

Description copied from interface: Member

Checks whether this member has passed the Guild's Membership Screening requirements.

Specified by:

isPending in interface Member

Returns:

True, if this member hasn't passed the guild's Membership Screening requirements

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getAsMention

@Nonnull
public String getAsMention()

Description copied from interface: IMentionable

Retrieve a Mention for this Entity. For the public Role (@everyone), this will return the literal string "@everyone".

Specified by:

getAsMention in interface IMentionable

Returns:

A resolvable mention.

getDefaultChannel

@Nullable
public DefaultGuildChannelUnion getDefaultChannel()

Description copied from interface: Member

The default channel for a Member.
This is the channel that the Discord client will default to opening when a Guild is opened for the first time after joining the guild.
The default channel is the channel with the highest position in which the member has Permission.VIEW_CHANNEL permissions. If this requirement doesn't apply for any channel in the guild, this method returns null.

Specified by:

getDefaultChannel in interface Member

Returns:

The channel representing the default channel for this member or null if no such channel exists.

getDefaultAvatarId

@Nonnull
public String getDefaultAvatarId()

Description copied from interface: UserSnowflake

The Discord ID for this user's default avatar image.

Specified by:

getDefaultAvatarId in interface UserSnowflake

Returns:

Never-null String containing the user's default avatar id.

setNickname

public MemberImpl setNickname(String nickname)

Specified by:

setNickname in interface MemberMixin<MemberImpl>

setAvatarId

public MemberImpl setAvatarId(String avatarId)

Specified by:

setAvatarId in interface MemberMixin<MemberImpl>

setJoinDate

public MemberImpl setJoinDate(long joinDate)

Specified by:

setJoinDate in interface MemberMixin<MemberImpl>

setBoostDate

public MemberImpl setBoostDate(long boostDate)

Specified by:

setBoostDate in interface MemberMixin<MemberImpl>

setTimeOutEnd

public MemberImpl setTimeOutEnd(long time)

Specified by:

setTimeOutEnd in interface MemberMixin<MemberImpl>

setPending

public MemberImpl setPending(boolean pending)

Specified by:

setPending in interface MemberMixin<MemberImpl>

setFlags

public MemberImpl setFlags(int flags)

Specified by:

setFlags in interface MemberMixin<MemberImpl>

getRoleSet

public Set<Role> getRoleSet()

getBoostDateRaw

public long getBoostDateRaw()

getTimeOutEndRaw

public long getTimeOutEndRaw()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object