com.box.boxjavalibv2.requests.requestobjects

Class BoxUserRequestObject

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxUserRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxUserRequestObject
extends BoxDefaultRequestObject

Method Summary

Methods

Modifier and Type	Method and Description
static BoxUserRequestObject	addEmailAliasRequestObject(String email) Request object to add an email alias.
static BoxUserRequestObject	createEnterpriseUserRequestObject(String login, String name) Request object to create an enterprise user.
static BoxUserRequestObject	moveFolderToAnotherUserRequestObject(String destinationUserId, boolean notify) Request object to move a folder to another user.
BoxUserRequestObject	setAddress(String address)
BoxUserRequestObject	setCanSeeManagedUsers(boolean canSeeManagedUsers)
BoxUserRequestObject	setDestinationUser(String destinationUserId) Set destination user, this is only used in request to move a folder to another user's account.
BoxUserRequestObject	setEmailAlias(String email) Set email alias.
BoxUserRequestObject	setEnterprise(BoxEnterprise 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	setName(String name)
BoxUserRequestObject	setNotifyUser(boolean notify) Set whether the user should receive an email notification.
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 object to update an enterprise user.
static BoxUserRequestObject	updateUserPrimaryLoginRequestObject(String login) Request object to update user's primary login.

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

addField, addFields, addHeader, addQueryParam, get, getEntity, getFields, getHeaders, getJSONEntity, getJSONParser, getQueryParams, put, put, put, setJSONParser, setPage

Methods inherited from class java.lang.Object

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

Method Detail

setName

public BoxUserRequestObject setName(String name)

createEnterpriseUserRequestObject

public static BoxUserRequestObject createEnterpriseUserRequestObject(String login,
                                                     String name)

Request object 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 object 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:

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

Returns:

updateUserPrimaryLoginRequestObject

public static BoxUserRequestObject updateUserPrimaryLoginRequestObject(String login)

Request object to update user's primary login.

Parameters:

login -

Returns:

addEmailAliasRequestObject

public static BoxUserRequestObject addEmailAliasRequestObject(String email)

Request object to add an email alias.

Parameters:

email -

Returns:

moveFolderToAnotherUserRequestObject

public static BoxUserRequestObject moveFolderToAnotherUserRequestObject(String destinationUserId,
                                                        boolean notify)

Request object to move a folder to another user.

Parameters:

destinationFolderId - the ID of the user who the folder will be transferred to

notify - whether destination user should receive email notification of the transfer

Returns:

setLogin

public BoxUserRequestObject setLogin(String login)

Set Login(email) of the user.

Parameters:

login - login

Returns:

setEmailAlias

public BoxUserRequestObject setEmailAlias(String email)

Set email alias.

Parameters:

email -

Returns:

setDestinationUser

public BoxUserRequestObject setDestinationUser(String destinationUserId)

Set destination user, this is only used in request to move a folder to another user's account.

Parameters:

destinationFolderId - the ID of the user who the folder will be transferred to

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:

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:

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(BoxEnterprise 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:

setNotifyUser

public BoxUserRequestObject setNotifyUser(boolean notify)

Set whether the user should receive an email notification. This applies to the case when they are rolled out of an enterprise or when somebody moves a folder into the user's account.

Parameters:

notify -

Returns: