All Superinterfaces:: Formattable, IDetachableEntity, IMentionable, IPermissionHolder, ISnowflake, UserSnowflake

public interface Member extends IMentionable, IPermissionHolder, IDetachableEntity, UserSnowflake

Represents a Guild-specific User.

Contains all guild-specific information about a User. (Roles, Nickname, VoiceStatus etc.)

Since:

3.0

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

Member.MemberFlag

Member flags indicating information about the membership state.
Field Summary

Fields

Modifier and Type

Field

Description

static final String

AVATAR_URL

Template for getAvatarUrl().

static final int

MAX_TIME_OUT_LENGTH

Maximum number of days a Member can be timed out for
Method Summary

Modifier and Type

Method

Description

default AuditableRestAction<Void>

ban(int deletionTimeframe, TimeUnit unit)

Bans this Member and deletes messages sent by the user based on the amount of delDays.

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.)

default AuditableRestAction<Void>

deafen(boolean deafen)

Sets the Guild Deafened state state of this Member based on the provided boolean.

EnumSet<ClientType>

getActiveClients()

A Set of all active ClientTypes of this Member.

@Unmodifiable List<Activity>

getActivities()

The activities of the user.

default ImageProxy

getAvatar()

Returns an ImageProxy for this member's avatar.

String

getAvatarId()

The Discord Id for this member's per guild avatar image.

default String

getAvatarUrl()

The URL for the member's per guild avatar image.

Color

getColor()

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

int

getColorRaw()

The raw RGB value for the color of this member.

DefaultGuildChannelUnion

getDefaultChannel()

The default channel for a Member.

default ImageProxy

getEffectiveAvatar()

Returns an ImageProxy for this member's effective avatar image.

default String

getEffectiveAvatarUrl()

The URL for the member's effective avatar image.

String

getEffectiveName()

Retrieves the Name displayed in the official Discord Client.

default EnumSet<Member.MemberFlag>

getFlags()

The flags for this member as an EnumSet.

int

getFlagsRaw()

The raw flags bitset for this member.

Guild

getGuild()

The Guild in which this Member is represented.

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.

@Unmodifiable List<Role>

getRoles()

The roles applied to this Member.

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.

User

getUser()

The user wrapped by this Entity.

GuildVoiceState

getVoiceState()

The VoiceState of this Member.

boolean

hasTimeJoined()

Whether this member has accurate getTimeJoined() information.

boolean

isBoosting()

Returns whether a member is boosting the guild or not.

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.

default boolean

isTimedOut()

Whether this Member is in time out.

default AuditableRestAction<Void>

kick()

Kicks this Member from the Guild.

default AuditableRestAction<Void>

modifyFlags(Collection<Member.MemberFlag> newFlags)

Updates the flags to the new flag set.

default AuditableRestAction<Void>

modifyNickname(String nickname)

Changes this Member's nickname in this guild.

default AuditableRestAction<Void>

mute(boolean mute)

Sets the Guild Muted state state of this Member based on the provided boolean.

default AuditableRestAction<Void>

removeTimeout()

Removes a time out from this Member in this Guild.

default AuditableRestAction<Void>

timeoutFor(long amount, TimeUnit unit)

Puts this Member in time out in this Guild for a specific amount of time.

default AuditableRestAction<Void>

timeoutFor(Duration duration)

Puts this Member in time out in this Guild for a specific amount of time.

default AuditableRestAction<Void>

timeoutUntil(TemporalAccessor temporal)

Puts this Member in time out in this Guild until the specified date.

Methods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity
isDetached

Methods inherited from interface net.dv8tion.jda.api.entities.IMentionable
formatTo, getAsMention

Methods inherited from interface net.dv8tion.jda.api.entities.IPermissionHolder
canSync, canSync, getPermissions, getPermissions, getPermissionsExplicit, getPermissionsExplicit, hasAccess, hasPermission, hasPermission, hasPermission, hasPermission

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.UserSnowflake
getDefaultAvatar, getDefaultAvatarId, getDefaultAvatarUrl

Field Details
- AVATAR_URL
  
  static final String AVATAR_URL
  
  Template for getAvatarUrl().
  See Also:
  
  Constant Field Values
