engineer.nightowl.groupsio.api.resource

Class UserResource

java.lang.Object

engineer.nightowl.groupsio.api.resource.BaseResource

engineer.nightowl.groupsio.api.resource.UserResource

public class UserResource
extends BaseResource

Field Summary

Fields inherited from class engineer.nightowl.groupsio.api.resource.BaseResource

apiClient, baseUrl, MAX_RESULTS, OM

Constructor Summary

Constructors

Constructor and Description
UserResource(GroupsIOApiClient apiClient, String baseUrl)

Method Summary

Modifier and Type	Method and Description
void	deleteSubscription(Subscription subscription)
Subscription	getSubscription(Integer groupId) Gets a user's Subscription for the specified group ID
List<Subscription>	getSubscriptions() Gets a list of Subscriptions that the current user is subscribed to.
User	getUser() Get the user information associated with the currently-logged in user.
void	joinGroup(Integer groupId)
Subscription	updateSubscription(Subscription subscription)
User	updateUser(User user) Update a user given a blank User object with only the updated fields set.

Methods inherited from class engineer.nightowl.groupsio.api.resource.BaseResource

callApi, callApi, login

Methods inherited from class java.lang.Object

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

Constructor Detail

UserResource

public UserResource(GroupsIOApiClient apiClient,
                    String baseUrl)

Method Detail

getUser

public User getUser()
             throws URISyntaxException,
                    IOException,
                    GroupsIOApiException

Get the user information associated with the currently-logged in user.

Returns:

User representing the current user

Throws:

URISyntaxException

IOException

GroupsIOApiException

getSubscription

public Subscription getSubscription(Integer groupId)
                             throws URISyntaxException,
                                    IOException,
                                    GroupsIOApiException

Gets a user's Subscription for the specified group ID

Returns:

the user's Subscription for the specified group ID

Throws:

URISyntaxException

IOException

GroupsIOApiException

getSubscriptions

public List<Subscription> getSubscriptions()
                                    throws URISyntaxException,
                                           IOException,
                                           GroupsIOApiException

Gets a list of Subscriptions that the current user is subscribed to.

Returns:

List<Subscription> representing the subscriptions

Throws:

URISyntaxException

IOException

GroupsIOApiException

updateUser

public User updateUser(User user)
                throws URISyntaxException,
                       IOException,
                       GroupsIOApiException

Update a user given a blank User object with only the updated fields set. Example:

 final User userToUpdate = new User();
 userToUpdate.setPerPagePref("user_per_page_pref50");
 final User updatedUser = client.user().updateUser(userToUpdate);
 

Parameters:

user - - with only the updated fields set

Returns:

the full User after a successful update

Throws:

URISyntaxException

IOException

GroupsIOApiException

updateSubscription

public Subscription updateSubscription(Subscription subscription)

deleteSubscription

public void deleteSubscription(Subscription subscription)

joinGroup

public void joinGroup(Integer groupId)