com.gluonhq.connect.gluoncloud

Class User

java.lang.Object

com.gluonhq.connect.gluoncloud.User

public class User
extends java.lang.Object

The User class contains information about a user that was authenticated at Gluon CloudLink using one of the login methods that are configured for a Gluon CloudLink application.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
static User	fromJson(javax.json.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 CloudLink 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 URL to the profile picture of this user.
void	setKey(java.lang.String key) Set the key that uniquely identifies this user.
void	setName(java.lang.String name) Set the name for this user.
void	setNetworkId(java.lang.String networkId) Set the unique id within a social network for this user.
void	setNick(java.lang.String nick) Set the nick name for this user.
void	setPicture(java.lang.String picture) Set the URL to the profile picture for this user.
javax.json.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 CloudLink application.

Returns:

The unique key of the user.

setKey

public void setKey(java.lang.String key)

Set the key that uniquely identifies this user.

Parameters:

key - The key for 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)

Set the name for this user.

Parameters:

name - The name for this user.

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)

Set the nick name for this user.

Parameters:

nick - The nick name for the user.

getPicture

public java.lang.String getPicture()

Get the URL to the profile picture of this user.

Returns:

The URL to the profile picture of this user.

setPicture

public void setPicture(java.lang.String picture)

Set the URL to the profile picture for this user.

Parameters:

picture - The URL to the profile picture for this user.

getNetworkId

public java.lang.String getNetworkId()

Get the unique id within a social network for this user.

Returns:

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

setNetworkId

public void setNetworkId(java.lang.String networkId)

Set the unique id within a social network for this user. This is only set when the user was authenticated with a LoginMethod that is linked with a social network.

Parameters:

networkId - The unique id of the social network that was used to authenticate this user.

fromJson

public static User fromJson(javax.json.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 javax.json.JsonObject toJson()

Converts this User instance to an immutable JSON object.

Returns:

A JSON object containing information of this user.