- MAX_TIME_OUT_LENGTH
  
  static final int MAX_TIME_OUT_LENGTH
  
  Maximum number of days a Member can be timed out for
  See Also:
  
  Constant Field Values
Method Details
- getUser
  
  @Nonnull User getUser()
  
  The user wrapped by this Entity.
  
  Returns:
  
  User
- getGuild
  
  @Nonnull Guild getGuild()
  
  The Guild in which this Member is represented.
  
  Specified by:
  
  getGuild in interface IPermissionHolder
  
  Returns:
  
  Guild
- getJDA
  
  @Nonnull JDA getJDA()
  
  The JDA instance.
  
  Returns:
  
  The current JDA instance.
- getTimeJoined
  
  @Nonnull OffsetDateTime getTimeJoined()
  
  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 hasTimeJoined() to test whether this time can be relied on.
  You can use guild.retrieveMemberById(member.getId()) to load the join time.
  
  Returns:
  
  The time at which this user has joined the guild.
- hasTimeJoined
  
  boolean hasTimeJoined()
  
  Whether this member has accurate 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.
  
  Returns:
  
  True, if getTimeJoined() is accurate
- getTimeBoosted
  
  @Nullable OffsetDateTime getTimeBoosted()
  
  The time when this member boosted the guild.
  Null indicates this member is not currently boosting the guild.
  
  Returns:
  
  The boosting time, or null if the member is not boosting
  
  Since:
  
  4.0.0
- isBoosting
  
  boolean isBoosting()
  
  Returns whether a member is boosting the guild or not.
  
  Returns:
  
  True, if it is boosting
- getTimeOutEnd
  
  @Nullable OffsetDateTime getTimeOutEnd()
  
  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.
  
  Returns:
  
  The time this Member will be released from time out or null if not in time out
- isTimedOut
  
  default boolean isTimedOut()
  
  Whether this Member is in time out.
  While a Member is in time out, all permissions except VIEW_CHANNEL and MESSAGE_HISTORY are removed from them.
  
  Returns:
  
  True, if this Member is in time out
- getVoiceState
  
  @Nullable GuildVoiceState getVoiceState()
  
  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().
  This requires CacheFlag.VOICE_STATE to be enabled!
  
  Returns:
  
  GuildVoiceState
  
  Throws:
  
  DetachedEntityException - If this entity is detached
- getActivities
  
  @Nonnull @Unmodifiable List<Activity> getActivities()
  
  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!
  
  Returns:
  
  Immutable list of Activities for the user
  
  Throws:
  
  DetachedEntityException - If this entity is detached
- getOnlineStatus
  
  @Nonnull OnlineStatus getOnlineStatus()
  
  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.
  
  Returns:
  
  The current OnlineStatus of the User.
  
  Throws:
  
  DetachedEntityException - If this entity is detached
- getOnlineStatus
  
  @Nonnull OnlineStatus getOnlineStatus(@Nonnull ClientType type)
  
  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!
  
  Parameters:
  
  type - The type of client
  
  Returns:
  
  The status for that specific client or OFFLINE
  
  Throws:
  
  IllegalArgumentException - If the provided type is null
  
  DetachedEntityException - If this entity is detached
  
  Since:
  
  4.0.0
- getActiveClients
  
  @Nonnull EnumSet<ClientType> getActiveClients()
  
  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.
  
  Returns:
  
  EnumSet of all active ClientTypes
  
  Throws:
  
  DetachedEntityException - If this entity is detached
  
  Since:
  
  4.0.0
- getNickname
  
  @Nullable String getNickname()
  
  Returns the current nickname of this Member for the parent Guild.
  This can be changed using modifyNickname(Member, String).
  
  Returns:
  
  The nickname or null, if no nickname is set.
- getEffectiveName
  
  @Nonnull String getEffectiveName()
  
  Retrieves the Name displayed in the official Discord Client.
  
  Returns:
  
  The guild nickname of this Member or the effective user name if no guild nickname is present.
- getAvatarId
  
  @Nullable String getAvatarId()
  
  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.
  
  Returns:
  
  Possibly-null String containing the Member per guild avatar id.
