@BoxResourceType(value="group_membership") public class BoxGroupMembership extends BoxResource
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.
Modifier and Type | Class and Description |
---|---|
static class |
BoxGroupMembership.GroupRole
Enumerates the possible roles that a user can have within a group.
|
class |
BoxGroupMembership.Info
Contains information about a BoxGroupMembership.
|
static class |
BoxGroupMembership.Permission
Enumerates the possible permissions that a user can have as a group admin.
|
Modifier and Type | Field and Description |
---|---|
static URLTemplate |
MEMBERSHIP_URL_TEMPLATE
The URL template for all group membership requests.
|
Constructor and Description |
---|
BoxGroupMembership(BoxAPIConnection api,
String id)
Constructs a BoxGroupMembership for a group membership with a given ID.
|
Modifier and Type | Method and Description |
---|---|
void |
delete()
Deletes this group membership.
|
BoxGroupMembership.Info |
getInfo()
Gets information about this group membership.
|
void |
updateInfo(BoxGroupMembership.Info info)
Updates the information about this group membership with any info fields that have been modified locally.
|
equals, getAPI, getID, getResourceType, hashCode
public static final URLTemplate MEMBERSHIP_URL_TEMPLATE
getInfo()
public BoxGroupMembership(BoxAPIConnection api, String id)
api
- the API connection to be used by the group membership.id
- the ID of the group membership.public BoxGroupMembership.Info getInfo()
public void updateInfo(BoxGroupMembership.Info info)
info
- the updated info.public void delete()