com.box.sdkgen.managers.usercollaborations

Class CreateCollaborationRequestBody

Object

NullableFieldTracker

SerializableObject

CreateCollaborationRequestBody

All Implemented Interfaces:

Serializable

public class CreateCollaborationRequestBody
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateCollaborationRequestBody.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected CreateCollaborationRequestBodyAccessibleByField	accessibleBy The user or group to give access to the item.
protected Boolean	canViewPath Determines if the invited users can see the entire parent path to the associated folder.
protected OffsetDateTime	expiresAt Set the expiration date for the collaboration.
protected Boolean	isAccessOnly If set to `true`, collaborators have access to shared items, but such items won't be visible in the All Files list.
protected CreateCollaborationRequestBodyItemField	item The item to attach the comment to.
protected EnumWrapper<CreateCollaborationRequestBodyRoleField>	role The level of access granted.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateCollaborationRequestBody(CreateCollaborationRequestBody.Builder builder)
	CreateCollaborationRequestBody(CreateCollaborationRequestBodyItemField item, CreateCollaborationRequestBodyAccessibleByField accessibleBy, CreateCollaborationRequestBodyRoleField role)
	CreateCollaborationRequestBody(CreateCollaborationRequestBodyItemField item, CreateCollaborationRequestBodyAccessibleByField accessibleBy, EnumWrapper<CreateCollaborationRequestBodyRoleField> role)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
CreateCollaborationRequestBodyAccessibleByField	getAccessibleBy()
Boolean	getCanViewPath()
OffsetDateTime	getExpiresAt()
Boolean	getIsAccessOnly()
CreateCollaborationRequestBodyItemField	getItem()
EnumWrapper<CreateCollaborationRequestBodyRoleField>	getRole()
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

item

protected final CreateCollaborationRequestBodyItemField item

The item to attach the comment to.

accessibleBy

protected final CreateCollaborationRequestBodyAccessibleByField accessibleBy

The user or group to give access to the item.

role

protected final EnumWrapper<CreateCollaborationRequestBodyRoleField> role

The level of access granted.

isAccessOnly

protected Boolean isAccessOnly

If set to `true`, collaborators have access to shared items, but such items won't be visible in the All Files list. Additionally, collaborators won't see the path to the root folder for the shared item.

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

expiresAt

protected OffsetDateTime expiresAt

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

Constructor Detail

CreateCollaborationRequestBody

public CreateCollaborationRequestBody(CreateCollaborationRequestBodyItemField item,
                                      CreateCollaborationRequestBodyAccessibleByField accessibleBy,
                                      CreateCollaborationRequestBodyRoleField role)

CreateCollaborationRequestBody

public CreateCollaborationRequestBody(CreateCollaborationRequestBodyItemField item,
                                      CreateCollaborationRequestBodyAccessibleByField accessibleBy,
                                      EnumWrapper<CreateCollaborationRequestBodyRoleField> role)

CreateCollaborationRequestBody

protected CreateCollaborationRequestBody(CreateCollaborationRequestBody.Builder builder)

Method Detail

getItem

public CreateCollaborationRequestBodyItemField getItem()

getAccessibleBy

public CreateCollaborationRequestBodyAccessibleByField getAccessibleBy()

getRole

public EnumWrapper<CreateCollaborationRequestBodyRoleField> getRole()

getIsAccessOnly

public Boolean getIsAccessOnly()

getCanViewPath

public Boolean getCanViewPath()

getExpiresAt

public OffsetDateTime getExpiresAt()

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