com.box.androidsdk.content.requests

Class BoxRequestsUser.DeleteEnterpriseUser

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxVoid,BoxRequestsUser.DeleteEnterpriseUser>

com.box.androidsdk.content.requests.BoxRequestsUser.DeleteEnterpriseUser

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsUser

public static class BoxRequestsUser.DeleteEnterpriseUser
extends BoxRequest<BoxVoid,BoxRequestsUser.DeleteEnterpriseUser>

Request for deleting an enterprise user

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods, BoxRequest.TLSSSLSocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mId
protected static java.lang.String	QUERY_FORCE
protected static java.lang.String	QUERY_NOTIFY

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
DeleteEnterpriseUser(java.lang.String requestUrl, BoxSession session, java.lang.String userId) Creates an update user information request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Gets the id of the user to delete
java.lang.Boolean	getShouldForce() Gets whether or not the user should be deleted even if this user still owns files
java.lang.Boolean	getShouldNotify() Gets whether the destination user should receive email notification of the delete.
BoxRequestsUser.DeleteEnterpriseUser	setShouldForce(java.lang.Boolean shouldForce) Sets whether or not the user should be deleted even if this user still owns files
BoxRequestsUser.DeleteEnterpriseUser	setShouldNotify(java.lang.Boolean shouldNotify) Sets whether or not the destination user should receive email notification of the delete.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, onSendCompleted, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_NOTIFY

protected static final java.lang.String QUERY_NOTIFY

See Also:

Constant Field Values

QUERY_FORCE

protected static final java.lang.String QUERY_FORCE

See Also:

Constant Field Values

mId

protected java.lang.String mId

Constructor Detail

DeleteEnterpriseUser

public DeleteEnterpriseUser(java.lang.String requestUrl,
                            BoxSession session,
                            java.lang.String userId)

Creates an update user information request with the default parameters

Parameters:

requestUrl - URL of the update user information endpoint

session - the authenticated session that will be used to make the request with

userId - the userId to delete

Method Detail

getId

public java.lang.String getId()

Gets the id of the user to delete

Returns:

id of the user to delete

getShouldNotify

public java.lang.Boolean getShouldNotify()

Gets whether the destination user should receive email notification of the delete.

Returns:

whether or not the user should be notified

setShouldNotify

public BoxRequestsUser.DeleteEnterpriseUser setShouldNotify(java.lang.Boolean shouldNotify)

Sets whether or not the destination user should receive email notification of the delete.

Parameters:

shouldNotify - whether or not the user should receive an email notification

Returns:

the delete enterprise user request

getShouldForce

public java.lang.Boolean getShouldForce()

Gets whether or not the user should be deleted even if this user still owns files

Returns:

whether or not the user should be deleted even if this user still owns files

setShouldForce

public BoxRequestsUser.DeleteEnterpriseUser setShouldForce(java.lang.Boolean shouldForce)

Sets whether or not the user should be deleted even if this user still owns files

Parameters:

shouldForce - whether or not the user should be deleted even if this user still owns files

Returns:

the delete enterprise user request