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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	groups
protected java.lang.String	memberFolderId

Fields inherited from class com.dropbox.core.v2.team.MemberProfile

accountId, email, emailVerified, externalId, invitedOn, isDirectoryRestricted, joinedOn, membershipType, name, persistentId, profilePhotoUrl, secondaryEmails, status, suspendedOn, teamMemberId

Constructor Summary

Constructors

Constructor and Description
TeamMemberProfile(java.lang.String teamMemberId, java.lang.String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType, java.util.List<java.lang.String> groups, java.lang.String memberFolderId) Profile of a user as a member of a team.
TeamMemberProfile(java.lang.String teamMemberId, java.lang.String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType, java.util.List<java.lang.String> groups, java.lang.String memberFolderId, java.lang.String externalId, java.lang.String accountId, java.util.List<SecondaryEmail> secondaryEmails, java.util.Date invitedOn, java.util.Date joinedOn, java.util.Date suspendedOn, java.lang.String persistentId, java.lang.Boolean isDirectoryRestricted, java.lang.String profilePhotoUrl) Profile of a user as a member of a team.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccountId() A user's account identifier.
java.lang.String	getEmail() Email address of user.
boolean	getEmailVerified() Is true if the user's email is verified to be owned by the user.
java.lang.String	getExternalId() External ID that a team can attach to the user.
java.util.List<java.lang.String>	getGroups() List of group IDs of groups that the user belongs to.
java.util.Date	getInvitedOn() The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.INVITED).
java.lang.Boolean	getIsDirectoryRestricted() Whether the user is a directory restricted user.
java.util.Date	getJoinedOn() The date and time the user joined as a member of a specific team.
java.lang.String	getMemberFolderId() The namespace id of the user's root folder.
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).
Name	getName() Representations for a person's name.
java.lang.String	getPersistentId() Persistent ID that a team can attach to the user.
java.lang.String	getProfilePhotoUrl() URL for the photo representing the user, if one is set.
java.util.List<SecondaryEmail>	getSecondaryEmails() Secondary emails of a user.
TeamMemberStatus	getStatus() The user's status as a member of a specific team.
java.util.Date	getSuspendedOn() The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.SUSPENDED).
java.lang.String	getTeamMemberId() ID of user as a member of a team.
int	hashCode()
static TeamMemberProfile.Builder	newBuilder(java.lang.String teamMemberId, java.lang.String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType, java.util.List<java.lang.String> groups, java.lang.String memberFolderId) 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.team.MemberProfile

newBuilder

Methods inherited from class java.lang.Object

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

Field Detail

groups

protected final java.util.List<java.lang.String> groups

memberFolderId

protected final java.lang.String memberFolderId

Constructor Detail

TeamMemberProfile

public TeamMemberProfile(java.lang.String teamMemberId,
                         java.lang.String email,
                         boolean emailVerified,
                         TeamMemberStatus status,
                         Name name,
                         TeamMembershipType membershipType,
                         java.util.List<java.lang.String> groups,
                         java.lang.String memberFolderId,
                         java.lang.String externalId,
                         java.lang.String accountId,
                         java.util.List<SecondaryEmail> secondaryEmails,
                         java.util.Date invitedOn,
                         java.util.Date joinedOn,
                         java.util.Date suspendedOn,
                         java.lang.String persistentId,
                         java.lang.Boolean isDirectoryRestricted,
                         java.lang.String profilePhotoUrl)

Profile of a user as a member of a team.

Use newBuilder 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 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:

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

TeamMemberProfile

public TeamMemberProfile(java.lang.String teamMemberId,
                         java.lang.String email,
                         boolean emailVerified,
                         TeamMemberStatus status,
                         Name name,
                         TeamMembershipType membershipType,
                         java.util.List<java.lang.String> groups,
                         java.lang.String memberFolderId)

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 root folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.

Throws:

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

Method Detail

getTeamMemberId

public java.lang.String getTeamMemberId()

ID of user as a member of a team.

Overrides:

getTeamMemberId in class MemberProfile

Returns:

value for this field, never null.

getEmail

public java.lang.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

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

public Name getName()

Representations for a person's name.

Overrides:

getName in class MemberProfile

Returns:

value for this field, never null.

getMembershipType

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

public java.util.List<java.lang.String> getGroups()

List of group IDs of groups that the user belongs to.

Returns:

value for this field, never null.

getMemberFolderId

public java.lang.String getMemberFolderId()

The namespace id of the user's root folder.

Returns:

value for this field, never null.

getExternalId

public java.lang.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

public java.lang.String getAccountId()

A user's account identifier.

Overrides:

getAccountId in class MemberProfile

Returns:

value for this field, or null if not present.

getSecondaryEmails

public java.util.List<SecondaryEmail> getSecondaryEmails()

Secondary emails of a user.

Overrides:

getSecondaryEmails in class MemberProfile

Returns:

value for this field, or null if not present.

getInvitedOn

public java.util.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

public java.util.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

public java.util.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

public java.lang.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

public java.lang.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

public java.lang.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(java.lang.String teamMemberId,
                                                   java.lang.String email,
                                                   boolean emailVerified,
                                                   TeamMemberStatus status,
                                                   Name name,
                                                   TeamMembershipType membershipType,
                                                   java.util.List<java.lang.String> groups,
                                                   java.lang.String memberFolderId)

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 root folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.

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 MemberProfile

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class MemberProfile

toString

public java.lang.String toString()

Overrides:

toString in class MemberProfile

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 MemberProfile

Returns:

Formatted, multiline String representation of this object