- getAvatarUrl
  
  @Nullable default String getAvatarUrl()
  
  The URL for the member's per guild avatar image. If the member has not set a per guild avatar, this will return null.
  
  Returns:
  
  Possibly-null String containing the Member per guild avatar url.
- getAvatar
  
  @Nullable default ImageProxy getAvatar()
  
  Returns an ImageProxy for this member's avatar.
  Returns:
  
  Possibly-null ImageProxy of this member's avatar
  
  See Also:
  
  getAvatarUrl()
- getEffectiveAvatarUrl
  
  @Nonnull default String getEffectiveAvatarUrl()
  
  The URL for the member's effective avatar image. If they do not have a per guild avatar set, this will return the URL of their effective User avatar.
  
  Returns:
  
  Never-null String containing the Member avatar url.
- getEffectiveAvatar
  
  @Nonnull default ImageProxy getEffectiveAvatar()
  
  Returns an ImageProxy for this member's effective avatar image.
  Returns:
  
  Never-null ImageProxy of this member's effective avatar image
  
  See Also:
  
  getEffectiveAvatarUrl()
- getRoles
  
  @Nonnull @Unmodifiable List<Role> getRoles()
  
  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.
  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!
  Returns:
  
  An immutable List of Roles for this Member.
  
  Throws:
  
  DetachedEntityException - If this entity is detached
  
  See Also:
  
  Guild.addRoleToMember(UserSnowflake, Role)
  
  Guild.removeRoleFromMember(UserSnowflake, Role)
  
  Guild.modifyMemberRoles(Member, Collection, Collection)
- getColor
  
  @Nullable Color getColor()
  
  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.
  Returns:
  
  The display Color for this Member.
  
  See Also:
  
  getColorRaw()
- getColorRaw
  
  int getColorRaw()
  
  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)
  
  Returns:
  
  The raw RGB value or the role default
- getFlagsRaw
  
  int getFlagsRaw()
  
  The raw flags bitset for this member.
  
  Returns:
  
  The raw flag bitset
- getFlags
  
  @Nonnull default EnumSet<Member.MemberFlag> getFlags()
  
  The flags for this member as an EnumSet.
  Modifying this set will not update the member, it is a copy of existing flags.
  
  Returns:
  
  The flags
- canInteract
  
  boolean canInteract(@Nonnull Member member)
  
  Whether this Member can interact with the provided Member (kick/ban/etc.)
  
  Parameters:
  
  member - The target Member to check
  
  Returns:
  
  True, if this Member is able to interact with the specified Member
  
  Throws:
  
  NullPointerException - if the specified Member is null
  
  IllegalArgumentException - if the specified Member is not from the same guild
  
  DetachedEntityException - If this entity is detached
- canInteract
  
  boolean canInteract(@Nonnull Role role)
  
  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.
  
  Parameters:
  
  role - The target Role to check
  
  Returns:
  
  True, if this member is able to interact with the specified Role
  
  Throws:
  
  NullPointerException - if the specified Role is null
  
  IllegalArgumentException - if the specified Role is not from the same guild
  
  DetachedEntityException - If this entity is detached
- canInteract
  
  boolean canInteract(@Nonnull RichCustomEmoji emoji)
  
  Whether this Member can interact with the provided RichCustomEmoji (use in a message)
  
  Parameters:
  
  emoji - The target emoji to check
  
  Returns:
  
  True, if this Member is able to interact with the specified emoji
  
  Throws:
  
  NullPointerException - if the specified emoji is null
  
  IllegalArgumentException - if the specified emoji is not from the same guild
  
  DetachedEntityException - If this entity is detached
- isOwner
  
  boolean isOwner()
  
  Checks whether this member is the owner of its related Guild.
  
  Returns:
  
  True, if this member is the owner of the attached Guild.
  
  Throws:
  
  DetachedEntityException - If this entity is detached
- isPending
  
  @Incubating boolean isPending()
  
  Checks whether this member has passed the Guild's Membership Screening requirements.
  
  Returns:
  
  True, if this member hasn't passed the guild's Membership Screening requirements
  
  Throws:
  
  DetachedEntityException - If this entity is detached
  
  Since:
  
  4.2.1
  
  Incubating:
  
  Discord is still trying to figure this out
