com.box.boxjavalibv2.resourcemanagers

Interface IBoxUsersManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxUsersManagerImpl

public interface IBoxUsersManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxEmailAlias	addEmailAlias(java.lang.String userId, BoxEmailAliasRequestObject requestObject) Adds a new email alias to the given user's account.
BoxUser	createEnterpriseUser(BoxUserRequestObject requestObject) Used to provision a new user in an enterprise.
void	deleteEmailAlias(java.lang.String userId, java.lang.String emailId, BoxDefaultRequestObject requestObject) Removes an email alias from a user.
java.util.List<BoxUser>	getAllEnterpriseUser(BoxDefaultRequestObject requestObject, java.lang.String filterTerm) Get the list of all users for the Enterprise with their user_id, public_name, and login if the user is an enterprise admin.
BoxUser	getCurrentUser(BoxDefaultRequestObject requestObject) Get the current user's information.
java.util.List<BoxEmailAlias>	getEmailAliases(java.lang.String userId, BoxDefaultRequestObject requestObject) Retrieves all email aliases for this user.
BoxFolder	moveFolderToAnotherUser(java.lang.String userId, java.lang.String folderId, BoxSimpleUserRequestObject requestObject) Moves all of the content from within one user's folder into a new folder in another user's account.
BoxUser	updateUserInformaiton(java.lang.String userId, BoxUserRequestObject requestObject) Used to edit the settings and information about a user.
BoxUser	updateUserPrimaryLogin(java.lang.String userId, BoxUserUpdateLoginRequestObject requestObject) Used to convert one of the user's confirmed email aliases into the user's primary login.

Method Detail

getCurrentUser

BoxUser getCurrentUser(BoxDefaultRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Get the current user's information.

Parameters:

requestObject - request object

Returns:

current user

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getAllEnterpriseUser

java.util.List<BoxUser> getAllEnterpriseUser(BoxDefaultRequestObject requestObject,
                                           java.lang.String filterTerm)
                                             throws BoxRestException,
                                                    BoxServerException,
                                                    AuthFatalFailureException

Get the list of all users for the Enterprise with their user_id, public_name, and login if the user is an enterprise admin. If the user is not an admin, this request returns the current user's user_id, public_name, and login.

Parameters:

requestObject - request object

filterTerm - A string used to filter the results to only users starting with the filter_term in either the name or the login. Use null if don't want filter.

Returns:

collection of users

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

moveFolderToAnotherUser

BoxFolder moveFolderToAnotherUser(java.lang.String userId,
                                java.lang.String folderId,
                                BoxSimpleUserRequestObject requestObject)
                                  throws BoxRestException,
                                         BoxServerException,
                                         AuthFatalFailureException

Moves all of the content from within one user's folder into a new folder in another user's account. You can move folders across users as long as the you have administrative permissions. To move everything from the root folder, use 0 which always represents the root folder of a Box account

Parameters:

userId - id of the user

folderId - id of the folder to be removed

requestObject - request object

Returns:

the newly created destination folder

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

createEnterpriseUser

BoxUser createEnterpriseUser(BoxUserRequestObject requestObject)
                             throws BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Used to provision a new user in an enterprise. This method only works for enterprise admins.

Parameters:

requestObject - request object

Returns:

newly created user

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateUserInformaiton

BoxUser updateUserInformaiton(java.lang.String userId,
                            BoxUserRequestObject requestObject)
                              throws BoxRestException,
                                     BoxServerException,
                                     AuthFatalFailureException

Used to edit the settings and information about a user. This method only works for enterprise admins.

Parameters:

userId - id of the user.

requestObject - request object

Returns:

the updated user

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getEmailAliases

java.util.List<BoxEmailAlias> getEmailAliases(java.lang.String userId,
                                            BoxDefaultRequestObject requestObject)
                                              throws BoxServerException,
                                                     BoxRestException,
                                                     AuthFatalFailureException

Retrieves all email aliases for this user. The collection of email aliases does not include the primary login for the user

Parameters:

userId - id of user

requestObject - request object

Returns:

collection of email aliases

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

addEmailAlias

BoxEmailAlias addEmailAlias(java.lang.String userId,
                          BoxEmailAliasRequestObject requestObject)
                            throws BoxServerException,
                                   BoxRestException,
                                   AuthFatalFailureException

Adds a new email alias to the given user's account. This feature is currently only available to enterprise admins and the new email must be in a domain associated with the enterprise and can not be a publicly atainable domain (e.g. gmail.com).

Parameters:

userId - id of user

requestObject - request object

Returns:

the newly added email alias

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteEmailAlias

void deleteEmailAlias(java.lang.String userId,
                    java.lang.String emailId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Removes an email alias from a user.

Parameters:

userId - id of the user

emailId - id of the email alias to be removed

requestObject - request object

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateUserPrimaryLogin

BoxUser updateUserPrimaryLogin(java.lang.String userId,
                             BoxUserUpdateLoginRequestObject requestObject)
                               throws BoxRestException,
                                      BoxServerException,
                                      AuthFatalFailureException

Used to convert one of the user's confirmed email aliases into the user's primary login.

Parameters:

userId - id of the user

requestObject - request object

Returns:

the updated user object

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.