com.box.androidsdk.content.requests

Class BoxRequestsUser.UpdateUserInformation

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<E,R>

com.box.androidsdk.content.requests.BoxRequestItem<E,R>

com.box.androidsdk.content.requests.BoxRequestsUser.UpdateUserInformation

Enclosing class:

BoxRequestsUser

public static class BoxRequestsUser.UpdateUserInformation
extends BoxRequestItem<E,R>

Request for updating a users information

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	FIELD_IS_PASSWORD_RESET_REQUIRED

Fields inherited from class com.box.androidsdk.content.requests.BoxRequestItem

mId

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mSession

Constructor Summary

Constructors

Constructor and Description
BoxRequestsUser.UpdateUserInformation(java.lang.String requestUrl, BoxSession session, java.lang.String login, java.lang.String name) Creates an update user information request with the default parameters

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAddress() Returns the address currently set for the user in the request.
boolean	getCanSeeManagedUsers() Returns whether or not the user can see other enterprise users in her contact list currently set in the request.
java.lang.String	getEnterprise()
boolean	getIsExemptFromDeviceLimits() Returns the value currently set in the request for whether to exempt the user from Enterprise device limits.
boolean	getIsExemptFromLoginVerification() Returns the value currently set in the request for whether to exempt the user from two-factor authentication.
java.lang.String	getIsPasswordResetRequired() Gets whether or not the user is required to reset password
boolean	getIsSyncEnabled() Returns whether Box Sync is enabled for the user or not.
java.lang.String	getJobTitle() Returns the job title currently set for the user.
java.lang.String	getName() Returns the name currently set for the user in the request.
java.lang.String	getPhone() Returns the phone number for the user currently set in the request.
BoxUser.Role	getRole() Returns the role currently set for the user in the request.
double	getSpaceAmount() Returns the amount of available space currently set for the user in the request.
BoxUser.Status	getStatus() Returns the status currently set for the user in the request.
java.lang.String	getTimezone() Returns the timezone currently set for the user in the request.
protected void	parseHashMapEntry(JsonObject jsonBody, java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
R	setAddress(java.lang.String address) Sets the address of the user in the request.
R	setCanSeeManagedUsers(boolean canSeeManagedUsers) Sets whether or not the user can see other enterprise users in her contact list in the request.
BoxRequestsUser.UpdateUserInformation	setEnterprise(java.lang.String enterprise) Sets the enterprise the user belongs to.
R	setIsExemptFromDeviceLimits(boolean isExemptFromDeviceLimits) Sets whether to exempt the user from Enterprise device limits in the request.
R	setIsExemptFromLoginVerification(boolean isExemptFromLoginVerification) Sets whether the user is exempt from two-factor authentication in the request.
BoxRequestsUser.UpdateUserInformation	setIsPasswordResetRequired(boolean isPasswordResetRequired) Sets whether or not the user is required to reset password
R	setIsSyncEnabled(boolean isSyncEnabled) Sets whether or not Box Sync is enabled for the user.
R	setJobTitle(java.lang.String jobTitle) Sets the job title for the user in the request.
R	setName(java.lang.String name) Sets the new name for the user in the request.
R	setPhone(java.lang.String phone) Sets the phone number of the user in the request.
R	setRole(BoxUser.Role role) Sets the new role for the user.
R	setSpaceAmount(double spaceAmount) Sets the amount of space available for the user in the request.
R	setStatus(BoxUser.Status status) Sets the status for the user in the request.
R	setTimezone(java.lang.String timezone) Sets the timezone for the user in the request.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequestItem

getId, setFields

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHttpRequest, createQuery, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getStringBody, importRequestContentMapsFrom, logDebug, logRequest, parseJsonObject, send, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_IS_PASSWORD_RESET_REQUIRED

protected static final java.lang.String FIELD_IS_PASSWORD_RESET_REQUIRED

See Also:

Constant Field Values

Constructor Detail

BoxRequestsUser.UpdateUserInformation

public BoxRequestsUser.UpdateUserInformation(java.lang.String requestUrl,
                                     BoxSession session,
                                     java.lang.String login,
                                     java.lang.String name)

Creates an update user information request with the default parameters

Parameters:

requestUrl - URL of the update user information endpoint

session - the authenticated session that will be used to make the request with

Method Detail

getEnterprise

public java.lang.String getEnterprise()

setEnterprise

public BoxRequestsUser.UpdateUserInformation setEnterprise(java.lang.String enterprise)

Sets the enterprise the user belongs to. Setting this to null will roll the user out of the enterprise and make them a free user.

Parameters:

enterprise - the enterprise the user will be associated with.

Returns:

the update user information request.

getIsPasswordResetRequired

public java.lang.String getIsPasswordResetRequired()

Gets whether or not the user is required to reset password

Returns:

whether or not the user is required to reset password

setIsPasswordResetRequired

public BoxRequestsUser.UpdateUserInformation 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

Returns:

the update user information request

parseHashMapEntry

protected void parseHashMapEntry(JsonObject jsonBody,
                     java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Overrides:

parseHashMapEntry in class BoxRequest<BoxUser,BoxRequestsUser.UpdateUserInformation>

getName

public java.lang.String getName()

Returns the name currently set for the user in the request.

Returns:

name for the user, or null if not set.

setName

public R setName(java.lang.String name)

Sets the new name for the user in the request.

Parameters:

name - new name for the user.

Returns:

request with the updated name.

getRole

public BoxUser.Role getRole()

Returns the role currently set for the user in the request.

Returns:

BoxUser.Role for the user, or null if not set.

setRole

public R setRole(BoxUser.Role role)

Sets the new role for the user.

Parameters:

role - new role for the user.

Returns:

request with the updated role.

getIsSyncEnabled

public boolean getIsSyncEnabled()

Returns whether Box Sync is enabled for the user or not.

Returns:

whether or not Box Sync is enabled for the user, or null if not set.

setIsSyncEnabled

public R setIsSyncEnabled(boolean isSyncEnabled)

Sets whether or not Box Sync is enabled for the user.

Parameters:

isSyncEnabled - whether or not Box Sync is enabled for the user.

Returns:

request with the updated value for whether Sync is enabled or not.

getJobTitle

public java.lang.String getJobTitle()

Returns the job title currently set for the user.

Returns:

job title of the user.

setJobTitle

public R setJobTitle(java.lang.String jobTitle)

Sets the job title for the user in the request.

Parameters:

jobTitle - new job title for the user.

Returns:

request with the updated job title.

getPhone

public java.lang.String getPhone()

Returns the phone number for the user currently set in the request.

Returns:

phone number for the user, or null if not set.

setPhone

public R setPhone(java.lang.String phone)

Sets the phone number of the user in the request.

Parameters:

phone - new phone number for the user.

Returns:

request with the updated phone number.

getAddress

public java.lang.String getAddress()

Returns the address currently set for the user in the request.

Returns:

address for the user, or null if not set.

setAddress

public R setAddress(java.lang.String address)

Sets the address of the user in the request.

Parameters:

address - new address for the user.

Returns:

request with the updated address.

getSpaceAmount

public double getSpaceAmount()

Returns the amount of available space currently set for the user in the request.

Returns:

space for the user in bytes, or null if not set.

setSpaceAmount

public R setSpaceAmount(double spaceAmount)

Sets the amount of space available for the user in the request.

Parameters:

spaceAmount - new amount of space available for the user in bytes.

Returns:

request with the updated available space.

getCanSeeManagedUsers

public boolean getCanSeeManagedUsers()

Returns whether or not the user can see other enterprise users in her contact list currently set in the request.

Returns:

whether or not the user can see other enterprise users in her contact list, or null if not set.

setCanSeeManagedUsers

public R setCanSeeManagedUsers(boolean canSeeManagedUsers)

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

Parameters:

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

Returns:

request with the updated value for whether or not the user can see other enterprise users in her contact list.

getStatus

public BoxUser.Status getStatus()

Returns the status currently set for the user in the request.

Returns:

BoxUser.Status currently set for the user, or null if not set.

setStatus

public R setStatus(BoxUser.Status status)

Sets the status for the user in the request.

Parameters:

status - new BoxUser.Status for the user.

Returns:

request with the updated status for the user.

getTimezone

public java.lang.String getTimezone()

Returns the timezone currently set for the user in the request.

Returns:

timezone currently set for the user, or null if not set.

setTimezone

public R setTimezone(java.lang.String timezone)

Sets the timezone for the user in the request.

Parameters:

timezone - new timezone for the user.

Returns:

request with the updated timezone.

getIsExemptFromDeviceLimits

public boolean getIsExemptFromDeviceLimits()

Returns the value currently set in the request for whether to exempt the user from Enterprise device limits.

Returns:

Boolean representing whether to exempt the user from Enterprise device limits, or null if not set.

setIsExemptFromDeviceLimits

public R setIsExemptFromDeviceLimits(boolean isExemptFromDeviceLimits)

Sets whether to exempt the user from Enterprise device limits in the request.

Parameters:

isExemptFromDeviceLimits - new value for whether the user is exempt from Enterprise device limits.

Returns:

request with the updated value for whether the user is exempt from Enterprise device limits.

getIsExemptFromLoginVerification

public boolean getIsExemptFromLoginVerification()

Returns the value currently set in the request for whether to exempt the user from two-factor authentication.

Returns:

Boolean representing whether to exempt the user from two-factor authentication, or null if not set.

setIsExemptFromLoginVerification

public R setIsExemptFromLoginVerification(boolean isExemptFromLoginVerification)

Sets whether the user is exempt from two-factor authentication in the request.

Parameters:

isExemptFromLoginVerification - new value for whether the user is exempt from two-factor authentication.

Returns:

request with the updated value for whether the user is exempt from two-factor authentication.