com.box.androidsdk.content.models

Class BoxUser

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxCollaborator

com.box.androidsdk.content.models.BoxUser

All Implemented Interfaces:

java.io.Serializable

public class BoxUser
extends BoxCollaborator

Class that represents a Box user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxUser.Role Enumerates the possible roles that a user can have within an enterprise.
static class	BoxUser.Status Enumerates the possible statuses that a user's account can have.

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxEntity

BoxEntity.BoxEntityCreator

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_FIELDS
static java.lang.String	FIELD_ADDRESS
static java.lang.String	FIELD_AVATAR_URL
static java.lang.String	FIELD_CAN_SEE_MANAGED_USERS
static java.lang.String	FIELD_ENTERPRISE
static java.lang.String	FIELD_HOSTNAME
static java.lang.String	FIELD_IS_EXEMPT_FROM_DEVICE_LIMITS
static java.lang.String	FIELD_IS_EXEMPT_FROM_LOGIN_VERIFICATION
static java.lang.String	FIELD_IS_EXTERNAL_COLLAB_RESTRICTED
static java.lang.String	FIELD_IS_SYNC_ENABLED
static java.lang.String	FIELD_JOB_TITLE
static java.lang.String	FIELD_LANGUAGE
static java.lang.String	FIELD_LOGIN
static java.lang.String	FIELD_MAX_UPLOAD_SIZE
static java.lang.String	FIELD_MY_TAGS
static java.lang.String	FIELD_PHONE
static java.lang.String	FIELD_ROLE
static java.lang.String	FIELD_SPACE_AMOUNT
static java.lang.String	FIELD_SPACE_USED
static java.lang.String	FIELD_STATUS
static java.lang.String	FIELD_TIMEZONE
static java.lang.String	FIELD_TRACKING_CODES
static java.lang.String	TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxCollaborator

FIELD_CREATED_AT, FIELD_MODIFIED_AT, FIELD_NAME

Fields inherited from class com.box.androidsdk.content.models.BoxEntity

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
BoxUser() Constructs an empty BoxUser object.
BoxUser(com.eclipsesource.json.JsonObject object) Constructs an empty BoxUser object.

Method Summary

Modifier and Type	Method and Description
static BoxUser	createFromId(java.lang.String userId) A convenience method to create an empty user with just the id and type fields set.
java.lang.String	getAddress() Gets the address of the user.
java.lang.String	getAvatarURL() Gets the URL of the user's avatar.
java.lang.Boolean	getCanSeeManagedUsers() Gets whether or not the user can see managed users.
BoxEnterprise	getEnterprise() Gets the users enterprise.
java.lang.String	getHostname() Gets the hostname associated with the user.
java.lang.Boolean	getIsExemptFromDeviceLimits() Gets whether or not the user is exempt from Enterprise device limits.
java.lang.Boolean	getIsExemptFromLoginVerification() Gets whether or not the user is exempt from two-factor authentication.
java.lang.Boolean	getIsExternalCollabRestricted() Gets whether or not external collaboration is restricted.
java.lang.Boolean	getIsSyncEnabled() Gets whether or not sync is enabled for the user.
java.lang.String	getJobTitle() Gets the job title of the user.
java.lang.String	getLanguage() Gets the language of the user.
java.lang.String	getLogin() Gets the email address the user uses to login.
java.lang.Long	getMaxUploadSize() Gets the maximum individual file size in bytes the user can have.
java.util.List<java.lang.String>	getMyTags() Gets the user's tags.
java.lang.String	getPhone() Gets the phone number of the user.
BoxUser.Role	getRole() Gets the user's enterprise role.
java.lang.Long	getSpaceAmount() Gets the user's total available space in bytes.
java.lang.Long	getSpaceUsed() Gets the amount of space the user has used in bytes.
BoxUser.Status	getStatus() Gets the user's current account status.
java.lang.String	getTimezone() Gets the timezone of the user.
java.util.List<java.lang.String>	getTrackingCodes() Gets a list of tracking codes for the user.

Methods inherited from class com.box.androidsdk.content.models.BoxCollaborator

getCreatedAt, getModifiedAt, getName

Methods inherited from class com.box.androidsdk.content.models.BoxEntity

addEntityType, createEntityFromJson, createEntityFromJson, getBoxJsonObjectCreator, getId, getType

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_LOGIN

public static final java.lang.String FIELD_LOGIN

See Also:

Constant Field Values

FIELD_ROLE

public static final java.lang.String FIELD_ROLE

See Also:

Constant Field Values

FIELD_LANGUAGE

public static final java.lang.String FIELD_LANGUAGE

See Also:

Constant Field Values

FIELD_TIMEZONE

public static final java.lang.String FIELD_TIMEZONE

See Also:

Constant Field Values

FIELD_SPACE_AMOUNT

public static final java.lang.String FIELD_SPACE_AMOUNT

See Also:

Constant Field Values

FIELD_SPACE_USED

public static final java.lang.String FIELD_SPACE_USED

See Also:

Constant Field Values

FIELD_MAX_UPLOAD_SIZE

public static final java.lang.String FIELD_MAX_UPLOAD_SIZE

See Also:

Constant Field Values

FIELD_STATUS

public static final java.lang.String FIELD_STATUS

See Also:

Constant Field Values

FIELD_JOB_TITLE

public static final java.lang.String FIELD_JOB_TITLE

See Also:

Constant Field Values

FIELD_PHONE

