com.box.boxjavalibv2.requests.requestobjects

Class BoxCollabRequestObject

java.lang.Object

com.box.restclientv2.requestsbase.BoxDefaultRequestObject

com.box.boxjavalibv2.requests.requestobjects.BoxCollabRequestObject

All Implemented Interfaces:

IBoxRequestObject

public class BoxCollabRequestObject
extends BoxDefaultRequestObject

Method Summary

Methods

Modifier and Type	Method and Description
static BoxCollabRequestObject	createCollabObject(java.lang.String folderId, java.lang.String userId, java.lang.String login, java.lang.String role) create a collaboration.
static BoxCollabRequestObject	createGroupCollabObject(java.lang.String folderId, java.lang.String groupId, java.lang.String role) Create a collaboration for a group
java.lang.String	getRole() Get the role.
BoxCollabRequestObject	setAccessibleBy(java.lang.String userId, java.lang.String login)
BoxCollabRequestObject	setAccessibleByType(java.lang.String id, java.lang.String type)
BoxCollabRequestObject	setRole(java.lang.String role) Set the role.
BoxCollabRequestObject	setStatus(java.lang.String status)
static BoxCollabRequestObject	updateCollabObjects(java.lang.String role) update a collaboration.

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

createGroupCollabObject

public static BoxCollabRequestObject createGroupCollabObject(java.lang.String folderId,
                                             java.lang.String groupId,
                                             java.lang.String role)

Create a collaboration for a group

Parameters:

folderId - - id of the folder

groupId - - id of the group to collaborate with.

role - - role/access level of this collaboration(This is a String defined in BoxCollaborationRole

Returns:

BoxCollabRequestObject

createCollabObject

public static BoxCollabRequestObject createCollabObject(java.lang.String folderId,
                                        java.lang.String userId,
                                        java.lang.String login,
                                        java.lang.String role)

create a collaboration.

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 BoxCollaborationRole

Returns:

BoxCollabRequestEntity

setAccessibleBy

public BoxCollabRequestObject setAccessibleBy(java.lang.String userId,
                                     java.lang.String login)

Parameters:

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.)

setAccessibleByType

public BoxCollabRequestObject setAccessibleByType(java.lang.String id,
                                         java.lang.String type)

Parameters:

id - - id of the user/group

type - - type of accessibility.

Returns:

updateCollabObjects

public static BoxCollabRequestObject updateCollabObjects(java.lang.String role)

update a collaboration.

Parameters:

role - role/access level of this collaboration(This is a String defined in BoxCollaborationRole.

Returns:

setRole

public BoxCollabRequestObject setRole(java.lang.String role)

Set the role.

getRole

public java.lang.String getRole()

Get the role.

setStatus

public BoxCollabRequestObject setStatus(java.lang.String status)