info.u_team.u_team_core.repack.com.jagrosh.discordipc.entities

Class User

java.lang.Object

info.u_team.u_team_core.repack.com.jagrosh.discordipc.entities.User

public class User
extends java.lang.Object

A encapsulation of a Discord User's data provided when a IPCListener fires onActivityJoinRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.DefaultAvatar Constants representing one of five different default avatars a User can have.

Constructor Summary

Constructors

Constructor and Description
User(java.lang.String name, java.lang.String discriminator, long id, java.lang.String avatar) Constructs a new User.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getAsMention() Gets the User as a discord formatted mention.
java.lang.String	getAvatarId() Gets the Users avatar ID.
java.lang.String	getAvatarUrl() Gets the Users avatar URL.
java.lang.String	getDefaultAvatarId() Gets the Users User.DefaultAvatar avatar ID.
java.lang.String	getDefaultAvatarUrl() Gets the Users User.DefaultAvatar avatar URL.
java.lang.String	getDiscriminator() Gets the Users discriminator.
java.lang.String	getEffectiveAvatarUrl() Gets the Users avatar URL, or their User.DefaultAvatar avatar URL if they do not have a custom avatar set on their account.
java.lang.String	getId() Gets the Users Snowflake ID as a String.
long	getIdLong() Gets the Users Snowflake ID as a long.
java.lang.String	getName() Gets the Users account name.
int	hashCode()
boolean	isBot() Gets whether or not this User is a bot.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(java.lang.String name,
            java.lang.String discriminator,
            long id,
            java.lang.String avatar)

Constructs a new User.
Only implemented internally.

Parameters:

name - user's name

discriminator - user's discrim

id - user's id

avatar - user's avatar hash, or null if they have no avatar

Method Detail

getName

public java.lang.String getName()

Gets the Users account name.

Returns:

The Users account name.

getDiscriminator

public java.lang.String getDiscriminator()

Gets the Users discriminator.

Returns:

The Users discriminator.

getIdLong

public long getIdLong()

Gets the Users Snowflake ID as a long.

Returns:

The Users Snowflake ID as a long.

getId

public java.lang.String getId()

Gets the Users Snowflake ID as a String.

Returns:

The Users Snowflake ID as a String.

getAvatarId

public java.lang.String getAvatarId()

Gets the Users avatar ID.

Returns:

The Users avatar ID.

getAvatarUrl

public java.lang.String getAvatarUrl()

Gets the Users avatar URL.

Returns:

The Users avatar URL.

getDefaultAvatarId

public java.lang.String getDefaultAvatarId()

Gets the Users User.DefaultAvatar avatar ID.

Returns:

The Users User.DefaultAvatar avatar ID.

getDefaultAvatarUrl

public java.lang.String getDefaultAvatarUrl()

Gets the Users User.DefaultAvatar avatar URL.

Returns:

The Users User.DefaultAvatar avatar URL.

getEffectiveAvatarUrl

public java.lang.String getEffectiveAvatarUrl()

Gets the Users avatar URL, or their User.DefaultAvatar avatar URL if they do not have a custom avatar set on their account.

Returns:

The Users effective avatar URL.

isBot

public boolean isBot()

Gets whether or not this User is a bot.

While, at the time of writing this documentation, bots cannot use Rich Presence features, there may be a time in the future where they have such an ability.

Returns:

False

getAsMention

public java.lang.String getAsMention()

Gets the User as a discord formatted mention.

<@SNOWFLAKE_ID>

Returns:

A discord formatted mention of this User.

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