com.dropbox.core.v2.team

Class MemberProfile

java.lang.Object

com.dropbox.core.v2.team.MemberProfile

Direct Known Subclasses:

TeamMemberProfile

public class MemberProfile
extends java.lang.Object

Basic member profile.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accountId
protected java.lang.String	email
protected boolean	emailVerified
protected java.lang.String	externalId
protected java.util.Date	invitedOn
protected java.lang.Boolean	isDirectoryRestricted
protected java.util.Date	joinedOn
protected TeamMembershipType	membershipType
protected Name	name
protected java.lang.String	persistentId
protected java.lang.String	profilePhotoUrl
protected java.util.List<SecondaryEmail>	secondaryEmails
protected TeamMemberStatus	status
protected java.util.Date	suspendedOn
protected java.lang.String	teamMemberId

Constructor Summary

Constructors

Constructor and Description
MemberProfile(java.lang.String teamMemberId, java.lang.String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType) Basic member profile.
MemberProfile(java.lang.String teamMemberId, java.lang.String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType, 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) Basic member profile.

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.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.
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 MemberProfile.Builder	newBuilder(java.lang.String teamMemberId, java.lang.String email, boolean emailVerified, TeamMemberStatus status, Name name, TeamMembershipType membershipType) 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 java.lang.Object

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

Field Detail

teamMemberId

protected final java.lang.String teamMemberId

externalId

protected final java.lang.String externalId

accountId

protected final java.lang.String accountId

email

protected final java.lang.String email

emailVerified

protected final boolean emailVerified

secondaryEmails

protected final java.util.List<SecondaryEmail> secondaryEmails

status

protected final TeamMemberStatus status

name

protected final Name name

membershipType

protected final TeamMembershipType membershipType

invitedOn

protected final java.util.Date invitedOn

joinedOn

protected final java.util.Date joinedOn

suspendedOn

protected final java.util.Date suspendedOn

persistentId

protected final java.lang.String persistentId

isDirectoryRestricted

protected final java.lang.Boolean isDirectoryRestricted

profilePhotoUrl

protected final java.lang.String profilePhotoUrl

Constructor Detail

MemberProfile

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

Basic member profile.

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.

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.

MemberProfile

public MemberProfile(java.lang.String teamMemberId,
                     java.lang.String email,
                     boolean emailVerified,
                     TeamMemberStatus status,
                     Name name,
                     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:

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.

Returns:

value for this field, never null.

getEmail

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

public TeamMemberStatus getStatus()

The user's status as a member of a specific team.

Returns:

value for this field, never null.

getName

public Name getName()

Representations for a person's name.

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

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.

Returns:

value for this field, or null if not present.

getAccountId

public java.lang.String getAccountId()

A user's account identifier.

Returns:

value for this field, or null if not present.

getSecondaryEmails

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

Secondary emails of a user.

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

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.

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

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.

Returns:

value for this field, or null if not present.

getIsDirectoryRestricted

public java.lang.Boolean getIsDirectoryRestricted()

Whether the user is a directory restricted user.

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.

Returns:

value for this field, or null if not present.

newBuilder

public static MemberProfile.Builder newBuilder(java.lang.String teamMemberId,
                                               java.lang.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:

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

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