com.citrix.sharefile.api.models

Class SFFile

java.lang.Object

com.citrix.sharefile.api.models.SFODataObject

com.citrix.sharefile.api.models.SFItem

com.citrix.sharefile.api.models.SFFile

public class SFFile
extends SFItem

Constructor Summary

Constructors

Constructor and Description
SFFile()

Method Summary

Methods

Modifier and Type	Method and Description
SFItemDlpInfo	getDlpInfo() Data Loss Prevention information for this file.
SFESignature	getESignatureDocument() Electronic signature object associated with this item
SFFileLock	getFileLockInfo() File lock info
java.lang.String	getFilePath() Represents the Object Storage Identifier for this File.
java.lang.String	getHash() MD5 Hash of the File contents.
java.lang.Boolean	getHasPreview() Indicates that the File has an image Preview.
SFItemInfo	getInfo() Effective Access Control permissions for this file
SFUser	getLockedBy() Indicates the user that has locked the file
java.lang.Float	getVersion() File version.
SFSafeEnum<SFFileVirusStatus>	getVirusStatus() Current Anti-Virus scanning status for this file
void	setDlpInfo(SFItemDlpInfo dlpinfo) Data Loss Prevention information for this file.
void	setESignatureDocument(SFESignature esignaturedocument) Electronic signature object associated with this item
void	setFileLockInfo(SFFileLock filelockinfo) File lock info
void	setFilePath(java.lang.String filepath) Represents the Object Storage Identifier for this File.
void	setHash(java.lang.String hash) MD5 Hash of the File contents.
void	setHasPreview(java.lang.Boolean haspreview) Indicates that the File has an image Preview.
void	setInfo(SFItemInfo info) Effective Access Control permissions for this file
void	setLockedBy(SFUser lockedby) Indicates the user that has locked the file
void	setVersion(java.lang.Float version) File version.
void	setVirusStatus(SFSafeEnum<SFFileVirusStatus> virusstatus) Current Anti-Virus scanning status for this file

Methods inherited from class com.citrix.sharefile.api.models.SFItem

getAccessControls, getAccount, getAssociatedFolderTemplateID, getBandwidthLimitInMB, getClientCreatedDate, getClientModifiedDate, getCreationDate, getCreator, getCreatorFirstName, getCreatorLastName, getCreatorNameShort, getDescription, getDiskSpaceLimit, getEditingPlatformsSupported, getExpirationDate, getExpirationDays, getFileName, getFileSizeBytes, getFileSizeInKB, getHasMultipleVersions, getHasPendingAsyncOp, getHasPendingDeletion, getHasPermissionInfo, getIsHidden, getIsTemplateOwned, getMaxPreviewSize, getMetadata, getName, getOwner, getParent, getPath, getPreviewPlatformsSupported, getPreviewStatus, getProgenyEditDate, getState, getStreamID, getZone, setAccessControls, setAccount, setAssociatedFolderTemplateID, setBandwidthLimitInMB, setClientCreatedDate, setClientModifiedDate, setCreationDate, setCreator, setCreatorFirstName, setCreatorLastName, setCreatorNameShort, setDescription, setDiskSpaceLimit, setEditingPlatformsSupported, setExpirationDate, setExpirationDays, setFileName, setFileSizeBytes, setFileSizeInKB, setHasMultipleVersions, setHasPendingAsyncOp, setHasPendingDeletion, setHasPermissionInfo, setIsHidden, setIsTemplateOwned, setMaxPreviewSize, setMetadata, setName, setOwner, setParent, setPath, setPreviewPlatformsSupported, setPreviewStatus, setProgenyEditDate, setState, setStreamID, setZone

Methods inherited from class com.citrix.sharefile.api.models.SFODataObject

addProperty, get__type, getId, getMetadataUrl, getProperties, geturl, set__type, setId, setMetadataUrl, setProperties, seturl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFFile

public SFFile()

Method Detail

getFilePath

public java.lang.String getFilePath()

Represents the Object Storage Identifier for this File. This field is used in Object Storage providers - including sharefile.com and Storage Zones. Other providers like CIFS and SharePoint do not need external references for object blobs and do not populate this field.

setFilePath

public void setFilePath(java.lang.String filepath)

Represents the Object Storage Identifier for this File. This field is used in Object Storage providers - including sharefile.com and Storage Zones. Other providers like CIFS and SharePoint do not need external references for object blobs and do not populate this field.

getHash

public java.lang.String getHash()

MD5 Hash of the File contents.

setHash

public void setHash(java.lang.String hash)

MD5 Hash of the File contents.

getHasPreview

public java.lang.Boolean getHasPreview()

Indicates that the File has an image Preview.

setHasPreview

public void setHasPreview(java.lang.Boolean haspreview)

Indicates that the File has an image Preview.

getVirusStatus

public SFSafeEnum<SFFileVirusStatus> getVirusStatus()

Current Anti-Virus scanning status for this file

setVirusStatus

public void setVirusStatus(SFSafeEnum<SFFileVirusStatus> virusstatus)

Current Anti-Virus scanning status for this file

getDlpInfo

public SFItemDlpInfo getDlpInfo()

Data Loss Prevention information for this file.

setDlpInfo

public void setDlpInfo(SFItemDlpInfo dlpinfo)

Data Loss Prevention information for this file.

getInfo

public SFItemInfo getInfo()

Effective Access Control permissions for this file

setInfo

public void setInfo(SFItemInfo info)

Effective Access Control permissions for this file

getLockedBy

public SFUser getLockedBy()

Indicates the user that has locked the file

setLockedBy

public void setLockedBy(SFUser lockedby)

Indicates the user that has locked the file

getFileLockInfo

public SFFileLock getFileLockInfo()

File lock info

setFileLockInfo

public void setFileLockInfo(SFFileLock filelockinfo)

File lock info

getVersion

public java.lang.Float getVersion()

File version.

setVersion

public void setVersion(java.lang.Float version)

File version.

getESignatureDocument

public SFESignature getESignatureDocument()

Electronic signature object associated with this item

setESignatureDocument

public void setESignatureDocument(SFESignature esignaturedocument)

Electronic signature object associated with this item