org.nuxeo.box.api.marshalling.dao

Class BoxUser

java.lang.Object

org.nuxeo.box.api.marshalling.dao.BoxBase

org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

org.nuxeo.box.api.marshalling.dao.BoxObject

org.nuxeo.box.api.marshalling.dao.BoxTypedObject

org.nuxeo.box.api.marshalling.dao.BoxUser

All Implemented Interfaces:

IBoxJSONStringEntity

Direct Known Subclasses:

BoxGroup

public class BoxUser
extends BoxTypedObject

Box user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_ADDRESS
static String	FIELD_AVATAR_URL
static String	FIELD_CAN_SEE_MANAGED_USERS Whether this user can see other enterprise users in its contact list
static String	FIELD_ENTERPRISE Mini representation of this user's enterprise, including the ID of its enterprise
static String	FIELD_EXEMPT_FROM_DEVICE_LIMITS
static String	FIELD_EXEMPT_FROM_LOGIN_VERIFICATION
static String	FIELD_IS_EXEMPT_FROM_DEVICE_LIMITS Whether or not this user must use two-factor authentication
static String	FIELD_IS_EXEMPT_FROM_LOGIN_VERIFICATION Whether or not this user must use two-factor authentication
static String	FIELD_IS_SYNC_ENABLED Whether to exempt this user from Enterprise device limits
static String	FIELD_JOB_TITLE
static String	FIELD_LANGUAGE
static String	FIELD_LOGIN
static String	FIELD_MAX_UPLOAD_SIZE
static String	FIELD_MY_TAGS
static String	FIELD_NAME
static String	FIELD_PHONE
static String	FIELD_ROLE The user's enterprise role.
static String	FIELD_SPACE_AMOUNT
static String	FIELD_SPACE_USED
static String	FIELD_STATUS
static String	FIELD_TRACKING_CODES An array of key/value pairs set by the user's admin
static String	ROLE_ADMIN Used when the user's enterprise role is admin.
static String	ROLE_COADMIN Used when the user's enterprise role is co-admin.
static String	ROLE_USER Used when the user's enterprise role is normal user.
static String	STATUS_ACTIVE Used when user status is active
static String	STATUS_INACTIVE Used when user status is inactive

Fields inherited from class org.nuxeo.box.api.marshalling.dao.BoxTypedObject

FIELD_CREATED_AT, FIELD_ID, FIELD_MODIFIED_AT, FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
BoxUser() Constructor.
BoxUser(BoxUser obj) Copy constructor, this does deep copy for all the fields.
BoxUser(Map<String,Object> map) Instantiate the object from a map.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	canSeeManagedUsers() Whether or not the user can see other enterprise users in the contact list.
String	getAddress() Get the user's address.
String	getAvatarUrl() get the URL for this user's avatar image.
BoxEnterprise	getEnterprise() Get the enterprise this user belongs to if available, null otherwise.
String	getJobTitle() Get the user's job title.
String	getLanguage() Get the language of this user.
String	getLogin() Get the email address this user uses to login
Double	getMaxUploadSize() Get the maximum individual file size in bytes this user can have
String[]	getMyTags() Get set of all tags on items that are visible by this user.
String	getName() Get name of this user.
String	getPhone() Get the user's phone number.
String	getRole() Get the user's enterprise role.
Double	getSpaceAmount() Get the user's total available space amount in bytes.
Double	getSpaceUsed() Get the amount of space in use by the user.
String	getStatus() Get status of the user.
Map<String,String>	getTrackingCodes() Get the tracking codes.
Boolean	isExemptFromDeviceLimits() Whether to exempt this user from Enterprise device limits.
Boolean	isExemptFromLoginVerification() Whether or not this user must use two-factor authentication.
Boolean	isSyncEnabled() Whether or not this user can use Box Sync.

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxTypedObject

dateCreatedAt, dateModifiedAt, getCreatedAt, getId, getModifiedAt, getType, resourceType, setType

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxObject

contains, equals, getExtraData, getKeySet, getValue, handleUnknown, hashCode, properties, put, putAll

Methods inherited from class org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

toJSONString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE_ADMIN

public static final String ROLE_ADMIN

Used when the user's enterprise role is admin.

See Also:

Constant Field Values

ROLE_COADMIN

public static final String ROLE_COADMIN

Used when the user's enterprise role is co-admin.

See Also:

Constant Field Values

ROLE_USER

public static final String ROLE_USER

Used when the user's enterprise role is normal user.

See Also:

Constant Field Values

STATUS_ACTIVE

public static final String STATUS_ACTIVE

Used when user status is active

See Also:

Constant Field Values

STATUS_INACTIVE

public static final String STATUS_INACTIVE

Used when user status is inactive

See Also:

Constant Field Values

FIELD_ROLE

public static final String FIELD_ROLE

The user's enterprise role. Can be admin, coadmin, or user

See Also:

Constant Field Values

FIELD_TRACKING_CODES

public static final String FIELD_TRACKING_CODES

An array of key/value pairs set by the user's admin

See Also:

Constant Field Values

FIELD_CAN_SEE_MANAGED_USERS

public static final String FIELD_CAN_SEE_MANAGED_USERS

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

