engineer.nightowl.groupsio.api.resource

Class GroupResource

java.lang.Object

engineer.nightowl.groupsio.api.resource.BaseResource

engineer.nightowl.groupsio.api.resource.GroupResource

public class GroupResource
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
GroupResource(GroupsIOApiClient apiClient, String baseUrl)

Method Summary

Modifier and Type	Method and Description
void	createSubGroup(Integer groupId, String name, String description, String privacy)
void	deleteGroup(Integer groupId)
Group	getGroup(Integer groupId) Gets a Group for the specified group ID
Permissions	getPermissions(Integer groupId) Gets a user's Permissions for the specified group ID
List<Group>	getSubgroups(Integer groupId) Gets a list of groups for a given group ID
Group	updateGroup(Group group) Update a group given a blank Group 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

GroupResource

public GroupResource(GroupsIOApiClient apiClient,
                     String baseUrl)

Method Detail

getPermissions

public Permissions getPermissions(Integer groupId)
                           throws URISyntaxException,
                                  IOException,
                                  GroupsIOApiException

Gets a user's Permissions for the specified group ID

Returns:

the user's Permissions for the specified group ID

Throws:

URISyntaxException

IOException

GroupsIOApiException

getGroup

public Group getGroup(Integer groupId)
               throws URISyntaxException,
                      IOException,
                      GroupsIOApiException

Gets a Group for the specified group ID

Returns:

the Group for the specified group ID

Throws:

URISyntaxException

IOException

GroupsIOApiException

getSubgroups

public List<Group> getSubgroups(Integer groupId)
                         throws URISyntaxException,
                                IOException,
                                GroupsIOApiException

Gets a list of groups for a given group ID

Parameters:

groupId - to fetch subgroups for

Returns:

List<Group> belonging to a parent group.

Throws:

URISyntaxException

IOException

GroupsIOApiException

createSubGroup

public void createSubGroup(Integer groupId,
                           String name,
                           String description,
                           String privacy)

updateGroup

public Group updateGroup(Group group)
                  throws URISyntaxException,
                         IOException,
                         GroupsIOApiException

Update a group given a blank Group object with only the updated fields set. Example:

 final Group groupToUpdate = new Group();
 groupToUpdate.setWebsite("https://github.com/nightowlengineer/groupsio-api-java");
 final Group updatedGroup = client.group().updateGroup(groupToUpdate);
 

Parameters:

group - - with only the updated fields set

Returns:

the full Group after a successful update

Throws:

URISyntaxException

IOException

GroupsIOApiException

deleteGroup

public void deleteGroup(Integer groupId)