com.box.sdk

Class BoxUser

Object

BoxResource

BoxCollaborator

BoxUser

public class BoxUser
extends BoxCollaborator

Represents a Box user account.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxUser.Info Contains information about a BoxUser.
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.

Constructor Summary

Constructors

Constructor and Description
BoxUser(BoxAPIConnection api, String id) Constructs a BoxUser for a user with a given ID.

Method Summary

Methods

Modifier and Type	Method and Description
static BoxUser	getCurrentUser(BoxAPIConnection api) Gets the current user.
BoxUser.Info	getInfo() Gets information about this user.

Methods inherited from class BoxResource

equals, getAPI, getID, hashCode

Methods inherited from class Object

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

Constructor Detail

BoxUser

public BoxUser(BoxAPIConnection api,
       String id)

Constructs a BoxUser for a user with a given ID.

Parameters:

api - the API connection to be used by the user.

id - the ID of the user.

Method Detail

getCurrentUser

public static BoxUser getCurrentUser(BoxAPIConnection api)

Gets the current user.

Parameters:

api - the API connection of the current user.

Returns:

the current user.

getInfo

public BoxUser.Info getInfo()

Gets information about this user.

Returns:

info about this user.