com.box.boxjavalibv2.requests.requestobjects

Class BoxSharedLinkRequestObject

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxSharedLinkRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxSharedLinkRequestObject
extends BoxDefaultRequestObject

Entity for shared link.

Method Summary

Methods

Modifier and Type	Method and Description
static BoxSharedLinkRequestObject	createSharedLinkRequestObject(String accessLevel) SharedLinkRequestObject for create sharedlink request.
String	getAccess() Get access String.
BoxSharedLinkPermissions	getPermissions() Get permissions.
Date	getUnshared_at() Get the time to unshare the link.
BoxSharedLinkRequestObject	setAccess(String accessLevel) Set access String.
BoxSharedLinkRequestObject	setPermissions(BoxSharedLinkPermissions permissionsEntity) Set permissions.
BoxSharedLinkRequestObject	setUnshared_at(Date unsharedAt) Set the time to unshare the link.

Methods inherited from class com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

addField, addFields, addHeader, addQueryParam, get, getEntity, getFields, getHeaders, getJSONEntity, getJSONParser, getQueryParams, put, put, put, setJSONParser, setPage

Methods inherited from class java.lang.Object

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

Method Detail

createSharedLinkRequestObject

public static BoxSharedLinkRequestObject createSharedLinkRequestObject(String accessLevel)

SharedLinkRequestObject for create sharedlink request.

Parameters:

accessLevel - access(String can be the strings defined in BoxSharedLinkAccess.)

Returns:

SharedLinkRequestObject

getAccess

public String getAccess()

Get access String.

Returns:

access

setAccess

public BoxSharedLinkRequestObject setAccess(String accessLevel)

Set access String. This defines who has access to the link. String can be the strings defined in BoxSharedLinkAccess.

Parameters:

accessLevel - access

Returns:

getUnshared_at

public Date getUnshared_at()
                    throws ParseException

Get the time to unshare the link. This returns a String and can be parsed into Date by ISO8601DateParser

Returns:

time to unshare the link

Throws:

ParseException

setUnshared_at

public BoxSharedLinkRequestObject setUnshared_at(Date unsharedAt)

Set the time to unshare the link. This String is an ISO8601 time String and can be generated from Date by ISO8601DateParser

Parameters:

unsharedAt - time to unshare the link

Returns:

getPermissions

public BoxSharedLinkPermissions getPermissions()

Get permissions.

Returns:

permissions

setPermissions

public BoxSharedLinkRequestObject setPermissions(BoxSharedLinkPermissions permissionsEntity)

Set permissions.

Parameters:

permissionsEntity - permissions

Returns: