com.box.boxjavalibv2.requests.requestobjects

Class BoxUserRequestObject

java.lang.Object

com.box.restclientv2.requestsbase.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxSimpleUserRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxUserRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxUserRequestObject
extends BoxSimpleUserRequestObject

Constructor Summary

Constructors

Constructor and Description
BoxUserRequestObject()

Method Summary

Methods

Modifier and Type	Method and Description
static BoxUserRequestObject	createEnterpriseUserRequestObject(String login, String name) Request entity to create an enterprise user.
BoxUserRequestObject	setAddress(String address)
BoxUserRequestObject	setAvatarUrl(String avatarUrl) Sets the URL for this user's avatar image.
BoxUserRequestObject	setCanSeeManagedUsers(boolean canSeeManagedUsers)
BoxUserRequestObject	setEnterprise(BoxEnterpriseRequestEntity enterprise)
BoxUserRequestObject	setExemptFromDeviceLimits(boolean exemptFromDeviceLimits)
BoxUserRequestObject	setExemptFromLoginVerification(boolean exemptFromLoginVerification)
BoxUserRequestObject	setJobTitle(String jobTitle)
BoxUserRequestObject	setLanguage(String language)
BoxUserRequestObject	setLogin(String login) Set Login(email) of the user.
BoxUserRequestObject	setMaxUploadSize(Double max_upload_size) Sets the maximum individual file size in bytes this user can have
BoxUserRequestObject	setMyTags(String... myTags) Sets set of all tags on items that are visible by this user.
BoxUserRequestObject	setName(String name)
BoxUserRequestObject	setPhone(String phone)
BoxUserRequestObject	setRole(String role) Set The the user's enterprise role.
BoxUserRequestObject	setSpaceAmount(double spaceAmount)
BoxUserRequestObject	setStatus(String status)
BoxUserRequestObject	setSyncEnabled(boolean isSyncEnabled)
BoxUserRequestObject	setTrackingCodes(LinkedHashMap<String,String> trackingCodes)
static BoxUserRequestObject	updateUserInfoRequestObject(boolean notify) Request entity to update an enterprise user.

Methods inherited from class com.box.boxjavalibv2.requests.requestobjects.BoxSimpleUserRequestObject

moveFolderToAnotherUserRequestEntity, setNotifyUser

Methods inherited from class com.box.restclientv2.requestsbase.BoxDefaultRequestObject

getFromEntity, getJSONEntity, getRequestExtras, put, setPage

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxUserRequestObject

public BoxUserRequestObject()

Method Detail

createEnterpriseUserRequestObject

public static BoxUserRequestObject createEnterpriseUserRequestObject(String login,
                                                     String name)

Request entity to create an enterprise user.

Parameters:

login - Login(email) of the user.

name - name of the user

Returns:

updateUserInfoRequestObject

public static BoxUserRequestObject updateUserInfoRequestObject(boolean notify)

Request entity to update an enterprise user. Please note the returned object is not supposed to be used for updating the user's primary login. For that purpose, please use the method: updateUserPrimaryLoginRequestObject(final String login)

Parameters:

notify - whether to notify user if user is rolled out of enterprise

Returns:

setName

public BoxUserRequestObject setName(String name)

setLogin

public BoxUserRequestObject setLogin(String login)

Set Login(email) of the user.

Parameters:

login - login

Returns:

setRole

public BoxUserRequestObject setRole(String role)

Set The the user's enterprise role. The role can be BoxUser.ROLE_ADMIN , BoxUser.ROLE_COADMIN or BoxUser.ROLE_USER.

Parameters:

role -

Returns:

setLanguage

public BoxUserRequestObject setLanguage(String language)

Parameters:

language - the language to set

Returns:

setSyncEnabled

public BoxUserRequestObject setSyncEnabled(boolean isSyncEnabled)

Parameters:

isSyncEnabled - the isSyncEnabled to set

Returns:

setJobTitle

public BoxUserRequestObject setJobTitle(String jobTitle)

Parameters:

jobTitle - the jobTitle to set

Returns:

setPhone

public BoxUserRequestObject setPhone(String phone)

Parameters:

phone - the phone to set

Returns:

setAddress

public BoxUserRequestObject setAddress(String address)

Parameters:

address - the address to set

Returns:

setSpaceAmount

public BoxUserRequestObject setSpaceAmount(double spaceAmount)

Parameters:

spaceAmount - the spaceAmount to set

Returns:

setMaxUploadSize

public BoxUserRequestObject setMaxUploadSize(Double max_upload_size)

Sets the maximum individual file size in bytes this user can have

Parameters:

max_upload_size - the max_upload_size to set

setTrackingCodes

public BoxUserRequestObject setTrackingCodes(LinkedHashMap<String,String> trackingCodes)

Parameters:

trackingCodes - the trackingCodes to set

Returns:

setCanSeeManagedUsers

public BoxUserRequestObject setCanSeeManagedUsers(boolean canSeeManagedUsers)

Parameters:

canSeeManagedUsers - the canSeeManagedUsers to set

Returns:

setStatus

public BoxUserRequestObject setStatus(String status)

Parameters:

status - the status to set. Status of the user. This String can be BoxUser.STATUS_ACTIVE or BoxUser.STATUS_INACTIVE

Returns:

setAvatarUrl

public BoxUserRequestObject setAvatarUrl(String avatarUrl)

Sets the URL for this user's avatar image.

Parameters:

avatarUrl - the avatar_url to set

setExemptFromDeviceLimits

public BoxUserRequestObject setExemptFromDeviceLimits(boolean exemptFromDeviceLimits)

Parameters:

exemptFromDeviceLimits - the exemptFromDeviceLimits to set

Returns:

setExemptFromLoginVerification

public BoxUserRequestObject setExemptFromLoginVerification(boolean exemptFromLoginVerification)

Parameters:

exemptFromLoginVerification - the exemptFromLoginVerification to set

Returns:

setEnterprise

public BoxUserRequestObject setEnterprise(BoxEnterpriseRequestEntity enterprise)

Parameters:

enterprise - the enterprise to set. Note when updating user information you can set this to null in order to roll the user out from enterprise.

Returns:

setMyTags

public BoxUserRequestObject setMyTags(String... myTags)

Sets set of all tags on items that are visible by this user. Note this is not tags of the "BoxUser" object.

Parameters:

myTags - my_tags