com.box.androidsdk.content

Class BoxApiUser

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiUser

public class BoxApiUser
extends BoxApi

Represents the API of the User endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

Fields inherited from class com.box.androidsdk.content.BoxApi

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiUser(BoxSession session) Constructs a BoxApiUser with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAvatarDownloadUrl(java.lang.String id) Gets the URL for downloading the avatar of a user
BoxRequestsUser.CreateEnterpriseUser	getCreateEnterpriseUserRequest(java.lang.String login, java.lang.String name) Gets a request that creates an enterprise user The session provided must be associated with an enterprise admin user
BoxRequestsUser.GetUserInfo	getCurrentUserInfoRequest() Gets a request that gets information about the current user
BoxRequestsUser.DeleteEnterpriseUser	getDeleteEnterpriseUserRequest(java.lang.String userId) Gets a request that deletes an enterprise user The session provided must be associated with an enterprise admin user
BoxRequestsFile.DownloadAvatar	getDownloadAvatarRequest(java.io.File target, java.lang.String userId) Gets a request that downloads an avatar of the target user id.
BoxRequestsFile.DownloadFile	getDownloadAvatarRequest(java.io.OutputStream outputStream, java.lang.String userId) Gets a request that downloads the given avatar to the provided outputStream.
BoxRequestsUser.GetEnterpriseUsers	getEnterpriseUsersRequest() Gets a request that gets all the users of an enterprise The session provided must be associated with an enterprise admin user
BoxRequestsUser.GetUserInfo	getUserInfoRequest(java.lang.String id) Gets a request that gets information about a user
protected java.lang.String	getUserInformationUrl(java.lang.String id) Gets the URL for getting information of the current user
protected java.lang.String	getUsersUrl() Gets the URL for getting information of the current user

Methods inherited from class com.box.androidsdk.content.BoxApi

getBaseUploadUri, getBaseUri

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxApiUser

public BoxApiUser(BoxSession session)

Constructs a BoxApiUser with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiUser

Method Detail

getUsersUrl

protected java.lang.String getUsersUrl()

Gets the URL for getting information of the current user

Returns:

the URL string for getting information of the current user

getAvatarDownloadUrl

protected java.lang.String getAvatarDownloadUrl(java.lang.String id)

Gets the URL for downloading the avatar of a user

Parameters:

id - id of the user

Returns:

the avatar download URL

getUserInformationUrl

protected java.lang.String getUserInformationUrl(java.lang.String id)

Gets the URL for getting information of the current user

Parameters:

id - id of the user

Returns:

the URL string for getting information of the current user

getCurrentUserInfoRequest

public BoxRequestsUser.GetUserInfo getCurrentUserInfoRequest()

Gets a request that gets information about the current user

Returns:

request to get information about the current user

getUserInfoRequest

public BoxRequestsUser.GetUserInfo getUserInfoRequest(java.lang.String id)

Gets a request that gets information about a user

Parameters:

id - id of the user to get information on

Returns:

request to get information about a user

getEnterpriseUsersRequest

public BoxRequestsUser.GetEnterpriseUsers getEnterpriseUsersRequest()

Gets a request that gets all the users of an enterprise The session provided must be associated with an enterprise admin user

Returns:

request to get all users of an enterprise

getCreateEnterpriseUserRequest

public BoxRequestsUser.CreateEnterpriseUser getCreateEnterpriseUserRequest(java.lang.String login,
                                                                           java.lang.String name)

Gets a request that creates an enterprise user The session provided must be associated with an enterprise admin user

Parameters:

login - the login (email) of the user to create

name - name of the user to create

Returns:

request to create an enterprise user

getDeleteEnterpriseUserRequest

public BoxRequestsUser.DeleteEnterpriseUser getDeleteEnterpriseUserRequest(java.lang.String userId)

Gets a request that deletes an enterprise user The session provided must be associated with an enterprise admin user

Parameters:

userId - id of the user

Returns:

request to delete an enterprise user

getDownloadAvatarRequest

public BoxRequestsFile.DownloadAvatar getDownloadAvatarRequest(java.io.File target,
                                                               java.lang.String userId)
                                                        throws java.io.IOException

Gets a request that downloads an avatar of the target user id.

Parameters:

target - target file to download to, target can be either a directory or a file

userId - id of user to download avatar of

Returns:

request to download a thumbnail to a target file

Throws:

java.io.IOException - throws FileNotFoundException if target file does not exist.

getDownloadAvatarRequest

public BoxRequestsFile.DownloadFile getDownloadAvatarRequest(java.io.OutputStream outputStream,
                                                             java.lang.String userId)

Gets a request that downloads the given avatar to the provided outputStream. Developer is responsible for closing the outputStream provided.

Parameters:

outputStream - outputStream to write file contents to.

userId - the file id to download.

Returns:

request to download a file thumbnail