com.box.sdk

Class BoxGroup

Object

BoxResource

BoxCollaborator

BoxGroup

public class BoxGroup
extends BoxCollaborator

Represents a set of Box users.

Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxGroup.Info Contains information about a BoxGroup.

Constructor Summary

Constructors

Constructor and Description
BoxGroup(BoxAPIConnection api, String id) Constructs a BoxGroup for a group with a given ID.

Method Summary

Modifier and Type	Method and Description
BoxGroupMembership.Info	addMembership(BoxUser user) Adds a member to this group with the default role.
BoxGroupMembership.Info	addMembership(BoxUser user, BoxGroupMembership.Role role) Adds a member to this group with the specified role.
static BoxGroup.Info	createGroup(BoxAPIConnection api, String name) Creates a new group with a specified name.
void	delete() Deletes this group.
static Iterable<BoxGroup.Info>	getAllGroups(BoxAPIConnection api) Gets an iterable of all the groups that the current user is a member of.
BoxGroup.Info	getInfo() Gets information about this group.
Collection<BoxGroupMembership.Info>	getMemberships() Gets information about all of the group memberships for this group.

Methods inherited from class BoxResource

equals, getAPI, getID, hashCode

Methods inherited from class Object

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

Constructor Detail

BoxGroup

public BoxGroup(BoxAPIConnection api,
                String id)

Constructs a BoxGroup for a group with a given ID.

Parameters:

api - the API connection to be used by the group.

id - the ID of the group.

Method Detail

createGroup

public static BoxGroup.Info createGroup(BoxAPIConnection api,
                                        String name)

Creates a new group with a specified name.

Parameters:

api - the API connection to be used by the group.

name - the name of the new group.

Returns:

info about the created group.

getAllGroups

public static Iterable<BoxGroup.Info> getAllGroups(BoxAPIConnection api)

Gets an iterable of all the groups that the current user is a member of.

Parameters:

api - the API connection to be used when retrieving the groups.

Returns:

an iterable containing info about all the groups.

getInfo

public BoxGroup.Info getInfo()

Gets information about this group.

Returns:

info about this group.

getMemberships

public Collection<BoxGroupMembership.Info> getMemberships()

Gets information about all of the group memberships for this group.

Returns:

a collection of information about the group memberships for this group.

addMembership

public BoxGroupMembership.Info addMembership(BoxUser user)

Adds a member to this group with the default role.

Parameters:

user - the member to be added to this group.

Returns:

info about the new group membership.

addMembership

public BoxGroupMembership.Info addMembership(BoxUser user,
                                             BoxGroupMembership.Role role)

Adds a member to this group with the specified role.

Parameters:

user - the member to be added to this group.

role - the role of the user in this group. Can be null to assign the default role.

Returns:

info about the new group membership.

delete

public void delete()

Deletes this group.