org.nuxeo.client.methods

Interface UserManagerAPI

public interface UserManagerAPI

Since:

0.1

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<User>	addUserToGroup(String userName, String groupName)
retrofit2.Call<User>	attachGroupToUser(String groupName, String userName)
retrofit2.Call<Group>	createGroup(Group group)
retrofit2.Call<User>	createUser(User user)
retrofit2.Call<okhttp3.ResponseBody>	deleteGroup(String groupName)
retrofit2.Call<okhttp3.ResponseBody>	deleteUser(String userName)
retrofit2.Call<User>	fetchCurrentUser()
retrofit2.Call<Group>	fetchGroup(String groupName)
retrofit2.Call<Groups>	fetchGroupMemberGroups(String groupName)
retrofit2.Call<Users>	fetchGroupMemberUsers(String groupName)
retrofit2.Call<User>	fetchUser(String userName)
retrofit2.Call<Workflows>	fetchWorkflowInstances()
retrofit2.Call<Groups>	searchGroup(String query)
retrofit2.Call<Groups>	searchGroup(String query, int currentPageIndex, int pageSize)
retrofit2.Call<Users>	searchUser(String query)
retrofit2.Call<Users>	searchUser(String query, int currentPageIndex, int pageSize)
retrofit2.Call<Workflow>	startWorkflowInstance(Workflow workflow)
retrofit2.Call<Group>	updateGroup(String groupName, Group group)
retrofit2.Call<User>	updateUser(String userName, User user)

Method Detail

fetchGroup

@GET(value="group/{groupName}")
retrofit2.Call<Group> fetchGroup(@Path(value="groupName")
                                                                 String groupName)

updateGroup

@PUT(value="group/{groupName}")
retrofit2.Call<Group> updateGroup(@Path(value="groupName")
                                                                  String groupName,
                                                                  @Body
                                                                  Group group)

deleteGroup

@DELETE(value="group/{groupName}")
retrofit2.Call<okhttp3.ResponseBody> deleteGroup(@Path(value="groupName")
                                                                                    String groupName)

createGroup

@POST(value="group")
retrofit2.Call<Group> createGroup(@Body
                                                       Group group)

searchGroup

@GET(value="group/search")
retrofit2.Call<Groups> searchGroup(@Query(value="q")
                                                              String query)

searchGroup

@GET(value="group/search")
retrofit2.Call<Groups> searchGroup(@Query(value="q")
                                                              String query,
                                                              @Query(value="currentPageIndex")
                                                              int currentPageIndex,
                                                              @Query(value="pageSize")
                                                              int pageSize)

attachGroupToUser

@POST(value="group/{groupName}/user/{userName}")
retrofit2.Call<User> attachGroupToUser(@Path(value="groupName")
                                                                                        String groupName,
                                                                                        @Path(value="userName")
                                                                                        String userName)

fetchGroupMemberUsers

@GET(value="group/{groupName}/@users")
retrofit2.Call<Users> fetchGroupMemberUsers(@Path(value="groupName")
                                                                                   String groupName)

Since:

3.0

fetchGroupMemberGroups

@GET(value="group/{groupName}/@groups")
retrofit2.Call<Groups> fetchGroupMemberGroups(@Path(value="groupName")
                                                                                      String groupName)

Since:

3.0

fetchUser

@GET(value="user/{userName}")
retrofit2.Call<User> fetchUser(@Path(value="userName")
                                                             String userName)

updateUser

@PUT(value="user/{userName}")
retrofit2.Call<User> updateUser(@Path(value="userName")
                                                              String userName,
                                                              @Body
                                                              User user)

deleteUser

@DELETE(value="user/{userName}")
retrofit2.Call<okhttp3.ResponseBody> deleteUser(@Path(value="userName")
                                                                                 String userName)

createUser

@POST(value="user")
retrofit2.Call<User> createUser(@Body
                                                    User user)

searchUser

@GET(value="user/search")
retrofit2.Call<Users> searchUser(@Query(value="q")
                                                           String query)

searchUser

@GET(value="user/search")
retrofit2.Call<Users> searchUser(@Query(value="q")
                                                           String query,
                                                           @Query(value="currentPageIndex")
                                                           int currentPageIndex,
                                                           @Query(value="pageSize")
                                                           int pageSize)

addUserToGroup

@POST(value="user/{userName}/group/{groupName}")
retrofit2.Call<User> addUserToGroup(@Path(value="userName")
                                                                                     String userName,
                                                                                     @Path(value="groupName")
                                                                                     String groupName)

fetchCurrentUser

@POST(value="automation/login")
retrofit2.Call<User> fetchCurrentUser()

fetchWorkflowInstances

@GET(value="workflow")
retrofit2.Call<Workflows> fetchWorkflowInstances()

startWorkflowInstance

@POST(value="workflow")
retrofit2.Call<Workflow> startWorkflowInstance(@Body
                                                                       Workflow workflow)