- getDefaultChannel
  
  @Nullable DefaultGuildChannelUnion getDefaultChannel()
  
  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.
  
  Returns:
  
  The channel representing the default channel for this member or null if no such channel exists.
  
  Throws:
  
  DetachedEntityException - If this entity is detached
- ban
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> ban(int deletionTimeframe, @Nonnull TimeUnit unit)
  Bans this Member and deletes messages sent by the user based on the amount of delDays.
  If you wish to ban a user without deleting any messages, provide deletionTimeframe with a value of 0. To set a ban reason, use AuditableRestAction.reason(String).
  You can unban a user with Guild.unban(UserSnowflake).
  Note: Guild.getMembers() will still contain the Member until Discord sends the GuildMemberRemoveEvent.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
  
  UNKNOWN_USER
  The user no longer exists
  Parameters:
  
  deletionTimeframe - The timeframe for the history of messages that will be deleted. (seconds precision)
  
  unit - Timeframe unit as a TimeUnit (for example member.ban(7, TimeUnit.DAYS)).
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.
  
  HierarchyException - If the logged in account cannot ban the other user due to permission hierarchy position.
  See canInteract(Member)
  
  IllegalArgumentException -
  
  If the provided deletionTimeframe is negative.
  
  If the provided deletionTimeframe is longer than 7 days.
  
  If the provided time unit is null
  
  DetachedEntityException - If this entity is detached
  
  See Also:
  
  Guild.ban(UserSnowflake, int, TimeUnit)
  
  AuditableRestAction.reason(String)
- kick
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> kick()
  Kicks this Member from the Guild.
  Note: Guild.getMembers() will still contain the User until Discord sends the GuildMemberRemoveEvent.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The target Member cannot be kicked due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  Returns:
  
  AuditableRestAction Kicks the provided Member from the current Guild
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.KICK_MEMBERS permission.
  
  HierarchyException - If the logged in account cannot kick the other member due to permission hierarchy position.
  See canInteract(Member)
  
  DetachedEntityException - If this entity is detached
  
  Since:
  
  4.0.0
- timeoutFor
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> timeoutFor(long amount, @Nonnull TimeUnit unit)
  Puts this Member in time out in this Guild for a specific amount of time.
  While a Member is in time out, all permissions except VIEW_CHANNEL and MESSAGE_HISTORY are removed from them.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The target Member cannot be put into time out due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  Parameters:
  
  amount - The amount of the provided unit to put this Member in time out for
  
  unit - The Unit type of amount
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.MODERATE_MEMBERS permission.
  
  IllegalArgumentException - If any of the following checks are true
  
  The provided amount is lower than or equal to 0
  
  The provided unit is null
  
  The provided amount with the unit results in a date that is more than 28 days in the future
  
  DetachedEntityException - If this entity is detached
- timeoutFor
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> timeoutFor(@Nonnull Duration duration)
  Puts this Member in time out in this Guild for a specific amount of time.
  While a Member is in time out, all permissions except VIEW_CHANNEL and MESSAGE_HISTORY are removed from them.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The target Member cannot be put into time out due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  Parameters:
  
  duration - The duration to put this Member in time out for
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.MODERATE_MEMBERS permission.
  
  IllegalArgumentException - If any of the following checks are true
  
  The provided duration is null
  
  The provided duration is not positive
  
  The provided duration results in a date that is more than 28 days in the future
  
  DetachedEntityException - If this entity is detached
- timeoutUntil
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> timeoutUntil(@Nonnull TemporalAccessor temporal)
  Puts this Member in time out in this Guild until the specified date.
  While a Member is in time out, all permissions except VIEW_CHANNEL and MESSAGE_HISTORY are removed from them.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The target Member cannot be put into time out due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  Parameters:
  
  temporal - The time this Member will be released from time out
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.MODERATE_MEMBERS permission.
  
  IllegalArgumentException - If any of the following checks are true
  
  The provided temporal is null
  
  The provided temporal is in the past
  
  The provided temporal is more than 28 days in the future
  
  DetachedEntityException - If this entity is detached
