org.gitlab4j.api

Class GroupApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.GroupApi

public class GroupApi
extends AbstractApi

This class implements the client side API for the GitLab groups calls.

Method Summary

Modifier and Type	Method and Description
void	addGroup(String name, String path) Creates a new project group.
Member	addMember(Integer groupId, Integer userId, Integer accessLevel) Adds a user to the list of group members.
void	deleteGroup(Group group) Removes group with all projects inside.
void	deleteGroup(Integer groupId) Removes group with all projects inside.
Group	getGroup(int groupId) Get all details of a group.
List<Group>	getGroups() Get a list of groups.
List<Member>	getMembers(int groupId) Get a list of group members viewable by the authenticated user.
void	removeMember(Integer projectId, Integer userId) Removes member from the group team.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, handle, post, post, post, put, put, validate

Methods inherited from class java.lang.Object

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

Method Detail

getGroups

public List<Group> getGroups()
                      throws GitLabApiException

Get a list of groups. (As user: my groups, as admin: all groups) GET /groups

Returns:

the list of groups viewable by the authenticated user

Throws:

GitLabApiException

getGroup

public Group getGroup(int groupId)
               throws GitLabApiException

Get all details of a group. GET /groups/:id

Parameters:

groupId -

Returns:

the Group instance for the specified group ID

Throws:

GitLabApiException

addGroup

public void addGroup(String name,
                     String path)
              throws GitLabApiException

Creates a new project group. Available only for admin. POST /groups

Parameters:

name -

path -

Throws:

GitLabApiException

deleteGroup

public void deleteGroup(Integer groupId)
                 throws GitLabApiException

Removes group with all projects inside. DELETE /groups/:id

Parameters:

groupId -

Throws:

GitLabApiException

deleteGroup

public void deleteGroup(Group group)
                 throws GitLabApiException

Removes group with all projects inside. DELETE /groups/:id

Parameters:

group -

Throws:

GitLabApiException

getMembers

public List<Member> getMembers(int groupId)
                        throws GitLabApiException

Get a list of group members viewable by the authenticated user. GET /groups/:id/members

Returns:

a list of group members viewable by the authenticated user

Throws:

GitLabApiException

addMember

public Member addMember(Integer groupId,
                        Integer userId,
                        Integer accessLevel)
                 throws GitLabApiException

Adds a user to the list of group members. POST /groups/:id/members

Parameters:

groupId -

userId -

accessLevel -

Returns:

a Member instance for the added user

Throws:

GitLabApiException

removeMember

public void removeMember(Integer projectId,
                         Integer userId)
                  throws GitLabApiException

Removes member from the group team. DELETE /groups/:id/members/:user_id

Parameters:

projectId -

userId -

Throws:

GitLabApiException