Package com.dropbox.core.v2.team

Class MemberProfile

java.lang.Object
com.dropbox.core.v2.team.MemberProfile
Direct Known Subclasses:
TeamMemberProfile
public class MemberProfile extends Object
Basic member profile.

  • Field Details

    • teamMemberId

      @Nonnull protected final String teamMemberId

    • externalId

      @Nullable protected final String externalId

    • accountId

      @Nullable protected final String accountId

    • email

      @Nonnull protected final String email

    • emailVerified

      protected final boolean emailVerified

    • secondaryEmails

      @Nullable protected final List<SecondaryEmail> secondaryEmails

    • status

      @Nonnull protected final TeamMemberStatus status

    • name

      @Nonnull protected final Name name

    • membershipType

      @Nonnull protected final TeamMembershipType membershipType

    • invitedOn

      @Nullable protected final Date invitedOn

    • joinedOn

      @Nullable protected final Date joinedOn

    • suspendedOn

      @Nullable protected final Date suspendedOn

    • persistentId

      @Nullable protected final String persistentId

    • isDirectoryRestricted

      @Nullable protected final Boolean isDirectoryRestricted

    • profilePhotoUrl

      @Nullable protected final String profilePhotoUrl

  • Constructor Details

    • MemberProfile

      public MemberProfile(@Nonnull String teamMemberId, @Nonnull String email, boolean emailVerified, @Nonnull TeamMemberStatus status, @Nonnull Name name, @Nonnull TeamMembershipType membershipType, @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)
      Basic member profile.

      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) 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.
      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.

    • MemberProfile

      public MemberProfile(@Nonnull String teamMemberId, @Nonnull String email, boolean emailVerified, @Nonnull TeamMemberStatus status, @Nonnull Name name, @Nonnull TeamMembershipType membershipType)
      Basic member profile.

      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.
      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.
      Returns:
      value for this field, never null.

    • getEmail

      @Nonnull public String getEmail()
      Email address of user.
      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.
      Returns:
      value for this field.

    • getStatus

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

    • getName

      @Nonnull public Name getName()
      Representations for a person's name.
      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).
      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.
      Returns:
      value for this field, or null if not present.

    • getAccountId

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

    • getSecondaryEmails

      @Nullable public List<SecondaryEmail> getSecondaryEmails()
      Secondary emails of a user.
      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).
      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.
      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).
      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.
      Returns:
      value for this field, or null if not present.

    • getIsDirectoryRestricted

      @Nullable public Boolean getIsDirectoryRestricted()
      Whether the user is a directory restricted user.
      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.
      Returns:
      value for this field, or null if not present.

    • newBuilder

      public static MemberProfile.Builder newBuilder(String teamMemberId, String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType)
      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.
      Returns:
      builder for this class.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringMultiline

      public String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.

      The returned String may contain newlines.

      Returns:
      Formatted, multiline String representation of this object