net.dv8tion.jda.entities

Interface User

All Known Subinterfaces:

SelfInfo

All Known Implementing Classes:

SelfInfoImpl, UserImpl

public interface User

Represents a Discord User. Contains all publicly available information about a specific Discord User.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getId

java.lang.String getId()

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

Returns:

Never-null String containing the User id.

getUsername

java.lang.String getUsername()

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

Returns:

Never-null String containing the User username.

getDiscriminator

java.lang.String getDiscriminator()

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

Returns:

Never-null String containing the User discriminator.

getAvatarId

java.lang.String getAvatarId()

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

Returns:

Possibly-null String containing the User avatar id.

getAvatarUrl

java.lang.String getAvatarUrl()

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

Returns:

Possibly-null String containing the User avatar url.

getCurrentGame

java.lang.String getCurrentGame()

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

Returns:

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

getOnlineStatus

OnlineStatus getOnlineStatus()

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

Returns:

The current OnlineStatus of the User.

getPrivateChannel

PrivateChannel getPrivateChannel()

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

Returns:

Never-null PrivateChannel that is associated with this User.

getJDA

JDA getJDA()

Returns the JDA instance of this User

Returns:

the corresponding JDA instance