com.box.sdkgen.managers.memberships

Class MembershipsManager

Object

MembershipsManager

public class MembershipsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MembershipsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	MembershipsManager()
protected	MembershipsManager(MembershipsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
GroupMembership	createGroupMembership(CreateGroupMembershipRequestBody requestBody) Creates a group membership.
GroupMembership	createGroupMembership(CreateGroupMembershipRequestBody requestBody, CreateGroupMembershipHeaders headers) Creates a group membership.
GroupMembership	createGroupMembership(CreateGroupMembershipRequestBody requestBody, CreateGroupMembershipQueryParams queryParams) Creates a group membership.
GroupMembership	createGroupMembership(CreateGroupMembershipRequestBody requestBody, CreateGroupMembershipQueryParams queryParams, CreateGroupMembershipHeaders headers) Creates a group membership.
void	deleteGroupMembershipById(String groupMembershipId) Deletes a specific group membership.
void	deleteGroupMembershipById(String groupMembershipId, DeleteGroupMembershipByIdHeaders headers) Deletes a specific group membership.
Authentication	getAuth()
GroupMembership	getGroupMembershipById(String groupMembershipId) Retrieves a specific group membership.
GroupMembership	getGroupMembershipById(String groupMembershipId, GetGroupMembershipByIdHeaders headers) Retrieves a specific group membership.
GroupMembership	getGroupMembershipById(String groupMembershipId, GetGroupMembershipByIdQueryParams queryParams) Retrieves a specific group membership.
GroupMembership	getGroupMembershipById(String groupMembershipId, GetGroupMembershipByIdQueryParams queryParams, GetGroupMembershipByIdHeaders headers) Retrieves a specific group membership.
GroupMemberships	getGroupMemberships(String groupId) Retrieves all the members for a group.
GroupMemberships	getGroupMemberships(String groupId, GetGroupMembershipsHeaders headers) Retrieves all the members for a group.
GroupMemberships	getGroupMemberships(String groupId, GetGroupMembershipsQueryParams queryParams) Retrieves all the members for a group.
GroupMemberships	getGroupMemberships(String groupId, GetGroupMembershipsQueryParams queryParams, GetGroupMembershipsHeaders headers) Retrieves all the members for a group.
NetworkSession	getNetworkSession()
GroupMemberships	getUserMemberships(String userId) Retrieves all the groups for a user.
GroupMemberships	getUserMemberships(String userId, GetUserMembershipsHeaders headers) Retrieves all the groups for a user.
GroupMemberships	getUserMemberships(String userId, GetUserMembershipsQueryParams queryParams) Retrieves all the groups for a user.
GroupMemberships	getUserMemberships(String userId, GetUserMembershipsQueryParams queryParams, GetUserMembershipsHeaders headers) Retrieves all the groups for a user.
GroupMembership	updateGroupMembershipById(String groupMembershipId) Updates a user's group membership.
GroupMembership	updateGroupMembershipById(String groupMembershipId, UpdateGroupMembershipByIdHeaders headers) Updates a user's group membership.
GroupMembership	updateGroupMembershipById(String groupMembershipId, UpdateGroupMembershipByIdQueryParams queryParams) Updates a user's group membership.
GroupMembership	updateGroupMembershipById(String groupMembershipId, UpdateGroupMembershipByIdQueryParams queryParams, UpdateGroupMembershipByIdHeaders headers) Updates a user's group membership.
GroupMembership	updateGroupMembershipById(String groupMembershipId, UpdateGroupMembershipByIdRequestBody requestBody) Updates a user's group membership.
GroupMembership	updateGroupMembershipById(String groupMembershipId, UpdateGroupMembershipByIdRequestBody requestBody, UpdateGroupMembershipByIdHeaders headers) Updates a user's group membership.
GroupMembership	updateGroupMembershipById(String groupMembershipId, UpdateGroupMembershipByIdRequestBody requestBody, UpdateGroupMembershipByIdQueryParams queryParams) Updates a user's group membership.
GroupMembership	updateGroupMembershipById(String groupMembershipId, UpdateGroupMembershipByIdRequestBody requestBody, UpdateGroupMembershipByIdQueryParams queryParams, UpdateGroupMembershipByIdHeaders headers) Updates a user's group membership.

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

MembershipsManager

public MembershipsManager()

MembershipsManager

protected MembershipsManager(MembershipsManager.Builder builder)

Method Detail

getUserMemberships

public GroupMemberships getUserMemberships(String userId)

Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

userId - The ID of the user. Example: "12345"

getUserMemberships

public GroupMemberships getUserMemberships(String userId,
                                           GetUserMembershipsQueryParams queryParams)

Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of getUserMemberships method

getUserMemberships

public GroupMemberships getUserMemberships(String userId,
                                           GetUserMembershipsHeaders headers)

Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

userId - The ID of the user. Example: "12345"

headers - Headers of getUserMemberships method

getUserMemberships

public GroupMemberships getUserMemberships(String userId,
                                           GetUserMembershipsQueryParams queryParams,
                                           GetUserMembershipsHeaders headers)

Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

userId - The ID of the user. Example: "12345"

queryParams - Query parameters of getUserMemberships method

headers - Headers of getUserMemberships method

getGroupMemberships

public GroupMemberships getGroupMemberships(String groupId)

Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

getGroupMemberships

public GroupMemberships getGroupMemberships(String groupId,
                                            GetGroupMembershipsQueryParams queryParams)

Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of getGroupMemberships method

getGroupMemberships

public GroupMemberships getGroupMemberships(String groupId,
                                            GetGroupMembershipsHeaders headers)

Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

headers - Headers of getGroupMemberships method

getGroupMemberships

public GroupMemberships getGroupMemberships(String groupId,
                                            GetGroupMembershipsQueryParams queryParams,
                                            GetGroupMembershipsHeaders headers)

Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupId - The ID of the group. Example: "57645"

queryParams - Query parameters of getGroupMemberships method

headers - Headers of getGroupMemberships method

createGroupMembership

public GroupMembership createGroupMembership(CreateGroupMembershipRequestBody requestBody)

Creates a group membership. Only users with admin-level permissions will be able to use this API.

Parameters:

requestBody - Request body of createGroupMembership method

createGroupMembership

public GroupMembership createGroupMembership(CreateGroupMembershipRequestBody requestBody,
                                             CreateGroupMembershipQueryParams queryParams)

Creates a group membership. Only users with admin-level permissions will be able to use this API.

Parameters:

requestBody - Request body of createGroupMembership method

queryParams - Query parameters of createGroupMembership method

createGroupMembership

public GroupMembership createGroupMembership(CreateGroupMembershipRequestBody requestBody,
                                             CreateGroupMembershipHeaders headers)

Creates a group membership. Only users with admin-level permissions will be able to use this API.

Parameters:

requestBody - Request body of createGroupMembership method

headers - Headers of createGroupMembership method

createGroupMembership

public GroupMembership createGroupMembership(CreateGroupMembershipRequestBody requestBody,
                                             CreateGroupMembershipQueryParams queryParams,
                                             CreateGroupMembershipHeaders headers)

Creates a group membership. Only users with admin-level permissions will be able to use this API.

Parameters:

requestBody - Request body of createGroupMembership method

queryParams - Query parameters of createGroupMembership method

headers - Headers of createGroupMembership method

getGroupMembershipById

public GroupMembership getGroupMembershipById(String groupMembershipId)

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

getGroupMembershipById

public GroupMembership getGroupMembershipById(String groupMembershipId,
                                              GetGroupMembershipByIdQueryParams queryParams)

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

queryParams - Query parameters of getGroupMembershipById method

getGroupMembershipById

public GroupMembership getGroupMembershipById(String groupMembershipId,
                                              GetGroupMembershipByIdHeaders headers)

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

headers - Headers of getGroupMembershipById method

getGroupMembershipById

public GroupMembership getGroupMembershipById(String groupMembershipId,
                                              GetGroupMembershipByIdQueryParams queryParams,
                                              GetGroupMembershipByIdHeaders headers)

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

queryParams - Query parameters of getGroupMembershipById method

headers - Headers of getGroupMembershipById method

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId,
                                                 UpdateGroupMembershipByIdRequestBody requestBody)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

