com.box.boxjavalibv2.requests.requestobjects

Class BoxRequestExtras

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxRequestExtras

public class BoxRequestExtras
extends Object

Constructor Summary

Constructors

Constructor and Description
BoxRequestExtras()

Method Summary

Methods

Modifier and Type	Method and Description
BoxRequestExtras	addField(String field) Add a field in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.
BoxRequestExtras	addFields(List<String> fields) Add fields in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.
BoxRequestExtras	addHeader(String key, String value) Add a header.
BoxRequestExtras	addQueryParam(String key, String value) Add a query parameter.
List<String>	getFields()
Map<String,String>	getHeaders()
Map<String,String>	getQueryParams()
BoxRequestExtras	setIfMatch(String etag) Set etag.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxRequestExtras

public BoxRequestExtras()

Method Detail

getFields

public List<String> getFields()

addField

public BoxRequestExtras addField(String field)

Add a field in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.

Parameters:

field - field to add. Currently supported fields are the Strings defined in com.box.boxjavalibv2.dao, for example: BoxCollaboration.FIELD_ROLE, BoxCollaboration.FIELD_CREATED_BY...

addFields

public BoxRequestExtras addFields(List<String> fields)

Add fields in the request, these fields (Please check "Fields" part in developer doc will end up as fields query parameter in the url.

Parameters:

fields - fields to add. Currently supported fields are the Strings defined in com.box.boxjavalibv2.dao, for example: BoxCollaboration.FIELD_ROLE, BoxCollaboration.FIELD_CREATED_BY...

addQueryParam

public BoxRequestExtras addQueryParam(String key,
                             String value)

Add a query parameter. Which eventually will go into url.

Parameters:

key - key

value - value

addHeader

public BoxRequestExtras addHeader(String key,
                         String value)

Add a header.

Parameters:

key - key

value - value

getHeaders

public Map<String,String> getHeaders()

getQueryParams

public Map<String,String> getQueryParams()

setIfMatch

public BoxRequestExtras setIfMatch(String etag)

Set etag.

Parameters:

etag - etag

Returns:

BoxFileRequestObject