io.relayr.java.api

Interface UserApi

public interface UserApi

Method Summary

Modifier and Type	Method and Description
rx.Observable<Bookmark>	bookmarkPublicDevice(java.lang.String userId, java.lang.String deviceId) Bookmarks a specific public device.
rx.Observable<java.lang.Void>	deleteAllGroups(java.lang.String userId) Deletes all groups and returns 200 OK if successful, error otherwise.
rx.Observable<java.lang.Void>	deleteBookmark(java.lang.String userId, java.lang.String deviceId) Deletes a bookmarked device.
rx.Observable<java.lang.Void>	disconnectAccount(java.lang.String userId, java.lang.String accountName) Returns 200 OK (onNext()) if account is disconnected Use User.disconnectAccount(String) on fetched User object.
rx.Observable<java.util.List<Account>>	getAccounts(java.lang.String userId) Returns a list of accounts that user connected to the relayr account.
rx.Observable<java.util.List<BookmarkDevice>>	getBookmarkedDevices(java.lang.String userId) Returns a list of devices bookmarked by the user.
rx.Observable<java.util.List<Device>>	getDevices(java.lang.String userId) Returns user devices.
rx.Observable<java.util.List<Group>>	getGroups(java.lang.String userId) Returns list of groups created by user.
rx.Observable<java.util.List<Transmitter>>	getTransmitters(java.lang.String userId) Returns user transmitters.
rx.Observable<User>	getUserInfo()
rx.Observable<java.lang.Void>	isAccountConnected(java.lang.String userId, java.lang.String accountName) Returns 200 OK (onNext()) if named account is connected to the users relayr account Use User.isAccountConnected(String) on fetched User object.
rx.Observable<User>	updateUserDetails(User user, java.lang.String userId) Updates user details.

Method Detail

getUserInfo

@GET(value="/oauth2/user-info")
rx.Observable<User> getUserInfo()

Returns:

an Observable information about the user initiating the request.

getDevices

@GET(value="/users/{userId}/devices")
rx.Observable<java.util.List<Device>> getDevices(@Path(value="userId")
                                                                                       java.lang.String userId)

Returns user devices. Use User.getDevices() on fetched User object.

Parameters:

userId -

Returns:

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

getGroups

@GET(value="/users/{userId}/groups")
rx.Observable<java.util.List<Group>> getGroups(@Path(value="userId")
                                                                                    java.lang.String userId)

Returns list of groups created by user.

Returns:

an Observable with a list of all user groups Group.

deleteAllGroups

@DELETE(value="/users/{userId}/groups")
rx.Observable<java.lang.Void> deleteAllGroups(@Path(value="userId")
                                                                                      java.lang.String userId)

Deletes all groups and returns 200 OK if successful, error otherwise.

Returns:

an empty Observable

updateUserDetails

@PATCH(value="/users/{userId}")
rx.Observable<User> updateUserDetails(@Body
                                                                      User user,
                                                                      @Path(value="userId")
                                                                      java.lang.String userId)

Updates user details.

Parameters:

userId -

Returns:

Updated user object

getTransmitters

@GET(value="/users/{userId}/transmitters")
rx.Observable<java.util.List<Transmitter>> getTransmitters(@Path(value="userId")
                                                                                                      java.lang.String userId)

Returns user transmitters. Use User.getTransmitters() on fetched User object.

Parameters:

userId -

Returns:

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

bookmarkPublicDevice

@POST(value="/users/{userId}/devices/{deviceId}/bookmarks")
rx.Observable<Bookmark> bookmarkPublicDevice(@Path(value="userId")
                                                                                                         java.lang.String userId,
                                                                                                         @Path(value="deviceId")
                                                                                                         java.lang.String deviceId)

Bookmarks a specific public device. By Bookmarking a device you are indicating that you have a particular interest in this device. In order to receive data from a bookmarked device, the subscription call must first be initiated.

Parameters:

userId - id of the user that is bookmarking the device

deviceId - id of bookmarked device - the Id must be one of a public device

Returns:

an Observable to the bookmarked device

deleteBookmark

@DELETE(value="/users/{userId}/devices/{deviceId}/bookmarks")
rx.Observable<java.lang.Void> deleteBookmark(@Path(value="userId")
                                                                                                           java.lang.String userId,
                                                                                                           @Path(value="deviceId")
                                                                                                           java.lang.String deviceId)

Deletes a bookmarked device.

Parameters:

userId - id of the user that bookmarked the device

deviceId - id of bookmarked device - the Id must be one of a public device

Returns:

an empty Observable

getBookmarkedDevices

@GET(value="/users/{userId}/devices/bookmarks")
rx.Observable<java.util.List<BookmarkDevice>> getBookmarkedDevices(@Path(value="userId")
                                                                                                                   java.lang.String userId)

Returns a list of devices bookmarked by the user.

Parameters:

userId - id of the user that bookmarked devices

Returns:

an Observable with a list of the users bookmarked devices

getAccounts

@GET(value="/users/{userId}/accounts")
rx.Observable<java.util.List<Account>> getAccounts(@Path(value="userId")
                                                                                          java.lang.String userId)

Returns a list of accounts that user connected to the relayr account. Use User.getAccounts() on fetched User object.

Parameters:

userId - id of the user

Returns:

an Observable with a list of accounts Account

isAccountConnected

@GET(value="/users/{userId}/accounts/{accountName}/isconnected")
rx.Observable<java.lang.Void> isAccountConnected(@Path(value="userId")
                                                                                                                  java.lang.String userId,
                                                                                                                  @Path(value="accountName")
                                                                                                                  java.lang.String accountName)

Returns 200 OK (onNext()) if named account is connected to the users relayr account Use User.isAccountConnected(String) on fetched User object.

Parameters:

userId - id of the user

accountName - name of the connected account Account.name

Returns:

an empty Observable

disconnectAccount

@POST(value="/users/{userId}/accounts/{accountName}/disconnect")
rx.Observable<java.lang.Void> disconnectAccount(@Path(value="userId")
                                                                                                                 java.lang.String userId,
                                                                                                                 @Path(value="accountName")
                                                                                                                 java.lang.String accountName)

Returns 200 OK (onNext()) if account is disconnected Use User.disconnectAccount(String) on fetched User object.

Parameters:

userId - id of the user

accountName - name of the connected account Account.name

Returns:

an empty Observable