com.box.sdk

Class BoxGroup

Object

BoxResource

BoxCollaborator

BoxGroup

public class BoxGroup
extends BoxCollaborator

Represents a set of Box users.

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

Methods

Modifier and Type	Method and Description
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.

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.

delete

public void delete()

Deletes this group.