com.box.sdkgen.schemas.filefull

Class FileFull

Object

NullableFieldTracker

SerializableObject

FileBase

FileMini

File

FileFull

All Implemented Interfaces:

Serializable

public class FileFull
extends File

A full representation of a file, as can be returned from any file API endpoints by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileFull.AllowedInviteeRolesDeserializer
static class	FileFull.AllowedInviteeRolesSerializer
static class	FileFull.Builder
static class	FileFull.SharedLinkPermissionOptionsDeserializer
static class	FileFull.SharedLinkPermissionOptionsSerializer

Field Summary

Fields

Modifier and Type	Field and Description
protected List<EnumWrapper<FileFullAllowedInviteeRolesField>>	allowedInviteeRoles A list of the types of roles that user can be invited at when sharing this file.
protected FileFullClassificationField	classification
protected Long	commentCount The number of comments on this file.
protected OffsetDateTime	dispositionAt The retention expiration timestamp for the given file.
protected OffsetDateTime	expiresAt When the file will automatically be deleted.
protected FileFullExpiringEmbedLinkField	expiringEmbedLink
protected String	extension Indicates the (optional) file extension for this file.
protected Boolean	hasCollaborations Specifies if this file has any other collaborators.
protected Boolean	isAccessibleViaSharedLink Specifies if the file can be accessed via the direct shared link or a shared link to a parent folder.
protected Boolean	isAssociatedWithAppItem This field will return true if the file or any ancestor of the file is associated with at least one app item.
protected Boolean	isExternallyOwned Specifies if this file is owned by a user outside of the authenticated enterprise.
protected Boolean	isPackage Indicates if the file is a package.
protected FileFullLockField	lock
protected FileFullMetadataField	metadata
protected FileFullPermissionsField	permissions
protected FileFullRepresentationsField	representations
protected List<EnumWrapper<FileFullSharedLinkPermissionOptionsField>>	sharedLinkPermissionOptions A list of the types of roles that user can be invited at when sharing this file.
protected List<String>	tags
protected String	uploaderDisplayName
protected String	versionNumber The version number of this file.
protected FileFullWatermarkInfoField	watermarkInfo

Fields inherited from class File

contentCreatedAt, contentModifiedAt, createdAt, createdBy, description, itemStatus, modifiedAt, modifiedBy, ownedBy, parent, pathCollection, purgedAt, sharedLink, size, trashedAt

Fields inherited from class FileMini

fileVersion, name, sequenceId, sha1

Fields inherited from class FileBase

etag, id, type

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileFull(FileFull.Builder builder)
	FileFull(String id)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<EnumWrapper<FileFullAllowedInviteeRolesField>>	getAllowedInviteeRoles()
FileFullClassificationField	getClassification()
Long	getCommentCount()
OffsetDateTime	getDispositionAt()
OffsetDateTime	getExpiresAt()
FileFullExpiringEmbedLinkField	getExpiringEmbedLink()
String	getExtension()
Boolean	getHasCollaborations()
Boolean	getIsAccessibleViaSharedLink()
Boolean	getIsAssociatedWithAppItem()
Boolean	getIsExternallyOwned()
Boolean	getIsPackage()
FileFullLockField	getLock()
FileFullMetadataField	getMetadata()
FileFullPermissionsField	getPermissions()
FileFullRepresentationsField	getRepresentations()
List<EnumWrapper<FileFullSharedLinkPermissionOptionsField>>	getSharedLinkPermissionOptions()
List<String>	getTags()
String	getUploaderDisplayName()
String	getVersionNumber()
FileFullWatermarkInfoField	getWatermarkInfo()
int	hashCode()
String	toString()

Methods inherited from class File

getContentCreatedAt, getContentModifiedAt, getCreatedAt, getCreatedBy, getDescription, getItemStatus, getModifiedAt, getModifiedBy, getOwnedBy, getParent, getPathCollection, getPurgedAt, getSharedLink, getSize, getTrashedAt

Methods inherited from class FileMini

