com.box.sdk

Class BoxCollaboration.Info

Object

BoxJSONObject

BoxResource.Info

BoxCollaboration.Info

Enclosing class:

BoxCollaboration

public class BoxCollaboration.Info
extends BoxResource.Info

Contains information about a BoxCollaboration.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
BoxCollaborator.Info	getAccessibleBy() Gets the collaborator who this collaboration applies to.
Date	getAcknowledgedAt() Gets the time the collaboration's status was changed.
boolean	getCanViewPath() Gets a boolean indicator whether "view path collaboration" feature is enabled or not.
Date	getCreatedAt() Gets the time the collaboration was created.
BoxUser.Info	getCreatedBy() Gets the user who created the collaboration.
Date	getExpiresAt() Gets the time the collaboration will expire.
String	getInviteEmail() The email address used to invite an un-registered collaborator, if they are not a registered user.
boolean	getIsAccessOnly() Gets a boolean indicator weather "is access only" feature is enabled or not.
BoxItem.Info	getItem() Gets the folder the collaboration is related to.
Date	getModifiedAt() Gets the time the collaboration was last modified.
BoxCollaboration	getResource() Gets the resource associated with this Info.
BoxCollaboration.Role	getRole() Gets the level of access the collaborator has.
BoxCollaboration.Status	getStatus() Gets the status of the collaboration.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	setCanViewPath(boolean canViewState) Sets the permission for "view path collaboration" feature.
void	setExpiresAt(Date expiresAt) Set the time the collaboration will expire.
void	setRole(BoxCollaboration.Role role) Sets the level of access the collaborator has.
void	setStatus(BoxCollaboration.Status status) Sets the status of the collaboration in order to accept or reject the collaboration if it's pending.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getCreatedBy

public BoxUser.Info getCreatedBy()

Gets the user who created the collaboration.

Returns:

the user who created the collaboration.

getCreatedAt

public Date getCreatedAt()

Gets the time the collaboration was created.

Returns:

the time the collaboration was created.

getModifiedAt

public Date getModifiedAt()

Gets the time the collaboration was last modified.

Returns:

the time the collaboration was last modified.

getExpiresAt

public Date getExpiresAt()

Gets the time the collaboration will expire.

Returns:

the time the collaboration will expire.

setExpiresAt

public void setExpiresAt(Date expiresAt)

Set the time the collaboration will expire.

Parameters:

expiresAt - the expiration date of the collaboration.

getCanViewPath

public boolean getCanViewPath()

Gets a boolean indicator whether "view path collaboration" feature is enabled or not. When set to true this allows the invitee to see the entire parent path to the item. It is important to note that this does not grant privileges in any parent folder.

Returns:

the Boolean value indicating if "view path collaboration" is enabled or not

setCanViewPath

public void setCanViewPath(boolean canViewState)

Sets the permission for "view path collaboration" feature. When set to true this allows the invitee to to see the entire parent path to the item

Parameters:

canViewState - the boolean value indicating whether the invitee can see the parent folder.

getIsAccessOnly

public boolean getIsAccessOnly()

Gets a boolean indicator weather "is access only" feature is enabled or not. This field is read only. It is used to indicate whether a collaboration is an Access Only Collaboration (AOC). When set to true, it separates access from interest by hiding collaborated items from the All Files page and the ALF stream. This means that users who have been granted access through AOCs will not see these items in their regular file view.

getInviteEmail

public String getInviteEmail()

The email address used to invite an un-registered collaborator, if they are not a registered user.

Returns:

the email for the un-registed collaborator.

getStatus

public BoxCollaboration.Status getStatus()

Gets the status of the collaboration.

Returns:

the status of the collaboration.

setStatus

public void setStatus(BoxCollaboration.Status status)

Sets the status of the collaboration in order to accept or reject the collaboration if it's pending.

Parameters:

status - the new status of the collaboration.

getAccessibleBy

public BoxCollaborator.Info getAccessibleBy()

Gets the collaborator who this collaboration applies to.

Returns:

the collaborator who this collaboration applies to.

getRole

public BoxCollaboration.Role getRole()

Gets the level of access the collaborator has.

Returns:

the level of access the collaborator has.

setRole

public void setRole(BoxCollaboration.Role role)

Sets the level of access the collaborator has.

Parameters:

role - the new level of access to give the collaborator.

getAcknowledgedAt

public Date getAcknowledgedAt()

Gets the time the collaboration's status was changed.

Returns:

the time the collaboration's status was changed.

getItem

public BoxItem.Info getItem()

Gets the folder the collaboration is related to.

Returns:

the folder the collaboration is related to.

getResource

public BoxCollaboration getResource()

Description copied from class: BoxResource.Info

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJSONObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.