io.relayr.java.model

Class User

java.lang.Object

io.relayr.java.model.User

All Implemented Interfaces:

java.io.Serializable

public class User
extends java.lang.Object
implements java.io.Serializable

The first basic entity in the relayr platform is the user. Every user registers with an email address, a respective name and password and is assigned a unique userId. A user can be both an application owner (a publisher) and an end user. A user is required in order to add other entities to the relayr platform.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
User(java.lang.String id, java.lang.String name, java.lang.String email)
User(java.lang.String id, java.lang.String name, java.lang.String email, java.lang.String firstName, java.lang.String lastName, java.lang.String company, java.lang.String industry)

Method Summary

Modifier and Type	Method and Description
rx.Observable<retrofit.client.Response>	checkDevicePermission(java.lang.String deviceId, DevicePermission permission)
rx.Observable<java.lang.Void>	disconnectAccount(java.lang.String accountName) Returns error if account is not successfully disconnected.
rx.Observable<JsonListResponse<Device>>	filterDevices(java.lang.Integer pageNumber, java.lang.Integer pageSize, java.lang.String[] deviceIds, java.lang.String modelId, java.lang.String firmwareVersion, java.lang.String name, java.lang.String description)
rx.Observable<JsonListResponse<Device>>	filterDevices(java.lang.String[] deviceIds, java.lang.String modelId, java.lang.String name, java.lang.String description)
rx.Observable<java.util.List<Account>>	getAccounts() Returns a list of third party accounts that user connected with relayr platform.
rx.Observable<JsonListResponse<Device>>	getAllDevices()
java.lang.String	getCompanyName()
rx.Observable<Device>	getDevice(java.lang.String deviceId)
rx.Observable<java.util.List<Device>>	getDevices()
java.lang.String	getEmail()
java.lang.String	getFirstName()
rx.Observable<java.util.List<Group>>	getGroups() Returns list of Group objects
java.lang.String	getId()
java.lang.String	getIndustryArea()
java.lang.String	getLastName()
java.lang.String	getName()
rx.Observable<java.util.List<Transmitter>>	getTransmitters()
rx.Observable<java.lang.Void>	isAccountConnected(java.lang.String accountName) Returns error if account is not connected.
void	setName(java.lang.String name)
java.lang.String	toString()
rx.Observable<User>	update(java.lang.String username) Updates username.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(java.lang.String id,
            java.lang.String name,
            java.lang.String email)

User

public User(java.lang.String id,
            java.lang.String name,
            java.lang.String email,
            java.lang.String firstName,
            java.lang.String lastName,
            java.lang.String company,
            java.lang.String industry)

Method Detail

getId

public java.lang.String getId()

getEmail

public java.lang.String getEmail()

getName

public java.lang.String getName()

getFirstName

public java.lang.String getFirstName()

getLastName

public java.lang.String getLastName()

getCompanyName

public java.lang.String getCompanyName()

getIndustryArea

public java.lang.String getIndustryArea()

setName

public void setName(java.lang.String name)

getDevice

public rx.Observable<Device> getDevice(java.lang.String deviceId)

Returns:

an Observable of a list of devices registered under a user.

Throws:

java.lang.NullPointerException - if deviceId is NULL

getDevices

public rx.Observable<java.util.List<Device>> getDevices()

Returns:

an Observable of a list of devices owned by user.

getAllDevices

public rx.Observable<JsonListResponse<Device>> getAllDevices()

Returns:

an Observable of a list of devices OWNED by the user and SHARED with user.

filterDevices

public rx.Observable<JsonListResponse<Device>> filterDevices(java.lang.String[] deviceIds,
                                                             java.lang.String modelId,
                                                             java.lang.String name,
                                                             java.lang.String description)
                                                      throws java.lang.IllegalArgumentException,
                                                             java.lang.NullPointerException

Returns:

an Observable of a list of devices owned and shared with user and filtered by provided parameters

Throws:

java.lang.IllegalArgumentException

java.lang.NullPointerException

filterDevices

public rx.Observable<JsonListResponse<Device>> filterDevices(java.lang.Integer pageNumber,
                                                             java.lang.Integer pageSize,
                                                             java.lang.String[] deviceIds,
                                                             java.lang.String modelId,
                                                             java.lang.String firmwareVersion,
                                                             java.lang.String name,
                                                             java.lang.String description)
                                                      throws java.lang.IllegalArgumentException,
                                                             java.lang.NullPointerException

Returns:

an Observable of a list of devices owned and shared with user and filtered by provided parameters

Throws:

java.lang.IllegalArgumentException

java.lang.NullPointerException

checkDevicePermission

public rx.Observable<retrofit.client.Response> checkDevicePermission(java.lang.String deviceId,
                                                                     DevicePermission permission)
                                                              throws java.lang.IllegalArgumentException,
                                                                     java.lang.NullPointerException

Returns:

204 - if allowed 400 - Missing or invalid Authorisation Header or Token 401 - Unauthorized 403 - Forbidden 404 - Device is not Found.

Throws:

java.lang.IllegalArgumentException

java.lang.NullPointerException

getTransmitters

public rx.Observable<java.util.List<Transmitter>> getTransmitters()

Returns:

an Observable with a list all Transmitters listed under a user.

getAccounts

public rx.Observable<java.util.List<Account>> getAccounts()

Returns a list of third party accounts that user connected with relayr platform.

Returns:

an Observable with a list of Account

isAccountConnected

public rx.Observable<java.lang.Void> isAccountConnected(java.lang.String accountName)

Returns error if account is not connected.

Returns:

an empty Observable

Throws:

java.lang.NullPointerException - if parameter is NULL

disconnectAccount

public rx.Observable<java.lang.Void> disconnectAccount(java.lang.String accountName)

Returns error if account is not successfully disconnected.

Returns:

an empty Observable

Throws:

java.lang.NullPointerException - if parameter is NULL

getGroups

public rx.Observable<java.util.List<Group>> getGroups()

Returns list of Group objects

Returns:

an Observable list

update

public rx.Observable<User> update(java.lang.String username)

Updates username.

Parameters:

username - new username

Throws:

java.lang.NullPointerException - if username is NULL

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object