Package com.dropbox.core.v2.sharing

Class GroupInfo

java.lang.Object

com.dropbox.core.v2.teamcommon.GroupSummary

com.dropbox.core.v2.sharing.GroupInfo

public class GroupInfo
extends GroupSummary

The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroupInfo.Builder	Builder for GroupInfo.

Field Summary

Fields

Modifier and Type	Field	Description
protected GroupType	groupType
protected boolean	isMember
protected boolean	isOwner
protected boolean	sameTeam

Fields inherited from class com.dropbox.core.v2.teamcommon.GroupSummary

groupExternalId, groupId, groupManagementType, groupName, memberCount

Constructor Summary

Constructors

Constructor	Description
GroupInfo(java.lang.String groupName, java.lang.String groupId, GroupManagementType groupManagementType, GroupType groupType, boolean isMember, boolean isOwner, boolean sameTeam)	The information about a group.
GroupInfo(java.lang.String groupName, java.lang.String groupId, GroupManagementType groupManagementType, GroupType groupType, boolean isMember, boolean isOwner, boolean sameTeam, java.lang.String groupExternalId, java.lang.Long memberCount)	The information about a group.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getGroupExternalId()	External ID of group.
java.lang.String	getGroupId()
GroupManagementType	getGroupManagementType()	Who is allowed to manage the group.
java.lang.String	getGroupName()
GroupType	getGroupType()	The type of group.
boolean	getIsMember()	If the current user is a member of the group.
boolean	getIsOwner()	If the current user is an owner of the group.
java.lang.Long	getMemberCount()	The number of members in the group.
boolean	getSameTeam()	If the group is owned by the current user's team.
int	hashCode()
static GroupInfo.Builder	newBuilder(java.lang.String groupName, java.lang.String groupId, GroupManagementType groupManagementType, GroupType groupType, boolean isMember, boolean isOwner, boolean sameTeam)	Returns a new builder for creating an instance of this class.
java.lang.String	toString()
java.lang.String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class com.dropbox.core.v2.teamcommon.GroupSummary

newBuilder

Methods inherited from class java.lang.Object

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

Field Detail

groupType

protected final GroupType groupType

isMember

protected final boolean isMember

isOwner

protected final boolean isOwner

sameTeam

protected final boolean sameTeam

Constructor Detail

GroupInfo

public GroupInfo(java.lang.String groupName,
                 java.lang.String groupId,
                 GroupManagementType groupManagementType,
                 GroupType groupType,
                 boolean isMember,
                 boolean isOwner,
                 boolean sameTeam,
                 java.lang.String groupExternalId,
                 java.lang.Long memberCount)

The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.

Use newBuilder(java.lang.String,java.lang.String,com.dropbox.core.v2.teamcommon.GroupManagementType,com.dropbox.core.v2.teamcommon.GroupType,boolean,boolean,boolean) to create instances of this class without specifying values for all optional fields.

Parameters:

groupName - Must not be null.

groupId - Must not be null.

groupManagementType - Who is allowed to manage the group. Must not be null.

groupType - The type of group. Must not be null.

isMember - If the current user is a member of the group.

isOwner - If the current user is an owner of the group.

sameTeam - If the group is owned by the current user's team.

groupExternalId - External ID of group. This is an arbitrary ID that an admin can attach to a group.

memberCount - The number of members in the group.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

GroupInfo

public GroupInfo(java.lang.String groupName,
                 java.lang.String groupId,
                 GroupManagementType groupManagementType,
                 GroupType groupType,
                 boolean isMember,
                 boolean isOwner,
                 boolean sameTeam)

The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.

The default values for unset fields will be used.

Parameters:

groupName - Must not be null.

groupId - Must not be null.

groupManagementType - Who is allowed to manage the group. Must not be null.

groupType - The type of group. Must not be null.

isMember - If the current user is a member of the group.

isOwner - If the current user is an owner of the group.

sameTeam - If the group is owned by the current user's team.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getGroupName

public java.lang.String getGroupName()

Overrides:

getGroupName in class GroupSummary

Returns:

value for this field, never null.

getGroupId

public java.lang.String getGroupId()

Overrides:

getGroupId in class GroupSummary

Returns:

value for this field, never null.

getGroupManagementType

public GroupManagementType getGroupManagementType()

Who is allowed to manage the group.

Overrides:

getGroupManagementType in class GroupSummary

Returns:

value for this field, never null.

getGroupType

public GroupType getGroupType()

The type of group.

Returns:

value for this field, never null.

getIsMember

public boolean getIsMember()

If the current user is a member of the group.

Returns:

value for this field.

getIsOwner

public boolean getIsOwner()

If the current user is an owner of the group.

Returns:

value for this field.

getSameTeam

public boolean getSameTeam()

If the group is owned by the current user's team.

Returns:

value for this field.

getGroupExternalId

public java.lang.String getGroupExternalId()

External ID of group. This is an arbitrary ID that an admin can attach to a group.

Overrides:

getGroupExternalId in class GroupSummary

Returns:

value for this field, or null if not present.

getMemberCount

public java.lang.Long getMemberCount()

The number of members in the group.

Overrides:

getMemberCount in class GroupSummary

Returns:

value for this field, or null if not present.

newBuilder

public static GroupInfo.Builder newBuilder(java.lang.String groupName,
                                           java.lang.String groupId,
                                           GroupManagementType groupManagementType,
                                           GroupType groupType,
                                           boolean isMember,
                                           boolean isOwner,
                                           boolean sameTeam)

Returns a new builder for creating an instance of this class.

Parameters:

groupName - Must not be null.

groupId - Must not be null.

groupManagementType - Who is allowed to manage the group. Must not be null.

groupType - The type of group. Must not be null.

isMember - If the current user is a member of the group.

isOwner - If the current user is an owner of the group.

sameTeam - If the group is owned by the current user's team.

Returns:

builder for this class.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class GroupSummary

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class GroupSummary

toString

public java.lang.String toString()

Overrides:

toString in class GroupSummary

toStringMultiline

public java.lang.String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Overrides:

toStringMultiline in class GroupSummary

Returns:

Formatted, multiline String representation of this object