com.box.sdk

Class BoxUser.Info

Object

BoxJSONObject

BoxResource.Info

BoxCollaborator.Info

BoxUser.Info

Enclosing class:

BoxUser

public class BoxUser.Info
extends BoxCollaborator.Info

Contains information about a BoxUser.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
void	appendTrackingCodes(String name, String value) Allows the admin to append new tracking codes to the previous existing list.
String	getAddress() Gets the address of the user.
String	getAvatarURL() Gets the URL of the user's avatar.
boolean	getCanSeeManagedUsers() Gets whether or not the user can see other enterprise users in their contact list.
BoxEnterprise	getEnterprise() Gets the enterprise that the user belongs to.
String	getExternalAppUserId() Gets the external app user id that has been set for the app user.
String	getHostname() Gets the root (protocol, subdomain, domain) of any links that need to be generated for this user.
boolean	getIsExemptFromDeviceLimits() Gets whether or not the user is exempt from enterprise device limits.
boolean	getIsExemptFromLoginVerification() Gets whether or not the user must use two-factor authentication.
boolean	getIsExternalCollabRestricted() Gets whether this user is allowed or not to collaborate with users outside their enterprise.
boolean	getIsPasswordResetRequired() Gets whether or not the user is required to reset password.
boolean	getIsPlatformAccessOnly() Gets whether or not the user we are creating is an app user with Box Developer Edition.
boolean	getIsSyncEnabled() Gets whether or not the user can use Box Sync.
String	getJobTitle() Gets the job title of the user.
String	getLanguage() Gets the language of the user.
String	getLogin() Gets the email address the user uses to login.
long	getMaxUploadSize() Gets the maximum individual file size in bytes the user can have.
List<String>	getMyTags() Gets the tags for all files and folders owned by this user.
BoxNotificationEmail	getNotificationEmail() Gets the user's alternate notification email address to which email notifications are sent.
String	getPhone() Gets the phone number of the user.
BoxUser	getResource() Gets the resource associated with this Info.
BoxUser.Role	getRole() Gets the user's enterprise role.
long	getSpaceAmount() Gets the user's total available space in bytes.
long	getSpaceUsed() Gets the amount of space the user has used in bytes.
BoxUser.Status	getStatus() Gets the user's current account status.
String	getTimezone() Gets the timezone of the user.
Map<String,String>	getTrackingCodes() Gets the tracking defined for each entity.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	removeEnterprise() Removes the user from their enterprise and converts them to a standalone free user.
void	setAddress(String address) Sets the address of the user.
void	setCanSeeManagedUsers(boolean canSeeManagedUsers) Sets whether or not the user can see other enterprise users in their contact list.
void	setExternalAppUserId(String externalAppUserId) Sets the external app user id.
void	setIsExemptFromDeviceLimits(boolean isExemptFromDeviceLimits) Sets whether or not the user is exempt from enterprise device limits.
void	setIsExemptFromLoginVerification(boolean isExemptFromLoginVerification) Sets whether or not the user must use two-factor authentication.
void	setIsExternalCollabRestricted(boolean isExternalCollabRestricted) Sets whether this user is allowed or not to collaborate with users outside their enterprise.
void	setIsPasswordResetRequired(boolean isPasswordResetRequired) Sets whether or not the user is required to reset password.
void	setIsSyncEnabled(boolean enabled) Sets whether or not the user can use Box Sync.
void	setJobTitle(String jobTitle) Sets the job title of the user.
void	setLanguage(String language) Sets the language of the user.
void	setLogin(String login) Sets the email address the user uses to login.
void	setNotificationEmail(BoxNotificationEmail notificationEmail) Sets the user's notification email address.
void	setPhone(String phone) Sets the phone number of the user.
void	setRole(BoxUser.Role role) Sets the user's role in their enterprise.
void	setSpaceAmount(long spaceAmount) Sets the user's total available space in bytes.
void	setStatus(BoxUser.Status status) Sets the user's current account status.
void	setTimezone(String timezone) Sets the timezone of the user.
void	setTrackingCodes(Map<String,String> trackingCodes) Allows admin to set attributes specific for a group of users.

