com.box.boxjavalibv2.requests.requestobjects

Class BoxCollabRequestObject

java.lang.Object

com.box.boxjavalibv2.requests.requestobjects.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxCollabRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxCollabRequestObject
extends BoxDefaultRequestObject

Entity for adding collaboration request.

Method Summary

Methods

Modifier and Type	Method and Description
static BoxCollabRequestObject	createCollaborationObject(String folderId, String userId, String login, String role) Create an request object used to do create Collaboration request.
MapJSONStringEntity	getAccessible_by()
static BoxCollabRequestObject	getAllCollaborationsRequestObject(String status) Create an request object used to make get all collaborations request.
MapJSONStringEntity	getItem()
String	getRole()
String	getStatus()
BoxCollabRequestObject	setStatus(String status)
static BoxCollabRequestObject	updateCollaborationObject(String role) Create an v used to make update collaboration request.

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

createCollaborationObject

public static BoxCollabRequestObject createCollaborationObject(String folderId,
                                               String userId,
                                               String login,
                                               String role)

Create an request object used to do create Collaboration request.

Parameters:

folderId - id of the folder

userId - id of the user to collaborate, this is optional, if you don't want to supply a user id, use null.

login - login email of the collaborator(Can be non-box email.)

role - role/access level of this collaboration(This is a String defined in com.box.boxjavalibv2.dao.CollaborationRole

Returns:

BoxCollabRequestObject

updateCollaborationObject

public static BoxCollabRequestObject updateCollaborationObject(String role)

Create an v used to make update collaboration request.

Parameters:

role - role/access level of this collaboration(This is a String defined in com.box.boxjavalibv2.dao.CollaborationRole

Returns:

BoxCollabRequestObject

getAllCollaborationsRequestObject

public static BoxCollabRequestObject getAllCollaborationsRequestObject(String status)

Create an request object used to make get all collaborations request.

Parameters:

status - status of the collaborations requested( This field is required and currently only support com.box.boxjavalibv2.dao.BoxCollaboration.STATUS_PENDING

Returns:

BoxCollabRequestObject

getItem

public MapJSONStringEntity getItem()

Returns:

the item

getAccessible_by

public MapJSONStringEntity getAccessible_by()

Returns:

the accessible_by

getRole

public String getRole()

Returns:

the role

getStatus

public String getStatus()

Returns:

the status, indicating whether this collaboration has been accepted.

setStatus

public BoxCollabRequestObject setStatus(String status)