Package com.dropbox.core.v2.team

Class TeamMemberProfile

java.lang.Object
com.dropbox.core.v2.team.MemberProfile
com.dropbox.core.v2.team.TeamMemberProfile
public class TeamMemberProfile extends MemberProfile
Profile of a user as a member of a team.

  • Field Details

    • groups

      @Nonnull protected final List<String> groups

    • memberFolderId

      @Nonnull protected final String memberFolderId

    • rootFolderId

      @Nonnull protected final String rootFolderId

  • Constructor Details

    • TeamMemberProfile

      public TeamMemberProfile(@Nonnull String teamMemberId, @Nonnull String email, boolean emailVerified, @Nonnull TeamMemberStatus status, @Nonnull Name name, @Nonnull TeamMembershipType membershipType, @Nonnull List<String> groups, @Nonnull String memberFolderId, @Nonnull String rootFolderId, @Nullable String externalId, @Nullable String accountId, @Nullable List<SecondaryEmail> secondaryEmails, @Nullable Date invitedOn, @Nullable Date joinedOn, @Nullable Date suspendedOn, @Nullable String persistentId, @Nullable Boolean isDirectoryRestricted, @Nullable String profilePhotoUrl)
      Profile of a user as a member of a team.

      Use newBuilder(java.lang.String,java.lang.String,boolean,com.dropbox.core.v2.team.TeamMemberStatus,com.dropbox.core.v2.users.Name,com.dropbox.core.v2.team.TeamMembershipType,java.util.List<java.lang.String>,java.lang.String,java.lang.String) to create instances of this class without specifying values for all optional fields.

      Parameters:
      teamMemberId - ID of user as a member of a team. Must not be null.
      email - Email address of user. Must not be null.
      emailVerified - Is true if the user's email is verified to be owned by the user.
      status - The user's status as a member of a specific team. Must not be null.
      name - Representations for a person's name. Must not be null.
      membershipType - The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota). Must not be null.
      groups - List of group IDs of groups that the user belongs to. Must not contain a null item and not be null.
      memberFolderId - The namespace id of the user's member folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      rootFolderId - The namespace id of the user's root folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      externalId - External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id.
      accountId - A user's account identifier. Must have length of at least 40 and have length of at most 40.
      secondaryEmails - Secondary emails of a user. Must not contain a null item.
      invitedOn - The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.INVITED).
      joinedOn - The date and time the user joined as a member of a specific team.
      suspendedOn - The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.SUSPENDED).
      persistentId - Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
      isDirectoryRestricted - Whether the user is a directory restricted user.
      profilePhotoUrl - URL for the photo representing the user, if one is set.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • TeamMemberProfile

      public TeamMemberProfile(@Nonnull String teamMemberId, @Nonnull String email, boolean emailVerified, @Nonnull TeamMemberStatus status, @Nonnull Name name, @Nonnull TeamMembershipType membershipType, @Nonnull List<String> groups, @Nonnull String memberFolderId, @Nonnull String rootFolderId)
      Profile of a user as a member of a team.

      The default values for unset fields will be used.

      Parameters:
      teamMemberId - ID of user as a member of a team. Must not be null.
      email - Email address of user. Must not be null.
      emailVerified - Is true if the user's email is verified to be owned by the user.
      status - The user's status as a member of a specific team. Must not be null.
      name - Representations for a person's name. Must not be null.
      membershipType - The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota). Must not be null.
      groups - List of group IDs of groups that the user belongs to. Must not contain a null item and not be null.
      memberFolderId - The namespace id of the user's member folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      rootFolderId - The namespace id of the user's root folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

  • Method Details

    • getTeamMemberId

      @Nonnull public String getTeamMemberId()
      ID of user as a member of a team.
      Overrides:
      getTeamMemberId in class MemberProfile
      Returns:
      value for this field, never null.

    • getEmail

      @Nonnull public String getEmail()
      Email address of user.
      Overrides:
      getEmail in class MemberProfile
      Returns:
      value for this field, never null.

    • getEmailVerified

      public boolean getEmailVerified()
      Is true if the user's email is verified to be owned by the user.
      Overrides:
      getEmailVerified in class MemberProfile
      Returns:
      value for this field.

    • getStatus

      @Nonnull public TeamMemberStatus getStatus()
      The user's status as a member of a specific team.
      Overrides:
      getStatus in class MemberProfile
      Returns:
      value for this field, never null.

    • getName

      @Nonnull public Name getName()
      Representations for a person's name.
      Overrides:
      getName in class MemberProfile
      Returns:
      value for this field, never null.

    • getMembershipType

      @Nonnull public TeamMembershipType getMembershipType()
      The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
      Overrides:
      getMembershipType in class MemberProfile
      Returns:
      value for this field, never null.

    • getGroups

      @Nonnull public List<String> getGroups()
      List of group IDs of groups that the user belongs to.
      Returns:
      value for this field, never null.

    • getMemberFolderId

      @Nonnull public String getMemberFolderId()
      The namespace id of the user's member folder.
      Returns:
      value for this field, never null.

    • getRootFolderId

      @Nonnull public String getRootFolderId()
      The namespace id of the user's root folder.
      Returns:
      value for this field, never null.

    • getExternalId

      @Nullable public String getExternalId()
      External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id.
      Overrides:
      getExternalId in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getAccountId

      @Nullable public String getAccountId()
      A user's account identifier.
      Overrides:
      getAccountId in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getSecondaryEmails

      @Nullable public List<SecondaryEmail> getSecondaryEmails()
      Secondary emails of a user.
      Overrides:
      getSecondaryEmails in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getInvitedOn

      @Nullable public Date getInvitedOn()
      The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.INVITED).
      Overrides:
      getInvitedOn in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getJoinedOn

      @Nullable public Date getJoinedOn()
      The date and time the user joined as a member of a specific team.
      Overrides:
      getJoinedOn in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getSuspendedOn

      @Nullable public Date getSuspendedOn()
      The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.SUSPENDED).
      Overrides:
      getSuspendedOn in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getPersistentId

      @Nullable public String getPersistentId()
      Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
      Overrides:
      getPersistentId in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getIsDirectoryRestricted

      @Nullable public Boolean getIsDirectoryRestricted()
      Whether the user is a directory restricted user.
      Overrides:
      getIsDirectoryRestricted in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • getProfilePhotoUrl

      @Nullable public String getProfilePhotoUrl()
      URL for the photo representing the user, if one is set.
      Overrides:
      getProfilePhotoUrl in class MemberProfile
      Returns:
      value for this field, or null if not present.

    • newBuilder

      public static TeamMemberProfile.Builder newBuilder(String teamMemberId, String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType, List<String> groups, String memberFolderId, String rootFolderId)
      Returns a new builder for creating an instance of this class.
      Parameters:
      teamMemberId - ID of user as a member of a team. Must not be null.
      email - Email address of user. Must not be null.
      emailVerified - Is true if the user's email is verified to be owned by the user.
      status - The user's status as a member of a specific team. Must not be null.
      name - Representations for a person's name. Must not be null.
      membershipType - The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota). Must not be null.
      groups - List of group IDs of groups that the user belongs to. Must not contain a null item and not be null.
      memberFolderId - The namespace id of the user's member folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      rootFolderId - The namespace id of the user's root folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
      Returns:
      builder for this class.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class MemberProfile

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class MemberProfile

    • toString

      public String toString()
      Overrides:
      toString in class MemberProfile

    • 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 MemberProfile
      Returns:
      Formatted, multiline String representation of this object