Methods inherited from class BoxCollaborator.Info

getCreatedAt, getGroupType, getModifiedAt, getName, getType, setName

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getResource

public BoxUser getResource()

Description copied from class: BoxResource.Info

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getLogin

public String getLogin()

Gets the email address the user uses to login.

Overrides:

getLogin in class BoxCollaborator.Info

Returns:

the email address the user uses to login.

setLogin

public void setLogin(String login)

Sets the email address the user uses to login. The new login must be one of the user's already confirmed email aliases.

Parameters:

login - one of the user's confirmed email aliases.

getRole

public BoxUser.Role getRole()

Gets the user's enterprise role.

Returns:

the user's enterprise role.

setRole

public void setRole(BoxUser.Role role)

Sets the user's role in their enterprise.

Parameters:

role - the user's new role in their enterprise.

getLanguage

public String getLanguage()

Gets the language of the user.

Returns:

the language of the user.

setLanguage

public void setLanguage(String language)

Sets the language of the user.

Parameters:

language - the new language of the user.

getTimezone

public String getTimezone()

Gets the timezone of the user.

Returns:

the timezone of the user.

setTimezone

public void setTimezone(String timezone)

Sets the timezone of the user.

Parameters:

timezone - the new timezone of the user.

getSpaceAmount

public long getSpaceAmount()

Gets the user's total available space in bytes.

Returns:

the user's total available space in bytes.

setSpaceAmount

public void setSpaceAmount(long spaceAmount)

Sets the user's total available space in bytes.

Parameters:

spaceAmount - the new amount of space available to the user in bytes, or -1 for unlimited storage.

getSpaceUsed

public long getSpaceUsed()

Gets the amount of space the user has used in bytes.

Returns:

the amount of space the user has used in bytes.

getMaxUploadSize

public long getMaxUploadSize()

Gets the maximum individual file size in bytes the user can have.

Returns:

the maximum individual file size in bytes the user can have.

getStatus

public BoxUser.Status getStatus()

Gets the user's current account status.

Returns:

the user's current account status.

setStatus

public void setStatus(BoxUser.Status status)

Sets the user's current account status.

Parameters:

status - the user's new account status.

getJobTitle

public String getJobTitle()

Gets the job title of the user.

Returns:

the job title of the user.

setJobTitle

public void setJobTitle(String jobTitle)

Sets the job title of the user.

Parameters:

jobTitle - the new job title of the user.

getPhone

public String getPhone()

Gets the phone number of the user.

Returns:

the phone number of the user.

setPhone

public void setPhone(String phone)

Sets the phone number of the user.

Parameters:

phone - the new phone number of the user.

getAddress

public String getAddress()

Gets the address of the user.

Returns:

the address of the user.

setAddress

public void setAddress(String address)

Sets the address of the user.

Parameters:

address - the new address of the user.

getAvatarURL

public String getAvatarURL()

Gets the URL of the user's avatar.

Returns:

the URL of the user's avatar.

getNotificationEmail

public BoxNotificationEmail getNotificationEmail()

Gets the user's alternate notification email address to which email notifications are sent.

Returns:

the user's notification email address.

setNotificationEmail

public void setNotificationEmail(BoxNotificationEmail notificationEmail)

Sets the user's notification email address.

Parameters:

notificationEmail - the user's new notification email address.

getEnterprise

public BoxEnterprise getEnterprise()

Gets the enterprise that the user belongs to.

Returns:

the enterprise that the user belongs to.

removeEnterprise

public void removeEnterprise()

Removes the user from their enterprise and converts them to a standalone free user.

getIsSyncEnabled

public boolean getIsSyncEnabled()

Gets whether or not the user can use Box Sync.

Returns:

true if the user can use Box Sync; otherwise false.

setIsSyncEnabled

public void setIsSyncEnabled(boolean enabled)

Sets whether or not the user can use Box Sync.

Parameters:

