com.gluonhq.charm.connect

Class User

java.lang.Object

com.gluonhq.charm.connect.User

public class User
extends java.lang.Object

The User class contains information about a Gluon Cloud user.

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
static User	fromJson(JsonObject json) Generate a new User instance by loading the fields from the provided JSON object.
java.lang.String	getKey() Get the key that uniquely identifies this user within a Gluon Cloud application.
java.lang.String	getName() Get the name of this user.
java.lang.String	getNetworkId() Get the unique id within a social network for this user.
java.lang.String	getNick() Get the nick name of this user.
java.lang.String	getPicture() Get the profile picture of this user.
boolean	isActive()
void	setActive(boolean active)
void	setKey(java.lang.String key) Set the key for this user.
void	setName(java.lang.String name)
void	setNetworkId(java.lang.String networkId)
void	setNick(java.lang.String nick)
void	setPicture(java.lang.String picture)
JsonObject	toJson() Converts this User instance to an immutable JSON object.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User()

Method Detail

getKey

public java.lang.String getKey()

Get the key that uniquely identifies this user within a Gluon Cloud application.

Returns:

The unique key of the user.

setKey

public void setKey(java.lang.String key)

Set the key for this user.

Parameters:

key - the key that uniquely identifies this user.

getName

public java.lang.String getName()

Get the name of this user.

Returns:

The name of the user.

setName

public void setName(java.lang.String name)

getNick

public java.lang.String getNick()

Get the nick name of this user.

Returns:

The nick name of the user.

setNick

public void setNick(java.lang.String nick)

getPicture

public java.lang.String getPicture()

Get the profile picture of this user.

Returns:

The profile picture of this user.

setPicture

public void setPicture(java.lang.String picture)

getNetworkId

public java.lang.String getNetworkId()

Get the unique id within a social network for this user. This is only set when the user was loaded from a social network.

Returns:

The unique id of the social network that was used to initially load this user.

setNetworkId

public void setNetworkId(java.lang.String networkId)

isActive

public boolean isActive()

Returns:

the active

setActive

public void setActive(boolean active)

Parameters:

active - the active to set

fromJson

public static User fromJson(JsonObject json)

Generate a new User instance by loading the fields from the provided JSON object.

Parameters:

json - a JSON object that contains the user information

Returns:

A new User instance.

toJson

public JsonObject toJson()

Converts this User instance to an immutable JSON object.

Returns:

A JSON object containing information for this user.