Package com.vonage.client.users

Class User

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.users.BaseUser

com.vonage.client.users.User

All Implemented Interfaces:

Jsonable

public class User
extends BaseUser

Represents a Vonage User (both request and response).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	User.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	User()
protected	User(User.Builder builder)

Method Summary

Modifier and Type	Method	Description
static User.Builder	builder()	Entry point for creating an instance of this class.
static User	fromJson(String json)	Constructs a user from the JSON payload.
Channels	getChannels()	The communication channels available to the user.
Map<String,?>	getCustomData()	Custom key/value pairs to associate with the user.
String	getDisplayName()	A string to be displayed as username.
URI	getImageUrl()	An image URL to associate with the user.

Methods inherited from class com.vonage.client.users.BaseUser

getId, getName

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

User

protected User()

User

protected User(User.Builder builder)

Method Details

getDisplayName

public String getDisplayName()

A string to be displayed as username. It does not need to be unique.

Returns:

The user's friendly name.

getImageUrl

public URI getImageUrl()

An image URL to associate with the user.

Returns:

The image URL, or null if not specified.

getCustomData

public Map<String,?> getCustomData()

Custom key/value pairs to associate with the user.

Returns:

The custom data as a Map, or null if not specified.

getChannels

public Channels getChannels()

The communication channels available to the user.

Returns:

The channels object, or null if unknown.

fromJson

public static User fromJson(String json)

Constructs a user from the JSON payload.

Parameters:

json - The JSON structure containing the fields of this class.

Returns:

A new User instance.

builder

public static User.Builder builder()

Entry point for creating an instance of this class.

Returns:

A new Builder.