net.wildfyre.users

Class LoggedUser

java.lang.Object

net.wildfyre.descriptors.Descriptor

net.wildfyre.users.User

net.wildfyre.users.LoggedUser

public class LoggedUser
extends User

Represents the user you are logging-in with.

Field Summary

Fields inherited from class net.wildfyre.users.User

avatar, bio, ID, isBanned, name

Method Summary

Modifier and Type	Method and Description
boolean	canEdit() Can this user be edited?
Stream<Post>	posts() Returns a Stream of every post created by the user in any Area.
List<Post>	postsList() Returns a list of the posts created by the user in any Area.
void	set(String username, String bio, String avatar) Changes the username, bio or avatar of the user.
void	setAvatar(String avatar) Sets this user's avatar.
void	setBio(String bio) Sets this user's bio.
void	setUsername(String username) Sets this user's name.

Methods inherited from class net.wildfyre.users.User

asLogged, avatar, avatarUrl, bio, cacheManager, equals, getID, hashCode, isBanned, name, toString, update

Methods inherited from class net.wildfyre.descriptors.Descriptor

isNew, isValid, isValid, use

Methods inherited from class java.lang.Object

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

Method Detail

canEdit

public boolean canEdit()

Description copied from class: User

Can this user be edited?

This method will always return false for a User, and will always return true for a LoggedUser

Overrides:

canEdit in class User

Returns:

true if the user's information can edited.

See Also:

Get this object as a LoggedUser

setBio

public void setBio(String bio)

Sets this user's bio.

This method is a wrapper around set(String, String, String), see its documentation for more information.

Parameters:

bio - the new bio

setUsername

public void setUsername(String username)

Sets this user's name.

This method is a wrapper around set(String, String, String), see its documentation for more information.

Parameters:

username - the new user's name

setAvatar

public void setAvatar(String avatar)

Sets this user's avatar.

This method is a wrapper around set(String, String, String), see its documentation for more information.

Parameters:

avatar - the new user's avatar

set

public void set(String username,
                String bio,
                String avatar)

Changes the username, bio or avatar of the user.

This method uses client-side prediction, which means that the changes will be reflected to the current object immediately, and the query will be sent to the server.

You can select which fields to update and which fields to keep by giving null to any unchanged field. However, you cannot specify ONLY null values (the request to the server would be empty!)

Parameters:

username - the user's name

bio - the user's bio

avatar - the user's avatar (URL path)

See Also:

Set only the avatar, Set only the bio, Set only the username

posts

public Stream<Post> posts()

Returns a Stream of every post created by the user in any Area.

Returns:

A Stream of the posts created by the user.

See Also:

Get only the posts created in a specific Area., This method as a List

postsList

public List<Post> postsList()

Returns a list of the posts created by the user in any Area.

For performance reasons, we strongly recommend using posts() to get a Stream, this method is provided for the case in which you really need a Collection.

Returns:

The List of the posts created by this user.

See Also:

This method as a Stream, for better performances