public class

User

extends Entity
java.lang.Object
   ↳ org.mule.modules.box.model.Entity
     ↳ org.mule.modules.box.model.User

Class Overview

The users endpoint is used for managing a user and its content. For an individual user, this includes their own user information and content. For an enterprise admin, this includes both the individual user and any other users in the admin’s enterprise account. In many entities such as folder and file, there're references to this class. In those scenarios Box will only send reduced versions of this class in which most fields will be null. The following attributes are not provided by default and need to be specifically requested through a fields parameter: trackingCodes, canSeeManagedUsers, isSyncEnabled isExemptFromDeviceLimits isExemptFromLoginVerification enterprise

Summary

Constants
long serialVersionUID
[Expand]
Inherited Constants
From class org.mule.modules.box.model.Entity
Fields
private String address The user’s address
private String avatarUrl URL of this user’s avatar image
private Boolean canSeeManagedUsers Whether this user can see other enterprise users in its contact list
private String createdAt The time this user was created
private Entity enterprise representation of this user’s enterprise, including the ID of its enterprise
private Boolean isExemptFromDeviceLimits Whether to exempt this user from Enterprise device limits
private Boolean isExemptFromLoginVerification Whether or not this user must use two-factor authentication
private Boolean isSyncEnabled Whether or not this user can use Box Sync
private String jobTitle The user’s job title
private String language The language of this user
private String login The email address this user uses to login
private Long maxUploadSize The maximum individual file size in bytes this user can have
private String modifiedAt The time this user was last modified
private Role role This user’s enterprise role.
private Long spaceAmount The user’s total available space amount in bytes
private Long spaceUsed The amount of space in use by the user
private UserStatus status Can be active or inactive
[Expand]
Inherited Fields
From class org.mule.modules.box.model.Entity
Public Constructors
User()
Public Methods
String getAddress()
String getAvatarUrl()
Boolean getCanSeeManagedUsers()
String getCreatedAt()
Entity getEnterprise()
Boolean getIsExemptFromDeviceLimits()
Boolean getIsExemptFromLoginVerification()
Boolean getIsSyncEnabled()
String getJobTitle()
String getLanguage()
String getLogin()
Long getMaxUploadSize()
String getModifiedAt()
Role getRole()
Long getSpaceAmount()
Long getSpaceUsed()
UserStatus getStatus()
void setAddress(String address)
void setAvatarUrl(String avatarUrl)
void setCanSeeManagedUsers(Boolean canSeeManagedUsers)
void setCreatedAt(String createdAt)
void setEnterprise(Entity enterprise)
void setIsExemptFromDeviceLimits(Boolean isExemptFromDeviceLimits)
void setIsExemptFromLoginVerification(Boolean isExemptFromLoginVerification)
void setIsSyncEnabled(Boolean isSyncEnabled)
void setJobTitle(String jobTitle)
void setLanguage(String language)
void setLogin(String login)
void setMaxUploadSize(Long maxUploadSize)
void setModifiedAt(String modifiedAt)
void setRole(Role role)
void setSpaceAmount(Long spaceAmount)
void setSpaceUsed(Long spaceUsed)
void setStatus(UserStatus status)
[Expand]
Inherited Methods
From class org.mule.modules.box.model.Entity
From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: -5483075221771438061 (0xb3e83422e9913813)

Fields

private String address

The user’s address

private String avatarUrl

URL of this user’s avatar image

private Boolean canSeeManagedUsers

Whether this user can see other enterprise users in its contact list

private String createdAt

The time this user was created

private Entity enterprise

representation of this user’s enterprise, including the ID of its enterprise

private Boolean isExemptFromDeviceLimits

Whether to exempt this user from Enterprise device limits

private Boolean isExemptFromLoginVerification

Whether or not this user must use two-factor authentication

private Boolean isSyncEnabled

Whether or not this user can use Box Sync

private String jobTitle

The user’s job title

private String language

The language of this user

private String login

The email address this user uses to login

private Long maxUploadSize

The maximum individual file size in bytes this user can have

private String modifiedAt

The time this user was last modified

private Role role

This user’s enterprise role.

private Long spaceAmount

The user’s total available space amount in bytes

private Long spaceUsed

The amount of space in use by the user

private UserStatus status

Can be active or inactive

Public Constructors

public User ()

Public Methods

public String getAddress ()

public String getAvatarUrl ()

public Boolean getCanSeeManagedUsers ()

public String getCreatedAt ()

public Entity getEnterprise ()

public Boolean getIsExemptFromDeviceLimits ()

public Boolean getIsExemptFromLoginVerification ()

public Boolean getIsSyncEnabled ()

public String getJobTitle ()

public String getLanguage ()

public String getLogin ()

public Long getMaxUploadSize ()

public String getModifiedAt ()

public Role getRole ()

public Long getSpaceAmount ()

public Long getSpaceUsed ()

public UserStatus getStatus ()

public void setAddress (String address)

Parameters
address

public void setAvatarUrl (String avatarUrl)

Parameters
avatarUrl

public void setCanSeeManagedUsers (Boolean canSeeManagedUsers)

Parameters
canSeeManagedUsers

public void setCreatedAt (String createdAt)

Parameters
createdAt

public void setEnterprise (Entity enterprise)

Parameters
enterprise

public void setIsExemptFromDeviceLimits (Boolean isExemptFromDeviceLimits)

Parameters
isExemptFromDeviceLimits

public void setIsExemptFromLoginVerification (Boolean isExemptFromLoginVerification)

Parameters
isExemptFromLoginVerification

public void setIsSyncEnabled (Boolean isSyncEnabled)

Parameters
isSyncEnabled

public void setJobTitle (String jobTitle)

Parameters
jobTitle

public void setLanguage (String language)

Parameters
language

public void setLogin (String login)

Parameters
login

public void setMaxUploadSize (Long maxUploadSize)

Parameters
maxUploadSize

public void setModifiedAt (String modifiedAt)

Parameters
modifiedAt

public void setRole (Role role)

Parameters
role

public void setSpaceAmount (Long spaceAmount)

Parameters
spaceAmount

public void setSpaceUsed (Long spaceUsed)

Parameters
spaceUsed

public void setStatus (UserStatus status)

Parameters
status