requestBody - Request body of updateGroupMembershipById method

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId,
                                                 UpdateGroupMembershipByIdQueryParams queryParams)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

queryParams - Query parameters of updateGroupMembershipById method

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId,
                                                 UpdateGroupMembershipByIdRequestBody requestBody,
                                                 UpdateGroupMembershipByIdQueryParams queryParams)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

requestBody - Request body of updateGroupMembershipById method

queryParams - Query parameters of updateGroupMembershipById method

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId,
                                                 UpdateGroupMembershipByIdHeaders headers)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

headers - Headers of updateGroupMembershipById method

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId,
                                                 UpdateGroupMembershipByIdRequestBody requestBody,
                                                 UpdateGroupMembershipByIdHeaders headers)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

requestBody - Request body of updateGroupMembershipById method

headers - Headers of updateGroupMembershipById method

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId,
                                                 UpdateGroupMembershipByIdQueryParams queryParams,
                                                 UpdateGroupMembershipByIdHeaders headers)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

queryParams - Query parameters of updateGroupMembershipById method

headers - Headers of updateGroupMembershipById method

updateGroupMembershipById

public GroupMembership updateGroupMembershipById(String groupMembershipId,
                                                 UpdateGroupMembershipByIdRequestBody requestBody,
                                                 UpdateGroupMembershipByIdQueryParams queryParams,
                                                 UpdateGroupMembershipByIdHeaders headers)

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

requestBody - Request body of updateGroupMembershipById method

queryParams - Query parameters of updateGroupMembershipById method

headers - Headers of updateGroupMembershipById method

deleteGroupMembershipById

public void deleteGroupMembershipById(String groupMembershipId)

Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

deleteGroupMembershipById

public void deleteGroupMembershipById(String groupMembershipId,
                                      DeleteGroupMembershipByIdHeaders headers)

Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Parameters:

groupMembershipId - The ID of the group membership. Example: "434534"

headers - Headers of deleteGroupMembershipById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()