discord4j.core.object.entity

Class User

java.lang.Object

discord4j.core.object.entity.User

All Implemented Interfaces:

DiscordObject, Entity

Direct Known Subclasses:

Member

public class User
extends Object
implements Entity

A Discord user.

See Also:

Users Resource

Constructor Summary

Constructors

Constructor and Description
User(ServiceMediator serviceMediator, UserBean data) Constructs an User with an associated ServiceMediator and Discord data.

Method Summary

Modifier and Type	Method and Description
Mono<Member>	asMember(Snowflake guildId) Requests to retrieve this user as a Member.
boolean	equals(Object obj)
String	getAvatarUrl() Gets the user's effective avatar URL.
Optional<String>	getAvatarUrl(Image.Format format) Gets the user's avatar URL, if present and in a supported format.
DiscordClient	getClient() Gets the DiscordClient associated to this object.
String	getDefaultAvatarUrl() Gets the default avatar URL for this user.
String	getDiscriminator() Gets the user's 4-digit discord-tag.
Snowflake	getId() Gets the Snowflake that uniquely identifies this entity.
String	getMention() Gets the raw mention.
Mono<PrivateChannel>	getPrivateChannel() Requests to retrieve the private channel (DM) to this user.
String	getUsername() Gets the user's username, not unique across the platform.
boolean	hasAnimatedAvatar() Gets if the user's avatar is animated.
int	hashCode()
boolean	isBot() Gets whether the user is a bot.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(ServiceMediator serviceMediator,
            UserBean data)

Constructs an User with an associated ServiceMediator and Discord data.

Parameters:

serviceMediator - The ServiceMediator associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

Method Detail

getClient

public final DiscordClient getClient()

Description copied from interface: DiscordObject

Gets the DiscordClient associated to this object.

Specified by:

getClient in interface DiscordObject

Returns:

The DiscordClient associated to this object.

getUsername

public final String getUsername()

Gets the user's username, not unique across the platform.

Returns:

The user's username, not unique across the platform.

getDiscriminator

public final String getDiscriminator()

Gets the user's 4-digit discord-tag.

Returns:

The user's 4-digit discord-tag.

hasAnimatedAvatar

public final boolean hasAnimatedAvatar()

Gets if the user's avatar is animated.

Returns:

true if the user's avatar is animated, false otherwise.

getAvatarUrl

public final Optional<String> getAvatarUrl(Image.Format format)

Gets the user's avatar URL, if present and in a supported format.

Parameters:

format - The format for the URL. Supported format types are GIF if animated, otherwise PNG or JPEG.

Returns:

The user's avatar URL, if present and in a supported format.

getDefaultAvatarUrl

public final String getDefaultAvatarUrl()

Gets the default avatar URL for this user.

Returns:

The default avatar URL for this user.

getAvatarUrl

public final String getAvatarUrl()

Gets the user's effective avatar URL.

Returns:

The user's effective avatar URL.

Implementation Note:

This method will first attempt to get the user's avatar URL. If the avatar is animated, a GIF is returned; otherwise a PNG is returned. The default avatar URL is returned if no avatar is set for this user.

isBot

public boolean isBot()

Gets whether the user is a bot.

Returns:

true if this user is a bot, false otherwise.

getMention

public final String getMention()

Gets the raw mention. This is the format utilized to directly mention another user (assuming the user exists in context of the mention).

Returns:

The raw mention.

getId

public final Snowflake getId()

Description copied from interface: Entity

Gets the Snowflake that uniquely identifies this entity.

Specified by:

getId in interface Entity

Returns:

The Snowflake that uniquely identifies this entity.

asMember

public Mono<Member> asMember(Snowflake guildId)

Requests to retrieve this user as a Member.

Parameters:

guildId - The ID of the guild to associate this user as a Member.

Returns:

A Mono where, upon successful completion, emits this user as a member. If an error is received, it is emitted through the Mono.

getPrivateChannel

public final Mono<PrivateChannel> getPrivateChannel()

Requests to retrieve the private channel (DM) to this user.

Returns:

A Mono where, upon successful completion, emits the private channel to this user. If an error is received, it is emitted through the Mono.

equals

public final boolean equals(@Nullable
                            Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object