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.
  • Field Details

    • groupType

      @Nonnull protected final GroupType groupType
    • isMember

      protected final boolean isMember
    • isOwner

      protected final boolean isOwner
    • sameTeam

      protected final boolean sameTeam
  • Constructor Details

    • GroupInfo

      public GroupInfo(@Nonnull String groupName, @Nonnull String groupId, @Nonnull GroupManagementType groupManagementType, @Nonnull GroupType groupType, boolean isMember, boolean isOwner, boolean sameTeam, @Nullable String groupExternalId, @Nullable 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 - Field is deprecated. 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:
      IllegalArgumentException - If any argument does not meet its preconditions.
    • GroupInfo

      public GroupInfo(@Nonnull String groupName, @Nonnull String groupId, @Nonnull GroupManagementType groupManagementType, @Nonnull 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 - Field is deprecated. 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:
      IllegalArgumentException - If any argument does not meet its preconditions.
  • Method Details

    • getGroupName

      @Nonnull public String getGroupName()
      Overrides:
      getGroupName in class GroupSummary
      Returns:
      value for this field, never null.
    • getGroupId

      @Nonnull public String getGroupId()
      Overrides:
      getGroupId in class GroupSummary
      Returns:
      value for this field, never null.
    • getGroupManagementType

      @Nonnull public GroupManagementType getGroupManagementType()
      Who is allowed to manage the group.
      Overrides:
      getGroupManagementType in class GroupSummary
      Returns:
      value for this field, never null.
    • getGroupType

      @Deprecated @Nonnull public GroupType getGroupType()
      Deprecated.
      Field is deprecated. 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

      @Nullable public 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

      @Nullable public 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(String groupName, 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 - Field is deprecated. 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:
      IllegalArgumentException - If any argument does not meet its preconditions.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class GroupSummary
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class GroupSummary
    • toString

      public String toString()
      Overrides:
      toString in class GroupSummary
    • toStringMultiline

      public 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