public final class BoxUsersManager extends BoxResourceManager
| Constructor and Description |
|---|
BoxUsersManager(IBoxConfig config,
IBoxResourceHub resourceHub,
IBoxJSONParser parser,
IBoxRequestAuth auth,
IBoxRESTClient restClient)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
BoxEmailAlias |
addEmailAlias(String userId,
BoxUserRequestObject 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(String userId,
String emailId,
BoxDefaultRequestObject requestObject)
Removes an email alias from a user.
|
List<BoxUser> |
getAllEnterpriseUser(BoxDefaultRequestObject requestObject,
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.
|
static List<BoxEmailAlias> |
getEmailAliases(BoxCollection collection)
Get email aliases from a collection.
|
List<BoxEmailAlias> |
getEmailAliases(String userId,
BoxDefaultRequestObject requestObject)
Retrieves all email aliases for this user.
|
static List<BoxUser> |
getUsers(BoxCollection collection)
Get users from a collection.
|
BoxFolder |
moveFolderToAnotherUser(String userId,
String folderId,
BoxUserRequestObject requestObject)
Moves all of the content from within one user's folder into a new folder in another user's account.
|
BoxUser |
updateUserInformaiton(String userId,
BoxUserRequestObject requestObject)
Used to edit the settings and information about a user.
|
BoxUser |
updateUserPrimaryLogin(String userId,
BoxUserRequestObject requestObject)
Used to convert one of the user's confirmed email aliases into the user's primary login.
|
executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObjectpublic BoxUsersManager(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient)
config - ConfigresourceHub - IResourceHubparser - json parserauth - auth for api callsrestClient - REST client to make api calls.public BoxUser getCurrentUser(BoxDefaultRequestObject requestObject) throws BoxRestException, BoxServerException, AuthFatalFailureException
requestObject - request objectBoxRestException - exceptionBoxServerException - exceptionAuthFatalFailureException - exceptionpublic List<BoxUser> getAllEnterpriseUser(BoxDefaultRequestObject requestObject, String filterTerm) throws BoxRestException, BoxServerException, AuthFatalFailureException
requestObject - request objectfilterTerm - 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.BoxRestException - exceptionBoxServerException - exceptionAuthFatalFailureException - exceptionpublic BoxFolder moveFolderToAnotherUser(String userId, String folderId, BoxUserRequestObject requestObject) throws BoxRestException, BoxServerException, AuthFatalFailureException
userId - id of the userfolderId - id of the folder to be removedrequestObject - request objectBoxRestException - exceptionBoxServerException - exceptionAuthFatalFailureException - exceptionpublic BoxUser createEnterpriseUser(BoxUserRequestObject requestObject) throws BoxRestException, BoxServerException, AuthFatalFailureException
requestObject - request objectBoxRestException - exceptionBoxServerException - exceptionAuthFatalFailureException - exceptionpublic BoxUser updateUserInformaiton(String userId, BoxUserRequestObject requestObject) throws BoxRestException, BoxServerException, AuthFatalFailureException
userId - id of the user.requestObject - request objectBoxRestException - exceptionBoxServerException - exceptionAuthFatalFailureException - exceptionpublic List<BoxEmailAlias> getEmailAliases(String userId, BoxDefaultRequestObject requestObject) throws BoxServerException, BoxRestException, AuthFatalFailureException
userId - id of userrequestObject - request objectBoxServerException - exceptionBoxRestException - exceptionAuthFatalFailureException - exceptionpublic BoxEmailAlias addEmailAlias(String userId, BoxUserRequestObject requestObject) throws BoxServerException, BoxRestException, AuthFatalFailureException
userId - id of userrequestObject - request objectBoxServerException - exceptionBoxRestException - exceptionAuthFatalFailureException - exceptionpublic void deleteEmailAlias(String userId, String emailId, BoxDefaultRequestObject requestObject) throws BoxRestException, BoxServerException, AuthFatalFailureException
userId - id of the useremailId - id of the email alias to be removedrequestObject - request objectBoxRestException - exceptionBoxServerException - exceptionAuthFatalFailureException - exceptionpublic BoxUser updateUserPrimaryLogin(String userId, BoxUserRequestObject requestObject) throws BoxRestException, BoxServerException, AuthFatalFailureException
userId - id of the userrequestObject - request objectBoxRestException - exceptionBoxServerException - exceptionAuthFatalFailureException - exceptionpublic static List<BoxUser> getUsers(BoxCollection collection)
collection - collectionpublic static List<BoxEmailAlias> getEmailAliases(BoxCollection collection)
collection - collectionCopyright © 2014. All Rights Reserved.