getFileVersion, getName, getSequenceId, getSha1

Methods inherited from class FileBase

getEtag, getId, getType

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

versionNumber

protected String versionNumber

The version number of this file.

commentCount

protected Long commentCount

The number of comments on this file.

permissions

protected FileFullPermissionsField permissions

tags

protected List<String> tags

lock

protected FileFullLockField lock

extension

protected String extension

Indicates the (optional) file extension for this file. By default, this is set to an empty string.

isPackage

protected Boolean isPackage

Indicates if the file is a package. Packages are commonly used by Mac Applications and can include iWork files.

expiringEmbedLink

protected FileFullExpiringEmbedLinkField expiringEmbedLink

watermarkInfo

protected FileFullWatermarkInfoField watermarkInfo

isAccessibleViaSharedLink

protected Boolean isAccessibleViaSharedLink

Specifies if the file can be accessed via the direct shared link or a shared link to a parent folder.

allowedInviteeRoles

protected List<EnumWrapper<FileFullAllowedInviteeRolesField>> allowedInviteeRoles

A list of the types of roles that user can be invited at when sharing this file.

isExternallyOwned

protected Boolean isExternallyOwned

Specifies if this file is owned by a user outside of the authenticated enterprise.

hasCollaborations

protected Boolean hasCollaborations

Specifies if this file has any other collaborators.

metadata

protected FileFullMetadataField metadata

expiresAt

protected OffsetDateTime expiresAt

When the file will automatically be deleted.

representations

protected FileFullRepresentationsField representations

classification

protected FileFullClassificationField classification

uploaderDisplayName

protected String uploaderDisplayName

dispositionAt

protected OffsetDateTime dispositionAt

The retention expiration timestamp for the given file.

sharedLinkPermissionOptions

protected List<EnumWrapper<FileFullSharedLinkPermissionOptionsField>> sharedLinkPermissionOptions

A list of the types of roles that user can be invited at when sharing this file.

isAssociatedWithAppItem

protected Boolean isAssociatedWithAppItem

This field will return true if the file or any ancestor of the file is associated with at least one app item. Note that this will return true even if the context user does not have access to the app item(s) associated with the file.

Constructor Detail

FileFull

public FileFull(String id)

FileFull

protected FileFull(FileFull.Builder builder)

Method Detail

getVersionNumber

public String getVersionNumber()

getCommentCount

public Long getCommentCount()

getPermissions

public FileFullPermissionsField getPermissions()

getTags

public List<String> getTags()

getLock

public FileFullLockField getLock()

getExtension

public String getExtension()

getIsPackage

public Boolean getIsPackage()

getExpiringEmbedLink

public FileFullExpiringEmbedLinkField getExpiringEmbedLink()

getWatermarkInfo

public FileFullWatermarkInfoField getWatermarkInfo()

getIsAccessibleViaSharedLink

public Boolean getIsAccessibleViaSharedLink()

getAllowedInviteeRoles

public List<EnumWrapper<FileFullAllowedInviteeRolesField>> getAllowedInviteeRoles()

getIsExternallyOwned

public Boolean getIsExternallyOwned()

getHasCollaborations

public Boolean getHasCollaborations()

getMetadata

public FileFullMetadataField getMetadata()

getExpiresAt

public OffsetDateTime getExpiresAt()

getRepresentations

public FileFullRepresentationsField getRepresentations()

getClassification

public FileFullClassificationField getClassification()

getUploaderDisplayName

public String getUploaderDisplayName()

getDispositionAt

public OffsetDateTime getDispositionAt()

getSharedLinkPermissionOptions

public List<EnumWrapper<FileFullSharedLinkPermissionOptionsField>> getSharedLinkPermissionOptions()

getIsAssociatedWithAppItem

public Boolean getIsAssociatedWithAppItem()

equals

public boolean equals(Object o)

Overrides:

equals in class File

hashCode

public int hashCode()

Overrides:

hashCode in class File

toString

public String toString()

Overrides:

toString in class File