com.box.boxjavalibv2.requests.requestobjects

Class BoxImageRequestObject

java.lang.Object

com.box.restclientv2.requestsbase.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxImageRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxImageRequestObject
extends BoxDefaultRequestObject

Method Summary

Methods

Modifier and Type	Method and Description
static BoxImageRequestObject	pagePreviewRequestObject(int page, int minWidth, int maxWidth, int minHeight, int maxHeight) Get BoxImageRequestObject for a preview request with pages.
static BoxImageRequestObject	previewRequestObject() Get BoxImageRequestObject for an image or preview request without pages.
BoxImageRequestObject	setMaxHeight(int maxHeight)
BoxImageRequestObject	setMaxWidth(int maxWidth)
BoxImageRequestObject	setMinHeight(int minHeight)
BoxImageRequestObject	setMinWidth(int minWidth)
BoxImageRequestObject	setPage(int page)

Methods inherited from class com.box.restclientv2.requestsbase.BoxDefaultRequestObject

getFromEntity, getJSONEntity, getRequestExtras, put, setPage

Methods inherited from class java.lang.Object

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

Method Detail

pagePreviewRequestObject

public static BoxImageRequestObject pagePreviewRequestObject(int page,
                                             int minWidth,
                                             int maxWidth,
                                             int minHeight,
                                             int maxHeight)

Get BoxImageRequestObject for a preview request with pages.

Parameters:

page - requested preview page number(For example, 2 if you want to get the 2nd page of the preview if the preview has multiple pages.)

minWidth - minimum width of the preview image requested

maxWidth - maximum width of the preview image requested

minHeight - minimum height of the preview image requested

maxHeight - maximum height of the preview image requested

Returns:

BoxPreviewRequestObject

previewRequestObject

public static BoxImageRequestObject previewRequestObject()

Get BoxImageRequestObject for an image or preview request without pages.

Returns:

BoxPreviewRequestObject

setMinWidth

public BoxImageRequestObject setMinWidth(int minWidth)

setMaxWidth

public BoxImageRequestObject setMaxWidth(int maxWidth)

setMinHeight

public BoxImageRequestObject setMinHeight(int minHeight)

setMaxHeight

public BoxImageRequestObject setMaxHeight(int maxHeight)

setPage

public BoxImageRequestObject setPage(int page)