Package net.dv8tion.jda.core.utils
Class WidgetUtil.Widget.Member
- java.lang.Object
-
- net.dv8tion.jda.core.utils.WidgetUtil.Widget.Member
-
- All Implemented Interfaces:
java.util.Formattable
,IMentionable
,ISnowflake
- Enclosing class:
- WidgetUtil.Widget
public static class WidgetUtil.Widget.Member extends java.lang.Object implements ISnowflake, IMentionable
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getAsMention()
Retrieve a Mention for this Entity.java.lang.String
getAvatarId()
Gets the avatar hash of the member, or null if they do not have an avatar set.java.lang.String
getAvatarUrl()
Gets the avatar url of the member, or null if they do not have an avatar set.java.lang.String
getDefaultAvatarId()
Gets the asset id of the member's default avatarjava.lang.String
getDefaultAvatarUrl()
Gets the url of the member's default avatarjava.lang.String
getDiscriminator()
Gets the discriminator of the memberjava.lang.String
getEffectiveAvatarUrl()
The URL for the user's avatar image
If they do not have an avatar set, this will return the URL of their default avatarjava.lang.String
getEffectiveName()
Gets the visible name of the member.Game
getGame()
The game that the member is currently playing.long
getIdLong()
The Snowflake id of this entity.java.lang.String
getName()
Returns the username of the memberjava.lang.String
getNickname()
Gets the nickname of the member.OnlineStatus
getOnlineStatus()
Gets the online status of the member.WidgetUtil.Widget.VoiceState
getVoiceState()
The current voice state of the member.WidgetUtil.Widget
getWidget()
Gets the widget that to which this member belongsint
hashCode()
boolean
isBot()
Returns whether or not the given member is a bot accountjava.lang.String
toString()
-
Methods inherited from interface net.dv8tion.jda.core.entities.IMentionable
formatTo
-
Methods inherited from interface net.dv8tion.jda.core.entities.ISnowflake
getCreationTime, getId
-
-
-
-
Method Detail
-
isBot
public boolean isBot()
Returns whether or not the given member is a bot account- Returns:
- true if the member is a bot, false otherwise
-
getName
public java.lang.String getName()
Returns the username of the member- Returns:
- the username of the member
-
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 interfaceISnowflake
- Returns:
- Long containing the Id.
-
getAsMention
public java.lang.String getAsMention()
Description copied from interface:IMentionable
Retrieve a Mention for this Entity. For the publicRole
(@everyone), this will return the literal string"@everyone"
.- Specified by:
getAsMention
in interfaceIMentionable
- Returns:
- A resolvable mention.
-
getDiscriminator
public java.lang.String getDiscriminator()
Gets the discriminator of the member- Returns:
- the never-null discriminator of the member
-
getAvatarId
public java.lang.String getAvatarId()
Gets the avatar hash of the member, or null if they do not have an avatar set.- Returns:
- possibly-null String containing the avatar hash of the member
-
getAvatarUrl
public java.lang.String getAvatarUrl()
Gets the avatar url of the member, or null if they do not have an avatar set.- Returns:
- possibly-null String containing the avatar url of the member
-
getDefaultAvatarId
public java.lang.String getDefaultAvatarId()
Gets the asset id of the member's default avatar- Returns:
- never-null String containing the asset id of the member's default avatar
-
getDefaultAvatarUrl
public java.lang.String getDefaultAvatarUrl()
Gets the url of the member's default avatar- Returns:
- never-null String containing the url of the member's default avatar
-
getEffectiveAvatarUrl
public java.lang.String getEffectiveAvatarUrl()
The URL for the user's avatar image
If they do not have an avatar set, this will return the URL of their default avatar- Returns:
- Never-null String containing the member's effective avatar url.
-
getNickname
public java.lang.String getNickname()
Gets the nickname of the member. If they do not have a nickname on the guild, this will return null;- Returns:
- possibly-null String containing the nickname of the member
-
getEffectiveName
public java.lang.String getEffectiveName()
Gets the visible name of the member. If they have a nickname set, this will be their nickname. Otherwise, it will be their username.- Returns:
- never-null String containing the member's effective (visible) name
-
getOnlineStatus
public OnlineStatus getOnlineStatus()
Gets the online status of the member. The widget does not show offline members, so this status should never be offline- Returns:
- the
OnlineStatus
of the member
-
getGame
public Game getGame()
The game that the member is currently playing.
This game cannot be a stream. If the user is not currently playing a game, this will return null.- Returns:
- Possibly-null
Game
containing the game that the member is currently playing.
-
getVoiceState
public WidgetUtil.Widget.VoiceState getVoiceState()
The current voice state of the member.
If the user is not in voice, this will return a VoiceState with a null channel.- Returns:
- never-null VoiceState of the member
-
getWidget
public WidgetUtil.Widget getWidget()
Gets the widget that to which this member belongs- Returns:
- the Widget that holds this member
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-