com.box.restclientv2.requestsbase

Class BoxDefaultRequestObject

java.lang.Object

com.box.restclientv2.requestsbase.BoxDefaultRequestObject

All Implemented Interfaces:

IBoxRequestObject

Direct Known Subclasses:

BoxCollabRequestObject, BoxCommentRequestObject, BoxEmailAliasRequestObject, BoxEventRequestObject, BoxFileUploadRequestObject, BoxFolderDeleteRequestObject, BoxGetAllCollabsRequestObject, BoxGroupMembershipRequestObject, BoxGroupRequestObject, BoxImageRequestObject, BoxItemCopyRequestObject, BoxItemRestoreRequestObject, BoxOAuthRequestObject, BoxPagingRequestObject, BoxSharedLinkRequestObject, BoxSimpleUserRequestObject, BoxUserUpdateLoginRequestObject

public class BoxDefaultRequestObject
extends Object
implements IBoxRequestObject

A request object with entity and fields.

Constructor Summary

Constructors

Constructor and Description
BoxDefaultRequestObject()

Method Summary

Methods

Modifier and Type	Method and Description
Object	getFromEntity(String key) Get value from entity.
protected MapJSONStringEntity	getJSONEntity()
BoxRequestExtras	getRequestExtras() a mutator to the request.
Object	put(String key, Object value) Add a key value pair to the request body.
BoxDefaultRequestObject	setPage(int limit, int offset)

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxDefaultRequestObject

public BoxDefaultRequestObject()

Method Detail

getJSONEntity

protected MapJSONStringEntity getJSONEntity()

put

public Object put(String key,
         Object value)

Add a key value pair to the request body. Not recommended to use. If possible, use provided setters.

Parameters:

key - key

value - value

getFromEntity

public Object getFromEntity(String key)

Get value from entity.

setPage

public BoxDefaultRequestObject setPage(int limit,
                              int offset)

Parameters:

limit - the number of items to return. default is 100, max is 1000.

offset - the item at which to begin the response, default is 0.

Returns:

BoxDefaultRequestObject

getRequestExtras

public BoxRequestExtras getRequestExtras()

a mutator to the request. This allows you to add any extra header, query params into the request. Use with caution because we don't block anything you set here. e.g., getRequestExtras().addHeader("key", "value");