com.box.sdk

Class BoxGroupMembership.Info

Object

BoxJSONObject

BoxResource.Info

BoxGroupMembership.Info

Enclosing class:

BoxGroupMembership

public class BoxGroupMembership.Info
extends BoxResource.Info

Contains information about a BoxGroupMembership.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
void	appendConfigurablePermissions(BoxGroupMembership.Permission permission, Boolean value) append new configurable permissions to the previous existing list.
Map<BoxGroupMembership.Permission,Boolean>	getConfigurablePermissions() Gets the configurablePermissions that the current user has on the group as group admin.
Date	getCreatedAt() Gets the time the group membership was created.
BoxGroup.Info	getGroup() Gets the group the user belongs to.
BoxGroupMembership.GroupRole	getGroupRole() Gets the level of access the user has.
Date	getModifiedAt() Gets the time the group membership was last modified.
BoxGroupMembership	getResource() Gets the resource associated with this Info.
BoxUser.Info	getUser() Gets the user belonging to the group.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	setConfigurablePermissions(Map<BoxGroupMembership.Permission,Boolean> configurablePermissions) Sets the configurablePermissions that the current user has on the group as group admin.
void	setGroupRole(BoxGroupMembership.GroupRole role) Sets the level of access the user has.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getUser

public BoxUser.Info getUser()

Gets the user belonging to the group.

Note: the BoxUser.Info returned by this method will only have the ID, name, and login fields populated.

Returns:

the user belonging to the group.

getGroup

public BoxGroup.Info getGroup()

Gets the group the user belongs to.

Note: the BoxGroup.Info returned by this method will only have the ID and name fields populated.

Returns:

the group the user belongs to.

getGroupRole

public BoxGroupMembership.GroupRole getGroupRole()

Gets the level of access the user has.

Returns:

the level of access the user has.

setGroupRole

public void setGroupRole(BoxGroupMembership.GroupRole role)

Sets the level of access the user has.

Parameters:

role - the new level of access to give the user.

getCreatedAt

public Date getCreatedAt()

Gets the time the group membership was created.

Returns:

the time the group membership was created.

getModifiedAt

public Date getModifiedAt()

Gets the time the group membership was last modified.

Returns:

the time the group membership was last modified.

getConfigurablePermissions

public Map<BoxGroupMembership.Permission,Boolean> getConfigurablePermissions()

Gets the configurablePermissions that the current user has on the group as group admin.

Returns:

the configurablePermissions that the current user has on the group as group admin.

setConfigurablePermissions

public void setConfigurablePermissions(Map<BoxGroupMembership.Permission,Boolean> configurablePermissions)

Sets the configurablePermissions that the current user has on the group as group admin.

Parameters:

configurablePermissions - a Map representing the group admin configurable permissions

appendConfigurablePermissions

public void appendConfigurablePermissions(BoxGroupMembership.Permission permission,
                                          Boolean value)

append new configurable permissions to the previous existing list.

Parameters:

permission - the group admin permission one wants to enable or disable of the user on the group.

value - the true/false value of the attribute to set.

getResource

public BoxGroupMembership getResource()

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.