TrashFolder (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - TrashFolder

All Implemented Interfaces:

Serializable
```
public class TrashFolder
extends SerializableObject
```
Represents a trashed folder.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TrashFolder.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected OffsetDateTime`	`contentCreatedAt` The date and time at which this folder was originally created.
`protected OffsetDateTime`	`contentModifiedAt` The date and time at which this folder was last updated.
`protected OffsetDateTime`	`createdAt` The date and time when the folder was created.
`protected UserMini`	`createdBy`
`protected String`	`description`
`protected String`	`etag` The HTTP `etag` of this folder.
`protected String`	`folderUploadEmail` The folder upload email for this folder.
`protected String`	`id` The unique identifier that represent a folder.
`protected EnumWrapper<TrashFolderItemStatusField>`	`itemStatus` Defines if this item has been deleted or not.
`protected OffsetDateTime`	`modifiedAt` The date and time when the folder was last updated.
`protected UserMini`	`modifiedBy`
`protected String`	`name` The name of the folder.
`protected UserMini`	`ownedBy`
`protected FolderMini`	`parent`
`protected TrashFolderPathCollectionField`	`pathCollection`
`protected OffsetDateTime`	`purgedAt` The time at which this folder is expected to be purged from the trash.
`protected String`	`sequenceId`
`protected String`	`sharedLink` The shared link for this folder.
`protected long`	`size` The folder size in bytes.
`protected OffsetDateTime`	`trashedAt` The time at which this folder was put in the trash.
`protected EnumWrapper<TrashFolderTypeField>`	`type` The value will always be `folder`.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier	Constructor and Description
	`TrashFolder(String id, String name, String description, long size, TrashFolderPathCollectionField pathCollection, UserMini createdBy, UserMini modifiedBy, UserMini ownedBy, EnumWrapper<TrashFolderItemStatusField> itemStatus)`
	`TrashFolder(String id, String name, String description, long size, TrashFolderPathCollectionField pathCollection, UserMini createdBy, UserMini modifiedBy, UserMini ownedBy, TrashFolderItemStatusField itemStatus)`
`protected`	`TrashFolder(TrashFolder.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`OffsetDateTime`	`getContentCreatedAt()`
`OffsetDateTime`	`getContentModifiedAt()`
`OffsetDateTime`	`getCreatedAt()`
`UserMini`	`getCreatedBy()`
`String`	`getDescription()`
`String`	`getEtag()`
`String`	`getFolderUploadEmail()`
`String`	`getId()`
`EnumWrapper<TrashFolderItemStatusField>`	`getItemStatus()`
`OffsetDateTime`	`getModifiedAt()`
`UserMini`	`getModifiedBy()`
`String`	`getName()`
`UserMini`	`getOwnedBy()`
`FolderMini`	`getParent()`
`TrashFolderPathCollectionField`	`getPathCollection()`
`OffsetDateTime`	`getPurgedAt()`
`String`	`getSequenceId()`
`String`	`getSharedLink()`
`long`	`getSize()`
`OffsetDateTime`	`getTrashedAt()`
`EnumWrapper<TrashFolderTypeField>`	`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 that represent a folder.
  The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.
- etag
```
protected String etag
```
  The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.
- type
```
protected EnumWrapper<TrashFolderTypeField> type
```
  The value will always be `folder`.
- sequenceId
```
protected String sequenceId
```
- name
```
protected final String name
```
  The name of the folder.
- createdAt
```
protected OffsetDateTime createdAt
```
  The date and time when the folder was created. This value may be `null` for some folders such as the root folder or the trash folder.
- modifiedAt
```
protected OffsetDateTime modifiedAt
```
  The date and time when the folder was last updated. This value may be `null` for some folders such as the root folder or the trash folder.
- description
```
protected final String description
```
- size
```
protected final long size
```
  The folder size in bytes.
  Be careful parsing this integer as its value can get very large.
- pathCollection
```
protected final TrashFolderPathCollectionField pathCollection
```
- createdBy
```
protected final UserMini createdBy
```
- modifiedBy
```
protected final UserMini modifiedBy
```
- trashedAt
```
protected OffsetDateTime trashedAt
```
  The time at which this folder was put in the trash.
- purgedAt
```
protected OffsetDateTime purgedAt
```
  The time at which this folder is expected to be purged from the trash.
- contentCreatedAt
```
protected OffsetDateTime contentCreatedAt
```
  The date and time at which this folder was originally created.
- contentModifiedAt
```
protected OffsetDateTime contentModifiedAt
```
  The date and time at which this folder was last updated.
- ownedBy
```
protected final UserMini ownedBy
```
- sharedLink
```
protected String sharedLink
```
  The shared link for this folder. This will be `null` if a folder has been trashed, since the link will no longer be active.
- folderUploadEmail
```
protected String folderUploadEmail
```
  The folder upload email for this folder. This will be `null` if a folder has been trashed, since the upload will no longer work.
- parent
```
protected FolderMini parent
```
- itemStatus
```
protected final EnumWrapper<TrashFolderItemStatusField> itemStatus
```
  Defines if this item has been deleted or not.
  * `active` when the item has is not in the trash * `trashed` when the item has been moved to the trash but not deleted * `deleted` when the item has been permanently deleted.

Constructor Detail

TrashFolder

public TrashFolder(String id,
                   String name,
                   String description,
                   long size,
                   TrashFolderPathCollectionField pathCollection,
                   UserMini createdBy,
                   UserMini modifiedBy,
                   UserMini ownedBy,
                   TrashFolderItemStatusField itemStatus)

TrashFolder

public TrashFolder(String id,
                   String name,
                   String description,
                   long size,
                   TrashFolderPathCollectionField pathCollection,
                   UserMini createdBy,
                   UserMini modifiedBy,
                   UserMini ownedBy,
                   EnumWrapper<TrashFolderItemStatusField> itemStatus)

TrashFolder

protected TrashFolder(TrashFolder.Builder builder)

Method Detail

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

getEtag
```
public String getEtag()
```

getType

public EnumWrapper<TrashFolderTypeField> getType()

getSequenceId
```
public String getSequenceId()
```

getName
```
public String getName()
```

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

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

getDescription
```
public String getDescription()
```

getSize
```
public long getSize()
```

getPathCollection

public TrashFolderPathCollectionField getPathCollection()

getCreatedBy
```
public UserMini getCreatedBy()
```

getModifiedBy
```
public UserMini getModifiedBy()
```

getTrashedAt
```
public OffsetDateTime getTrashedAt()
```

getPurgedAt
```
public OffsetDateTime getPurgedAt()
```

getContentCreatedAt

public OffsetDateTime getContentCreatedAt()

getContentModifiedAt

public OffsetDateTime getContentModifiedAt()

getOwnedBy
```
public UserMini getOwnedBy()
```

getSharedLink
```
public String getSharedLink()
```

getFolderUploadEmail
```
public String getFolderUploadEmail()
```

getParent
```
public FolderMini getParent()
```

getItemStatus

public EnumWrapper<TrashFolderItemStatusField> getItemStatus()

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 TrashFolder

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

etag

type

sequenceId

name

createdAt

modifiedAt

description

size

pathCollection

createdBy

modifiedBy

trashedAt

purgedAt

contentCreatedAt

contentModifiedAt

ownedBy

sharedLink

folderUploadEmail

parent

itemStatus

Constructor Detail

TrashFolder

TrashFolder

TrashFolder

Method Detail

getId

getEtag

getType

getSequenceId

getName

getCreatedAt

getModifiedAt

getDescription

getSize

getPathCollection

getCreatedBy

getModifiedBy

getTrashedAt

getPurgedAt

getContentCreatedAt

getContentModifiedAt

getOwnedBy

getSharedLink

getFolderUploadEmail

getParent

getItemStatus

equals

hashCode

toString