- removeTimeout
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> removeTimeout()
  Removes a time out from this Member in this Guild.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The time out cannot be removed due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.MODERATE_MEMBERS permission.
  
  DetachedEntityException - If this entity is detached
- mute
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> mute(boolean mute)
  Sets the Guild Muted state state of this Member based on the provided boolean.
  Note: The Member's GuildVoiceState.isGuildMuted() value won't change until JDA receives the GuildVoiceGuildMuteEvent event related to this change.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The target Member cannot be muted due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  
  USER_NOT_CONNECTED
  The specified Member is not connected to a voice channel
  Parameters:
  
  mute - Whether this Member should be muted or unmuted.
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.VOICE_DEAF_OTHERS permission.
  
  IllegalStateException - If the member is not currently connected to a voice channel.
  
  DetachedEntityException - If this entity is detached
  
  Since:
  
  4.0.0
- deafen
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> deafen(boolean deafen)
  Sets the Guild Deafened state state of this Member based on the provided boolean.
  Note: The Member's GuildVoiceState.isGuildDeafened() value won't change until JDA receives the GuildVoiceGuildDeafenEvent event related to this change.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The target Member cannot be deafened due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  
  USER_NOT_CONNECTED
  The specified Member is not connected to a voice channel
  Parameters:
  
  deafen - Whether this Member should be deafened or undeafened.
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the logged in account does not have the Permission.VOICE_DEAF_OTHERS permission.
  
  IllegalStateException - If the member is not currently connected to a voice channel.
  
  DetachedEntityException - If this entity is detached
  
  Since:
  
  4.0.0
- modifyNickname
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> modifyNickname(@Nullable String nickname)
  Changes this Member's nickname in this guild. The nickname is visible to all members of this guild.
  To change the nickname for the currently logged in account only the Permission NICKNAME_CHANGE is required.
  To change the nickname of any Member for this Guild the Permission NICKNAME_MANAGE is required.
  Possible ErrorResponses caused by the returned RestAction include the following:
  
  MISSING_PERMISSIONS
  The nickname of the target Member is not modifiable due to a permission discrepancy
  
  UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
  Parameters:
  
  nickname - The new nickname of the Member, provide null or an empty String to reset the nickname
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException -
  
  If attempting to set nickname for self and the logged in account has neither Permission.NICKNAME_CHANGE or Permission.NICKNAME_MANAGE
  
  If attempting to set nickname for another member and the logged in account does not have Permission.NICKNAME_MANAGE
  
  HierarchyException - If attempting to set nickname for another member and the logged in account cannot manipulate the other user due to permission hierarchy position.
  See canInteract(Member).
  
  DetachedEntityException - If this entity is detached
  
  Since:
  
  4.0.0
- modifyFlags
  
  @Nonnull @CheckReturnValue default AuditableRestAction<Void> modifyFlags(@Nonnull Collection<Member.MemberFlag> newFlags)
  
  Updates the flags to the new flag set.
  If any of the flags is not modifiable, it is not updated.
  Any flags not provided by the set will be disabled, all contained flags will be enabled.
  
  Parameters:
  
  newFlags - The new flags for the member.
  
  Returns:
  
  AuditableRestAction
  
  Throws:
  
  InsufficientPermissionException - If the bot does not have Permission.MODERATE_MEMBERS in the guild
  
  IllegalArgumentException - If null is provided
  
  DetachedEntityException - If this entity is detached

Interface Member

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity

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

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

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

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

Field Details

AVATAR_URL

MAX_TIME_OUT_LENGTH

Method Details

getUser

getGuild

getJDA

getTimeJoined

hasTimeJoined

getTimeBoosted

isBoosting

getTimeOutEnd

isTimedOut

getVoiceState

getActivities

getOnlineStatus

getOnlineStatus

getActiveClients

getNickname

getEffectiveName

getAvatarId

getAvatarUrl

getAvatar

getEffectiveAvatarUrl

getEffectiveAvatar

getRoles

getColor

getColorRaw

getFlagsRaw

getFlags

canInteract

canInteract

canInteract

isOwner

isPending

getDefaultChannel

ban

kick

timeoutFor

timeoutFor

timeoutUntil

removeTimeout

mute

deafen

modifyNickname

modifyFlags