org.sobotics.chatexchange.chat

Class User

java.lang.Object

org.sobotics.chatexchange.chat.User

public final class User
extends Object

This class represents a chat user. Users having a negative id are system users (like Feeds).

A user is inherently linked to a chat room: an instance of User can only be obtained by calling Room.getUser(long), or by retrieving the user of a message with Message.getUser()}. The same Stack Exchange user can have different properties depending on the chat room it was obtained with, like being a room owner or not.

Author:

Tunaki

Method Summary

Modifier and Type	Method and Description
long	getId() Returns the id of this user.
Instant	getLastMessageDate() Returns the last date at which this user posted a message in the room (UTC).
Instant	getLastSeenDate() Returns the last date at which this user was seen in the room (UTC).
String	getName() Returns the display name of this user.
String	getProfileLink() Returns a link to the chat user profile of this user.
int	getReputation() Returns the amount of reputation this user has.
boolean	isCurrentlyInRoom() Tells whether this user is currently in this room or not.
boolean	isModerator() Tells whether this user is a moderator.
boolean	isRoomOwner() Tells whether this user is a room owner.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getId

public long getId()

Returns the id of this user. This can be negative in case of system users.

Returns:

Id of this user.

getName

public String getName()

Returns the display name of this user.

Returns:

Display name of this user.

getReputation

public int getReputation()

Returns the amount of reputation this user has. In case of system users, this will be 0.

Returns:

Amount of reputation this user has.

isModerator

public boolean isModerator()

Tells whether this user is a moderator.

Returns:

Is this user a moderator?

isRoomOwner

public boolean isRoomOwner()

Tells whether this user is a room owner.

Returns:

Is this user a room owner?

getLastSeenDate

public Instant getLastSeenDate()

Returns the last date at which this user was seen in the room (UTC). This will be null in the case of users that never joined the room.

Returns:

Last date at which this user was seen in the room (UTC).

getLastMessageDate

public Instant getLastMessageDate()

Returns the last date at which this user posted a message in the room (UTC). This will be null in the case of users that never joined the room.

Returns:

Last date at which this user posted a message in the room (UTC).

isCurrentlyInRoom

public boolean isCurrentlyInRoom()

Tells whether this user is currently in this room or not.

Returns:

Currently in the room or not.

getProfileLink

public String getProfileLink()

Returns a link to the chat user profile of this user. Note that it is distinct from the main user profile.

Returns:

Link to the chat user profile.