See Also:

Constant Field Values

FIELD_IS_SYNC_ENABLED

public static final String FIELD_IS_SYNC_ENABLED

Whether to exempt this user from Enterprise device limits

See Also:

Constant Field Values

FIELD_IS_EXEMPT_FROM_DEVICE_LIMITS

public static final String FIELD_IS_EXEMPT_FROM_DEVICE_LIMITS

Whether or not this user must use two-factor authentication

See Also:

Constant Field Values

FIELD_IS_EXEMPT_FROM_LOGIN_VERIFICATION

public static final String FIELD_IS_EXEMPT_FROM_LOGIN_VERIFICATION

Whether or not this user must use two-factor authentication

See Also:

Constant Field Values

FIELD_ENTERPRISE

public static final String FIELD_ENTERPRISE

Mini representation of this user's enterprise, including the ID of its enterprise

See Also:

Constant Field Values

FIELD_NAME

public static final String FIELD_NAME

See Also:

Constant Field Values

FIELD_LOGIN

public static final String FIELD_LOGIN

See Also:

Constant Field Values

FIELD_LANGUAGE

public static final String FIELD_LANGUAGE

See Also:

Constant Field Values

FIELD_SPACE_AMOUNT

public static final String FIELD_SPACE_AMOUNT

See Also:

Constant Field Values

FIELD_SPACE_USED

public static final String FIELD_SPACE_USED

See Also:

Constant Field Values

FIELD_MAX_UPLOAD_SIZE

public static final String FIELD_MAX_UPLOAD_SIZE

See Also:

Constant Field Values

FIELD_STATUS

public static final String FIELD_STATUS

See Also:

Constant Field Values

FIELD_JOB_TITLE

public static final String FIELD_JOB_TITLE

See Also:

Constant Field Values

FIELD_PHONE

public static final String FIELD_PHONE

See Also:

Constant Field Values

FIELD_ADDRESS

public static final String FIELD_ADDRESS

See Also:

Constant Field Values

FIELD_AVATAR_URL

public static final String FIELD_AVATAR_URL

See Also:

Constant Field Values

FIELD_EXEMPT_FROM_DEVICE_LIMITS

public static final String FIELD_EXEMPT_FROM_DEVICE_LIMITS

See Also:

Constant Field Values

FIELD_EXEMPT_FROM_LOGIN_VERIFICATION

public static final String FIELD_EXEMPT_FROM_LOGIN_VERIFICATION

See Also:

Constant Field Values

FIELD_MY_TAGS

public static final String FIELD_MY_TAGS

See Also:

Constant Field Values

Constructor Detail

BoxUser

public BoxUser()

Constructor.

BoxUser

public BoxUser(BoxUser obj)

Copy constructor, this does deep copy for all the fields.

Parameters:

obj -

BoxUser

public BoxUser(Map<String,Object> map)

Instantiate the object from a map. Each entry in the map reflects to a field.

Parameters:

map -

Method Detail

getName

public String getName()

Get name of this user.

Returns:

name

getLogin

public String getLogin()

Get the email address this user uses to login

Returns:

login

getRole

public String getRole()

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

Returns:

the role

getLanguage

public String getLanguage()

Get the language of this user. This uses ISO 639-1 Language Code

Returns:

the language

getSpaceAmount

public Double getSpaceAmount()

Get the user's total available space amount in bytes.

Returns:

the space_amount

getSpaceUsed

public Double getSpaceUsed()

Get the amount of space in use by the user.

Returns:

the space_used

getMaxUploadSize

public Double getMaxUploadSize()

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

Returns:

the max_upload_size

getTrackingCodes

public Map<String,String> getTrackingCodes()

Get the tracking codes. This is an array of key/value pairs set by the user's admin.

Returns:

the tracking_codes

canSeeManagedUsers

public Boolean canSeeManagedUsers()

Whether or not the user can see other enterprise users in the contact list.

Returns:

the can_see_managed_users

isSyncEnabled

public Boolean isSyncEnabled()

Whether or not this user can use Box Sync.

Returns:

the is_sync_enabled

getStatus

public String getStatus()

Get status of the user. This String can be STATUS_ACTIVE or STATUS_INACTIVE

Returns:

the status

getJobTitle

public String getJobTitle()

Get the user's job title.

Returns:

the job_title

getPhone

public String getPhone()

Get the user's phone number.

Returns:

the phone

getAddress

public String getAddress()

Get the user's address.

Returns:

the address

getAvatarUrl

public String getAvatarUrl()

get the URL for this user's avatar image.

Returns:

the avatar_url

isExemptFromDeviceLimits

public Boolean isExemptFromDeviceLimits()

Whether to exempt this user from Enterprise device limits.

Returns:

the is_exempt_from_device_limits

isExemptFromLoginVerification

public Boolean isExemptFromLoginVerification()

Whether or not this user must use two-factor authentication.

Returns:

the is_exempt_from_login_verification

getEnterprise

public BoxEnterprise getEnterprise()

Get the enterprise this user belongs to if available, null otherwise.

Returns:

enterprise

getMyTags

public String[] getMyTags()

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

Returns:

tags