enabled - whether or not the user can use Box Sync.

getIsExternalCollabRestricted

public boolean getIsExternalCollabRestricted()

Gets whether this user is allowed or not to collaborate with users outside their enterprise.

Returns:

true if this user is not allowed to collaborate with users outside their enterprise; otherwise false.

setIsExternalCollabRestricted

public void setIsExternalCollabRestricted(boolean isExternalCollabRestricted)

Sets whether this user is allowed or not to collaborate with users outside their enterprise.

Parameters:

isExternalCollabRestricted - whether the user is allowed to collaborate outside their enterprise.

getCanSeeManagedUsers

public boolean getCanSeeManagedUsers()

Gets whether or not the user can see other enterprise users in their contact list.

Returns:

true if the user can see other enterprise users in their contact list; otherwise false.

setCanSeeManagedUsers

public void setCanSeeManagedUsers(boolean canSeeManagedUsers)

Sets whether or not the user can see other enterprise users in their contact list.

Parameters:

canSeeManagedUsers - whether or not the user can see other enterprise users in their contact list.

getIsExemptFromDeviceLimits

public boolean getIsExemptFromDeviceLimits()

Gets whether or not the user is exempt from enterprise device limits.

Returns:

true if the user is exempt from enterprise device limits; otherwise false.

setIsExemptFromDeviceLimits

public void setIsExemptFromDeviceLimits(boolean isExemptFromDeviceLimits)

Sets whether or not the user is exempt from enterprise device limits.

Parameters:

isExemptFromDeviceLimits - whether or not the user is exempt from enterprise device limits.

getIsExemptFromLoginVerification

public boolean getIsExemptFromLoginVerification()

Gets whether or not the user must use two-factor authentication.

Returns:

true if the user must use two-factor authentication; otherwise false.

setIsExemptFromLoginVerification

public void setIsExemptFromLoginVerification(boolean isExemptFromLoginVerification)

Sets whether or not the user must use two-factor authentication.

Parameters:

isExemptFromLoginVerification - whether or not the user must use two-factor authentication.

getIsPasswordResetRequired

public boolean getIsPasswordResetRequired()

Gets whether or not the user is required to reset password.

Returns:

true if the user is required to reset password; otherwise false.

setIsPasswordResetRequired

public void setIsPasswordResetRequired(boolean isPasswordResetRequired)

Sets whether or not the user is required to reset password.

Parameters:

isPasswordResetRequired - whether or not the user is required to reset password.

getIsPlatformAccessOnly

public boolean getIsPlatformAccessOnly()

Gets whether or not the user we are creating is an app user with Box Developer Edition.

Returns:

true if the new user is an app user for Box Developer Addition; otherwise false.

getExternalAppUserId

public String getExternalAppUserId()

Gets the external app user id that has been set for the app user.

Returns:

the external app user id.

setExternalAppUserId

public void setExternalAppUserId(String externalAppUserId)

Sets the external app user id.

Parameters:

externalAppUserId - external app user id.

getMyTags

public List<String> getMyTags()

Gets the tags for all files and folders owned by this user.

Returns:

the tags for all files and folders owned by this user.

getHostname

public String getHostname()

Gets the root (protocol, subdomain, domain) of any links that need to be generated for this user.

Returns:

the root (protocol, subdomain, domain) of any links that need to be generated for this user.

getTrackingCodes

public Map<String,String> getTrackingCodes()

Gets the tracking defined for each entity.

Returns:

a Map with tracking codes.

setTrackingCodes

public void setTrackingCodes(Map<String,String> trackingCodes)

Allows admin to set attributes specific for a group of users.

Parameters:

trackingCodes - a Map representing the user's new tracking codes

appendTrackingCodes

public void appendTrackingCodes(String name,
                                String value)

Allows the admin to append new tracking codes to the previous existing list.

Parameters:

name - the name or `key` of the attribute to set.

value - the value of the attribute to set.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJSONObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Overrides:

parseJSONMember in class BoxCollaborator.Info

Parameters:

member - the JSON member to be parsed.