com.box.sdkgen.managers.usercollaborations

Class UpdateCollaborationByIdRequestBody

Object

NullableFieldTracker

SerializableObject

UpdateCollaborationByIdRequestBody

All Implemented Interfaces:

Serializable

public class UpdateCollaborationByIdRequestBody
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateCollaborationByIdRequestBody.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	canViewPath Determines if the invited users can see the entire parent path to the associated folder.
protected OffsetDateTime	expiresAt Update the expiration date for the collaboration.
protected EnumWrapper<UpdateCollaborationByIdRequestBodyRoleField>	role The level of access granted.
protected EnumWrapper<UpdateCollaborationByIdRequestBodyStatusField>	status Set the status of a `pending` collaboration invitation, effectively accepting, or rejecting the invite.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getCanViewPath()
OffsetDateTime	getExpiresAt()
EnumWrapper<UpdateCollaborationByIdRequestBodyRoleField>	getRole()
EnumWrapper<UpdateCollaborationByIdRequestBodyStatusField>	getStatus()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

role

protected EnumWrapper<UpdateCollaborationByIdRequestBodyRoleField> role

The level of access granted.

status

protected EnumWrapper<UpdateCollaborationByIdRequestBodyStatusField> status

Set the status of a `pending` collaboration invitation, effectively accepting, or rejecting the invite.

expiresAt

protected OffsetDateTime expiresAt

Update the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item.

This feature will only work if the **Automatically remove invited collaborators: Allow folder owners to extend the expiry date** setting has been enabled in the **Enterprise Settings** of the **Admin Console**. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error.

Additionally, a collaboration can only be given an expiration if it was created after the **Automatically remove invited collaborator** setting was enabled.

canViewPath

protected Boolean canViewPath

Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on.

Be aware that this meaningfully increases the time required to load the invitee's **All Files** page. We recommend you limit the number of collaborations with `can_view_path` enabled to 1,000 per user.

Only an owner or co-owners can invite collaborators with a `can_view_path` of `true`. Only an owner can update `can_view_path` on existing collaborations.

`can_view_path` can only be used for folder collaborations.

When you delete a folder with `can_view_path=true`, collaborators may still see the parent path. For instructions on how to remove this, see [Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed).

Constructor Detail

UpdateCollaborationByIdRequestBody

public UpdateCollaborationByIdRequestBody()

UpdateCollaborationByIdRequestBody

protected UpdateCollaborationByIdRequestBody(UpdateCollaborationByIdRequestBody.Builder builder)

Method Detail

getRole

public EnumWrapper<UpdateCollaborationByIdRequestBodyRoleField> getRole()

getStatus

public EnumWrapper<UpdateCollaborationByIdRequestBodyStatusField> getStatus()

getExpiresAt

public OffsetDateTime getExpiresAt()

getCanViewPath

public Boolean getCanViewPath()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object