public static final java.lang.String FIELD_PHONE

See Also:

Constant Field Values

FIELD_ADDRESS

public static final java.lang.String FIELD_ADDRESS

See Also:

Constant Field Values

FIELD_AVATAR_URL

public static final java.lang.String FIELD_AVATAR_URL

See Also:

Constant Field Values

FIELD_TRACKING_CODES

public static final java.lang.String FIELD_TRACKING_CODES

See Also:

Constant Field Values

FIELD_CAN_SEE_MANAGED_USERS

public static final java.lang.String FIELD_CAN_SEE_MANAGED_USERS

See Also:

Constant Field Values

FIELD_IS_SYNC_ENABLED

public static final java.lang.String FIELD_IS_SYNC_ENABLED

See Also:

Constant Field Values

FIELD_IS_EXTERNAL_COLLAB_RESTRICTED

public static final java.lang.String FIELD_IS_EXTERNAL_COLLAB_RESTRICTED

See Also:

Constant Field Values

FIELD_IS_EXEMPT_FROM_DEVICE_LIMITS

public static final java.lang.String FIELD_IS_EXEMPT_FROM_DEVICE_LIMITS

See Also:

Constant Field Values

FIELD_IS_EXEMPT_FROM_LOGIN_VERIFICATION

public static final java.lang.String FIELD_IS_EXEMPT_FROM_LOGIN_VERIFICATION

See Also:

Constant Field Values

FIELD_ENTERPRISE

public static final java.lang.String FIELD_ENTERPRISE

See Also:

Constant Field Values

FIELD_HOSTNAME

public static final java.lang.String FIELD_HOSTNAME

See Also:

Constant Field Values

FIELD_MY_TAGS

public static final java.lang.String FIELD_MY_TAGS

See Also:

Constant Field Values

ALL_FIELDS

public static final java.lang.String[] ALL_FIELDS

Constructor Detail

BoxUser

public BoxUser()

Constructs an empty BoxUser object.

BoxUser

public BoxUser(com.eclipsesource.json.JsonObject object)

Constructs an empty BoxUser object.

Parameters:

object - jsonObject to use to create an instance of this class.

Method Detail

createFromId

public static BoxUser createFromId(java.lang.String userId)

A convenience method to create an empty user with just the id and type fields set. This allows the ability to interact with the content sdk in a more descriptive and type safe manner

Parameters:

userId - the id of user to create

Returns:

an empty BoxUser object that only contains id and type information

getLogin

public java.lang.String getLogin()

Gets the email address the user uses to login.

Returns:

the email address the user uses to login.

getRole

public BoxUser.Role getRole()

Gets the user's enterprise role.

Returns:

the user's enterprise role.

getLanguage

public java.lang.String getLanguage()

Gets the language of the user.

Returns:

the language of the user.

getTimezone

public java.lang.String getTimezone()

Gets the timezone of the user.

Returns:

the timezone of the user.

getSpaceAmount

public java.lang.Long getSpaceAmount()

Gets the user's total available space in bytes.

Returns:

the user's total available space in bytes.

getSpaceUsed

public java.lang.Long getSpaceUsed()

Gets the amount of space the user has used in bytes.

Returns:

the amount of space the user has used in bytes.

getMaxUploadSize

public java.lang.Long getMaxUploadSize()

Gets the maximum individual file size in bytes the user can have.

Returns:

the maximum individual file size in bytes the user can have.

getStatus

public BoxUser.Status getStatus()

Gets the user's current account status.

Returns:

the user's current account status.

getJobTitle

public java.lang.String getJobTitle()

Gets the job title of the user.

Returns:

the job title of the user.

getPhone

public java.lang.String getPhone()

Gets the phone number of the user.

Returns:

the phone number of the user.

getAddress

public java.lang.String getAddress()

Gets the address of the user.

Returns:

the address of the user.

getAvatarURL

public java.lang.String getAvatarURL()

Gets the URL of the user's avatar.

Returns:

the URL of the user's avatar.

getTrackingCodes

public java.util.List<java.lang.String> getTrackingCodes()

Gets a list of tracking codes for the user.

Returns:

list of tracking codes.

getCanSeeManagedUsers

public java.lang.Boolean getCanSeeManagedUsers()

Gets whether or not the user can see managed users.

Returns:

whether the user can see managed users.

getIsSyncEnabled

public java.lang.Boolean getIsSyncEnabled()

Gets whether or not sync is enabled for the user.

Returns:

whether sync is enabled.

getIsExternalCollabRestricted

public java.lang.Boolean getIsExternalCollabRestricted()

Gets whether or not external collaboration is restricted.

Returns:

if external collaboration is restricted.

getIsExemptFromDeviceLimits

public java.lang.Boolean getIsExemptFromDeviceLimits()

Gets whether or not the user is exempt from Enterprise device limits.

Returns:

whether or not the user is exempt from Enterprise device limits.

getIsExemptFromLoginVerification

public java.lang.Boolean getIsExemptFromLoginVerification()

Gets whether or not the user is exempt from two-factor authentication.

Returns:

whether or not the user is exempt from two-factor authentication.

getEnterprise

public BoxEnterprise getEnterprise()

Gets the users enterprise.

Returns:

the enterprise of the user.

getHostname

public java.lang.String getHostname()

Gets the hostname associated with the user.

Returns:

the user's hostname.

getMyTags

public java.util.List<java.lang.String> getMyTags()

Gets the user's tags.

Returns:

the user's tags.