com.box.sdkgen.schemas.groupfull

Class GroupFull

Object

NullableFieldTracker

SerializableObject

GroupBase

GroupMini

Group

GroupFull

All Implemented Interfaces:

Serializable

public class GroupFull
extends Group

Groups contain a set of users, and can be used in place of users in some operations, such as collaborations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupFull.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description Human readable description of the group.
protected String	externalSyncIdentifier An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.
protected EnumWrapper<GroupFullInvitabilityLevelField>	invitabilityLevel Specifies who can invite the group to collaborate on items.
protected EnumWrapper<GroupFullMemberViewabilityLevelField>	memberViewabilityLevel Specifies who can view the members of the group (Get Memberships for Group).
protected GroupFullPermissionsField	permissions
protected String	provenance Keeps track of which external source this group is coming from (e.g.

Fields inherited from class Group

createdAt, modifiedAt

Fields inherited from class GroupMini

groupType, name

Fields inherited from class GroupBase

id, type

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroupFull(GroupFull.Builder builder)
	GroupFull(String id)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription()
String	getExternalSyncIdentifier()
EnumWrapper<GroupFullInvitabilityLevelField>	getInvitabilityLevel()
EnumWrapper<GroupFullMemberViewabilityLevelField>	getMemberViewabilityLevel()
GroupFullPermissionsField	getPermissions()
String	getProvenance()
int	hashCode()
String	toString()

Methods inherited from class Group

getCreatedAt, getModifiedAt

Methods inherited from class GroupMini

getGroupType, getName

Methods inherited from class GroupBase

getId, getType

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

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

Field Detail

provenance

protected String provenance

Keeps track of which external source this group is coming from (e.g. "Active Directory", "Google Groups", "Facebook Groups"). Setting this will also prevent Box users from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.

externalSyncIdentifier

protected String externalSyncIdentifier

An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.

description

protected String description

Human readable description of the group.

invitabilityLevel

protected EnumWrapper<GroupFullInvitabilityLevelField> invitabilityLevel

Specifies who can invite the group to collaborate on items.

When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group.

When set to `admins_and_members` all the admins listed above and group members can invite the group.

When set to `all_managed_users` all managed users in the enterprise can invite the group.

memberViewabilityLevel

protected EnumWrapper<GroupFullMemberViewabilityLevelField> memberViewabilityLevel

Specifies who can view the members of the group (Get Memberships for Group).

* `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise.

permissions

protected GroupFullPermissionsField permissions

Constructor Detail

GroupFull

public GroupFull(String id)

GroupFull

protected GroupFull(GroupFull.Builder builder)

Method Detail

getProvenance

public String getProvenance()

getExternalSyncIdentifier

public String getExternalSyncIdentifier()

getDescription

public String getDescription()

getInvitabilityLevel

public EnumWrapper<GroupFullInvitabilityLevelField> getInvitabilityLevel()

getMemberViewabilityLevel

public EnumWrapper<GroupFullMemberViewabilityLevelField> getMemberViewabilityLevel()

getPermissions

public GroupFullPermissionsField getPermissions()

equals

public boolean equals(Object o)

Overrides:

equals in class Group

hashCode

public int hashCode()

Overrides:

hashCode in class Group

toString

public String toString()

Overrides:

toString in class Group