com.box.sdkgen.managers.files

Class GetFileByIdHeaders

Object

GetFileByIdHeaders

public class GetFileByIdHeaders
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetFileByIdHeaders.Builder

Field Summary

Fields

Modifier and Type	Field and Description
String	boxapi The URL, and optional password, for the shared link of this item.
Map<String,String>	extraHeaders Extra headers that will be included in the HTTP request.
String	ifNoneMatch Ensures an item is only returned if it has changed.
String	xRepHints A header required to request specific `representations` of a file.

Constructor Summary

Constructors

Modifier	Constructor and Description
	GetFileByIdHeaders()
protected	GetFileByIdHeaders(GetFileByIdHeaders.Builder builder)

Method Summary

Modifier and Type	Method and Description
String	getBoxapi()
Map<String,String>	getExtraHeaders()
String	getIfNoneMatch()
String	getXRepHints()

Methods inherited from class Object

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

Field Detail

ifNoneMatch

public String ifNoneMatch

Ensures an item is only returned if it has changed.

Pass in the item's last observed `etag` value into this header and the endpoint will fail with a `304 Not Modified` if the item has not changed since.

boxapi

public String boxapi

The URL, and optional password, for the shared link of this item.

This header can be used to access items that have not been explicitly shared with a user.

Use the format `shared_link=[link]` or if a password is required then use `shared_link=[link]&shared_link_password=[password]`.

This header can be used on the file or folder shared, as well as on any files or folders nested within the item.

xRepHints

public String xRepHints

A header required to request specific `representations` of a file. Use this in combination with the `fields` query parameter to request a specific file representation.

The general format for these representations is `X-Rep-Hints: [...]` where `[...]` is one or many hints in the format `[fileType?query]`.

For example, to request a `png` representation in `32x32` as well as `64x64` pixel dimensions provide the following hints.

`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`

Additionally, a `text` representation is available for all document file types in Box using the `[extracted_text]` representation.

`x-rep-hints: [extracted_text]`.

extraHeaders

public Map<String,String> extraHeaders

Extra headers that will be included in the HTTP request.

Constructor Detail

GetFileByIdHeaders

public GetFileByIdHeaders()

GetFileByIdHeaders

protected GetFileByIdHeaders(GetFileByIdHeaders.Builder builder)

Method Detail

getIfNoneMatch

public String getIfNoneMatch()

getBoxapi

public String getBoxapi()

getXRepHints

public String getXRepHints()

getExtraHeaders

public Map<String,String> getExtraHeaders()