net.dv8tion.jda.entities.impl

Class UserImpl

java.lang.Object

net.dv8tion.jda.entities.impl.UserImpl

All Implemented Interfaces:

User

Direct Known Subclasses:

SelfInfoImpl

public class UserImpl
extends java.lang.Object
implements User

Constructor Summary

Constructors

Constructor and Description
UserImpl(java.lang.String id, JDAImpl api)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getAvatarId() The Discord Id for this user's avatar image.
java.lang.String	getAvatarUrl() The URL for the for the user's avatar image.
java.lang.String	getCurrentGame() The name of the game that the user is currently playing.
java.lang.String	getDiscriminator() The descriminator of the User.
java.lang.String	getId() The Discord ID of the User.
JDA	getJDA() Returns the JDA instance of this User
OnlineStatus	getOnlineStatus() Returns the OnlineStatus of the User. If the OnlineStatus is unrecognized, will return UNKNOWN.
PrivateChannel	getPrivateChannel() Gets the PrivateChannel of this User for use in sending direct messages.
java.lang.String	getUsername() The username of the User.
int	hashCode()
boolean	hasPrivateChannel()
UserImpl	setAvatarId(java.lang.String avatarId)
UserImpl	setCurrentGame(java.lang.String name)
UserImpl	setDiscriminator(java.lang.String discriminator)
UserImpl	setOnlineStatus(OnlineStatus onlineStatus)
UserImpl	setPrivateChannel(PrivateChannel channel)
UserImpl	setUserName(java.lang.String username)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserImpl

public UserImpl(java.lang.String id,
                JDAImpl api)

Method Detail

getJDA

public JDA getJDA()

Description copied from interface: User

Returns the JDA instance of this User

Specified by:

getJDA in interface User

Returns:

the corresponding JDA instance

getId

public java.lang.String getId()

Description copied from interface: User

The Discord ID of the User. This is typically 18 characters long.

Specified by:

getId in interface User

Returns:

Never-null String containing the User id.

getUsername

public java.lang.String getUsername()

Description copied from interface: User

The username of the User. Length is between 2 and 32 characters (inclusive).

Specified by:

getUsername in interface User

Returns:

Never-null String containing the User username.

getDiscriminator

public java.lang.String getDiscriminator()

Description copied from interface: User

The descriminator of the User. Used to differentiate between users with the same usernames.
This will be important when the friends list is released for human readable searching.
Ex: DV8FromTheWorld#9148

Specified by:

getDiscriminator in interface User

Returns:

Never-null String containing the User discriminator.

getAvatarId

public java.lang.String getAvatarId()

Description copied from interface: User

The Discord Id for this user's avatar image. If the user has not set an image, this will return null.

Specified by:

getAvatarId in interface User

Returns:

Possibly-null String containing the User avatar id.

getAvatarUrl

public java.lang.String getAvatarUrl()

Description copied from interface: User

The URL for the for the user's avatar image. If the user has not set an image, this will return null.

Specified by:

getAvatarUrl in interface User

Returns:

Possibly-null String containing the User avatar url.

getCurrentGame

public java.lang.String getCurrentGame()

Description copied from interface: User

The name of the game that the user is currently playing. If the user is not currently playing a game, this will return null.

Specified by:

getCurrentGame in interface User

Returns:

Possibly-null String containing the name of the game that the User is currently playing.

getOnlineStatus

public OnlineStatus getOnlineStatus()

Description copied from interface: User

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

Specified by:

getOnlineStatus in interface User

Returns:

The current OnlineStatus of the User.

getPrivateChannel

public PrivateChannel getPrivateChannel()

Description copied from interface: User

Gets the PrivateChannel of this User for use in sending direct messages.

Specified by:

getPrivateChannel in interface User

Returns:

Never-null PrivateChannel that is associated with this User.

setUserName

public UserImpl setUserName(java.lang.String username)

setDiscriminator

public UserImpl setDiscriminator(java.lang.String discriminator)

setAvatarId

public UserImpl setAvatarId(java.lang.String avatarId)

setCurrentGame

public UserImpl setCurrentGame(java.lang.String name)

setOnlineStatus

public UserImpl setOnlineStatus(OnlineStatus onlineStatus)

setPrivateChannel

public UserImpl setPrivateChannel(PrivateChannel channel)

hasPrivateChannel

public boolean hasPrivateChannel()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object