Collaboration (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - Collaboration

All Implemented Interfaces:

Serializable
```
public class Collaboration
extends SerializableObject
```
Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or group access to a file or folder with permissions defined by a specific role.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Collaboration.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Collaboration.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected CollaborationAcceptanceRequirementsStatusField`	`acceptanceRequirementsStatus`
`protected CollaborationAccessGrantee`	`accessibleBy`
`protected OffsetDateTime`	`acknowledgedAt` When the `status` of the collaboration object changed to `accepted` or `rejected`.
`protected AppItem`	`appItem`
`protected OffsetDateTime`	`createdAt` When the collaboration object was created.
`protected UserCollaborations`	`createdBy`
`protected OffsetDateTime`	`expiresAt` When the collaboration will expire, or `null` if no expiration date is set.
`protected String`	`id` The unique identifier for this collaboration.
`protected String`	`inviteEmail` The email address used to invite an unregistered collaborator, if they are not a registered user.
`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 CollaborationItem`	`item`
`protected OffsetDateTime`	`modifiedAt` When the collaboration object was last modified.
`protected EnumWrapper<CollaborationRoleField>`	`role` The level of access granted.
`protected EnumWrapper<CollaborationStatusField>`	`status` The status of the collaboration invitation.
`protected EnumWrapper<CollaborationTypeField>`	`type` The value will always be `collaboration`.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected Collaboration(Collaboration.Builder builder)

Collaboration(String id)

Constructors
Modifier	Constructor and Description
`protected`	`Collaboration(Collaboration.Builder builder)`
	`Collaboration(String id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`CollaborationAcceptanceRequirementsStatusField`	`getAcceptanceRequirementsStatus()`
`CollaborationAccessGrantee`	`getAccessibleBy()`
`OffsetDateTime`	`getAcknowledgedAt()`
`AppItem`	`getAppItem()`
`OffsetDateTime`	`getCreatedAt()`
`UserCollaborations`	`getCreatedBy()`
`OffsetDateTime`	`getExpiresAt()`
`String`	`getId()`
`String`	`getInviteEmail()`
`Boolean`	`getIsAccessOnly()`
`CollaborationItem`	`getItem()`
`OffsetDateTime`	`getModifiedAt()`
`EnumWrapper<CollaborationRoleField>`	`getRole()`
`EnumWrapper<CollaborationStatusField>`	`getStatus()`
`EnumWrapper<CollaborationTypeField>`	`getType()`
`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
- id
```
protected final String id
```
  The unique identifier for this collaboration.
- type
```
protected EnumWrapper<CollaborationTypeField> type
```
  The value will always be `collaboration`.
- item
```
protected CollaborationItem item
```
- appItem
```
protected AppItem appItem
```
- accessibleBy
```
protected CollaborationAccessGrantee accessibleBy
```
- inviteEmail
```
protected String inviteEmail
```
  The email address used to invite an unregistered collaborator, if they are not a registered user.
- role
```
protected EnumWrapper<CollaborationRoleField> role
```
  The level of access granted.
- expiresAt
```
protected OffsetDateTime expiresAt
```
  When the collaboration will expire, or `null` if no expiration date is set.
- 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.
- status
```
protected EnumWrapper<CollaborationStatusField> status
```
  The status of the collaboration invitation. If the status is `pending`, `login` and `name` return an empty string.
- acknowledgedAt
```
protected OffsetDateTime acknowledgedAt
```
  When the `status` of the collaboration object changed to `accepted` or `rejected`.
- createdBy
```
protected UserCollaborations createdBy
```
- createdAt
```
protected OffsetDateTime createdAt
```
  When the collaboration object was created.
- modifiedAt
```
protected OffsetDateTime modifiedAt
```
  When the collaboration object was last modified.
- acceptanceRequirementsStatus
```
protected CollaborationAcceptanceRequirementsStatusField acceptanceRequirementsStatus
```

Constructor Detail

Collaboration
```
public Collaboration(String id)
```

Collaboration

protected Collaboration(Collaboration.Builder builder)

Method Detail

getId
```
public String getId()
```

getType

public EnumWrapper<CollaborationTypeField> getType()

getItem
```
public CollaborationItem getItem()
```

getAppItem
```
public AppItem getAppItem()
```

getAccessibleBy

public CollaborationAccessGrantee getAccessibleBy()

getInviteEmail
```
public String getInviteEmail()
```

getRole

public EnumWrapper<CollaborationRoleField> getRole()

getExpiresAt
```
public OffsetDateTime getExpiresAt()
```

getIsAccessOnly
```
public Boolean getIsAccessOnly()
```

getStatus

public EnumWrapper<CollaborationStatusField> getStatus()

getAcknowledgedAt

public OffsetDateTime getAcknowledgedAt()

getCreatedBy

public UserCollaborations getCreatedBy()

getCreatedAt
```
public OffsetDateTime getCreatedAt()
```

getModifiedAt
```
public OffsetDateTime getModifiedAt()
```

getAcceptanceRequirementsStatus

public CollaborationAcceptanceRequirementsStatusField getAcceptanceRequirementsStatus()

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

Class Collaboration

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

id

type

item

appItem

accessibleBy

inviteEmail

role

expiresAt

isAccessOnly

status

acknowledgedAt

createdBy

createdAt

modifiedAt

acceptanceRequirementsStatus

Constructor Detail

Collaboration

Collaboration

Method Detail

getId

getType

getItem

getAppItem

getAccessibleBy

getInviteEmail

getRole

getExpiresAt

getIsAccessOnly

getStatus

getAcknowledgedAt

getCreatedBy

getCreatedAt

getModifiedAt

getAcceptanceRequirementsStatus

equals

hashCode

toString