public class DocumentJson extends BaseJson
Constructor and Description |
---|
DocumentJson() |
Modifier and Type | Method and Description |
---|---|
DocumentAccessLevel |
getAccessLevel()
Document Access Level.
|
DocumentAnnotationsListJson |
getAnnotationsList()
A json which represents the users who annotated the document, and the
last update date of their annotation
|
CacheDocumentStatus |
getCacheStatus() |
String |
getClassification()
Classification, if exists.
|
Boolean |
getCollaboration() |
String |
getContentType()
Content type
|
String |
getConvertedName()
Converted name for file
|
Date |
getCreationDate()
Date of creation.
|
String |
getDlpStatus()
return the DLP status of an uploading file
|
DocumentCommentCountJson |
getDocumentCommentCountJson() |
DocumentCurrentVersionJson |
getDocumentCurrentVersion()
A json which represents the current version of the document
|
String |
getDocumentName()
Use 'name' instead
|
long |
getDownloadPdfSize() |
long |
getDownloadSize() |
String |
getEditorUrl()
URL to edit the document using Wopi
|
Date |
getExpires()
Use permissions instead
|
DocumentExternalRepositoryDataJson |
getExternalRepositoryData() |
String |
getFileHash() |
String |
getFilename()
File name.
|
String |
getFolder()
File's folder, for example: /office/docs
|
Integer |
getFolderId() |
String |
getFolderUuid() |
Boolean |
getFoundInContent() |
Boolean |
getFoundInMetadata() |
String |
getGuid()
Signed GUID of a file, created by the server.
|
Integer |
getId() |
Boolean |
getInheritsPerms() |
Date |
getLastUpdated()
Date of creation or last update of the file.
|
Date |
getLastUpdateDate()
Use 'lastUpdated' instead
|
String |
getLastVersionUploaderUserAddress() |
Integer |
getLicenseHoursValid()
Max hours that the license is valid
|
String |
getLockingUserAddress() |
Date |
getModifiedDate()
Date of modified.
|
String |
getName()
File name
|
Integer |
getNumOfVersions()
Indicates how many versions this file has
|
String |
getOnlineEditorUrl()
URL to edit the document online
|
boolean |
getOpenToAnyone()
Deprecated.
|
Boolean |
getOriginalReadAckState() |
Long |
getOriginalSize()
Original size of file (bytes)
|
PdfConversionStatus |
getPdfConversionStatus()
The status of PDF conversion
|
Integer |
getPendingRequests()
Number of pending requests to access the file
|
Integer |
getPercentCompleted()
Progress status.
|
PermissionsToUserJson |
getPermissionsJson()
Permissions, in some contexts may be null.
|
String |
getPreviewUrl()
URL to preview the file
|
Boolean |
getRead()
Will be true if the last file was read since its last update.
|
Boolean |
getReadAcknowledged() |
Boolean |
getReadConfirmation() |
ReadyForDownloadOriginal |
getReadyForDownloadOriginal() |
Date |
getRecentlyViewed()
Date file was most recently viewed.
|
Boolean |
getRmsEnabled() |
String |
getRoom()
Id of the workspace the file has been submitted to.
|
Float |
getScore()
The score of the file in the current search
|
Boolean |
getSecureTransferFile() |
String |
getSender()
Sender's email address
|
Boolean |
getStarred()
Will be true if the file was marked as starred (favorite).
|
Date |
getStarredDate() |
StatusJson |
getStatus()
Status, status number and error string in case of error.
|
boolean |
getSupportedFileType()
Deprecated.
|
TagListJson |
getTagList()
Tags, if exist.
|
String |
getType()
Use 'contentType' instead
|
String |
getUrl()
URL of a (protected) file.
|
String |
getViewerUrl()
URL of a (protected) file for viewing .
|
String |
getWorkspaceType() |
String |
getWorkspaceUuid()
Workspace uuid
|
boolean |
isOpenToAnyone()
Indicates that the file can be accessed by non-authenticated users
|
boolean |
isSupportedFileType()
Indicates that a file can be shown in Watchdox Online Viewer
|
void |
setAccessLevel(DocumentAccessLevel accessLevel)
Document Access Level.
|
void |
setAnnotationsList(DocumentAnnotationsListJson annotationsList)
A json which represents the users who annotated the document, and the
last update date of their annotation
|
void |
setCacheStatus(CacheDocumentStatus cacheStatus) |
void |
setClassification(String classification)
Classification, if exists.
|
void |
setCollaboration(Boolean collaboration) |
void |
setContentType(String contentType)
Content type
|
void |
setConvertedName(String convertedName)
Converted name for file
|
void |
setCreationDate(Date creationDate)
Date of creation.
|
void |
setDlpStatus(String dlpStatus)
return the DLP status of an uploading file
|
void |
setDocumentCommentCountJson(DocumentCommentCountJson documentCommentCountJson) |
void |
setDocumentCurrentVersion(DocumentCurrentVersionJson documentCurrentVersion)
A json which represents the current version of the document
|
void |
setDocumentName(String documentName)
Use 'name' instead
|
void |
setDownloadPdfSize(long downloadPdfSize) |
void |
setDownloadSize(long downloadSize) |
void |
setEditorUrl(String editorUrl)
URL to edit the document using Wopi
|
void |
setExpires(Date expires)
Use permissions instead
|
void |
setExternalRepositoryData(DocumentExternalRepositoryDataJson externalRepositoryData) |
void |
setFileHash(String fileHash) |
void |
setFilename(String filename)
File name.
|
void |
setFolder(String folder)
File's folder, for example: /office/docs
|
void |
setFolderId(Integer folderId) |
void |
setFolderUuid(String folderUuid) |
void |
setFoundInContent(Boolean foundInContent) |
void |
setFoundInMetadata(Boolean foundInMetadata) |
void |
setGuid(String guid)
Signed GUID of a file, created by the server.
|
void |
setId(Integer id) |
void |
setInheritsPerms(Boolean inheritsPerms) |
void |
setLastUpdated(Date lastUpdated)
Date of creation or last update of the file.
|
void |
setLastUpdateDate(Date lastUpdateDate)
Use 'lastUpdated' instead
|
void |
setLastVersionUploaderUserAddress(String lastVersionUploaderUserAddress) |
void |
setLicenseHoursValid(Integer licenseHoursValid)
Max hours that the license is valid
|
void |
setLockingUserAddress(String lockingUserAddress) |
void |
setModifiedDate(Date modifiedDate)
Date of modified.
|
void |
setName(String name)
File name
|
void |
setNumOfVersions(Integer numOfVersions)
Indicates how many versions this file has
|
void |
setOnlineEditorUrl(String onlineEditorUrl)
URL to edit the document online
|
void |
setOpenToAnyone(boolean openToAnyone)
Indicates that the file can be accessed by non-authenticated users
|
void |
setOriginalReadAckState(Boolean originalReadAckState) |
void |
setOriginalSize(Long originalSize)
Original size of file (bytes)
|
void |
setPdfConversionStatus(PdfConversionStatus pdfConversionStatus)
The status of PDF conversion
|
void |
setPendingRequests(Integer pendingRequests)
Number of pending requests to access the file
|
void |
setPercentCompleted(Integer percentCompleted)
Progress status.
|
void |
setPermissionsJson(PermissionsToUserJson permissionsJson)
Permissions, in some contexts may be null.
|
void |
setPreviewUrl(String previewUrl)
URL to preview the file
|
void |
setRead(Boolean read)
Will be true if the last file was read since its last update.
|
void |
setReadAcknowledged(Boolean readAcknowledged) |
void |
setReadConfirmation(Boolean readConfirmation) |
void |
setReadyForDownloadOriginal(ReadyForDownloadOriginal readyForDownloadOriginal) |
void |
setRecentlyViewed(Date recentlyViewed)
Date file was most recently viewed.
|
void |
setRmsEnabled(Boolean rmsEnabled) |
void |
setRoom(String room)
Id of the workspace the file has been submitted to.
|
void |
setScore(Float score)
The score of the file in the current search
|
void |
setSecureTransferFile(Boolean secureTransferFile) |
void |
setSender(String sender)
Sender's email address
|
void |
setStarred(Boolean starred)
Will be true if the file was marked as starred (favorite).
|
void |
setStarredDate(Date starredDate) |
void |
setStatus(StatusJson status)
Status, status number and error string in case of error.
|
void |
setSupportedFileType(boolean supportedFileType)
Indicates that a file can be shown in Watchdox Online Viewer
|
void |
setTagList(TagListJson tagList)
Tags, if exist.
|
void |
setType(String type)
Use 'contentType' instead
|
void |
setUrl(String url)
URL of a (protected) file.
|
void |
setViewerUrl(String viewerUrl)
URL of a (protected) file for viewing .
|
void |
setWorkspaceType(String workspaceType) |
void |
setWorkspaceUuid(String workspaceUuid)
Workspace uuid
|
getObjType, setObjType, toString
public String getPreviewUrl()
public void setPreviewUrl(String previewUrl)
previewUrl
- URL to preview the filepublic Integer getPendingRequests()
public void setPendingRequests(Integer pendingRequests)
pendingRequests
- Number of pending requests to access the filepublic Date getLastUpdateDate()
public void setLastUpdateDate(Date lastUpdateDate)
lastUpdateDate
- Use 'lastUpdated' insteadpublic String getFileHash()
public void setFileHash(String fileHash)
public String getType()
public void setType(String type)
type
- Use 'contentType' insteadpublic Float getScore()
public void setScore(Float score)
score
- The score of the file in the current searchpublic Date getLastUpdated()
public void setLastUpdated(Date lastUpdated)
lastUpdated
- Date of creation or last update of the file.public Boolean getFoundInMetadata()
public void setFoundInMetadata(Boolean foundInMetadata)
public Boolean getStarred()
public void setStarred(Boolean starred)
starred
- Will be true if the file was marked as starred
(favorite).public ReadyForDownloadOriginal getReadyForDownloadOriginal()
public void setReadyForDownloadOriginal(ReadyForDownloadOriginal readyForDownloadOriginal)
public DocumentExternalRepositoryDataJson getExternalRepositoryData()
public void setExternalRepositoryData(DocumentExternalRepositoryDataJson externalRepositoryData)
public Integer getId()
public void setId(Integer id)
public DocumentCommentCountJson getDocumentCommentCountJson()
public void setDocumentCommentCountJson(DocumentCommentCountJson documentCommentCountJson)
public Long getOriginalSize()
public void setOriginalSize(Long originalSize)
originalSize
- Original size of file (bytes)public String getContentType()
public void setContentType(String contentType)
contentType
- Content typepublic Boolean getRead()
public void setRead(Boolean read)
read
- Will be true if the last file was read since its last
update.public CacheDocumentStatus getCacheStatus()
public void setCacheStatus(CacheDocumentStatus cacheStatus)
public Boolean getSecureTransferFile()
public void setSecureTransferFile(Boolean secureTransferFile)
public Date getCreationDate()
public void setCreationDate(Date creationDate)
creationDate
- Date of creation.public String getClassification()
public void setClassification(String classification)
classification
- Classification, if exists.public DocumentCurrentVersionJson getDocumentCurrentVersion()
public void setDocumentCurrentVersion(DocumentCurrentVersionJson documentCurrentVersion)
documentCurrentVersion
- A json which represents the current
version of the documentpublic Integer getFolderId()
public void setFolderId(Integer folderId)
public Date getRecentlyViewed()
public void setRecentlyViewed(Date recentlyViewed)
recentlyViewed
- Date file was most recently viewed. not supported
any longer - info is meaninglesspublic long getDownloadSize()
public void setDownloadSize(long downloadSize)
public String getFolder()
public void setFolder(String folder)
folder
- File's folder, for example: /office/docspublic String getFilename()
public void setFilename(String filename)
filename
- File name.public String getSender()
public void setSender(String sender)
sender
- Sender's email addresspublic Date getModifiedDate()
public void setModifiedDate(Date modifiedDate)
modifiedDate
- Date of modified.public String getName()
public void setName(String name)
name
- File namepublic String getGuid()
public void setGuid(String guid)
guid
- Signed GUID of a file, created by the server.public Boolean getFoundInContent()
public void setFoundInContent(Boolean foundInContent)
public StatusJson getStatus()
public void setStatus(StatusJson status)
status
- Status, status number and error string in case of error.public Integer getPercentCompleted()
public void setPercentCompleted(Integer percentCompleted)
percentCompleted
- Progress status.public String getLockingUserAddress()
public void setLockingUserAddress(String lockingUserAddress)
public Date getExpires()
public void setExpires(Date expires)
expires
- Use permissions insteadpublic long getDownloadPdfSize()
public void setDownloadPdfSize(long downloadPdfSize)
public String getOnlineEditorUrl()
public void setOnlineEditorUrl(String onlineEditorUrl)
onlineEditorUrl
- URL to edit the document onlinepublic Boolean getOriginalReadAckState()
public void setOriginalReadAckState(Boolean originalReadAckState)
public Boolean getReadConfirmation()
public void setReadConfirmation(Boolean readConfirmation)
public PdfConversionStatus getPdfConversionStatus()
public void setPdfConversionStatus(PdfConversionStatus pdfConversionStatus)
pdfConversionStatus
- The status of PDF conversionpublic Boolean getRmsEnabled()
public void setRmsEnabled(Boolean rmsEnabled)
public String getConvertedName()
public void setConvertedName(String convertedName)
convertedName
- Converted name for filepublic Integer getLicenseHoursValid()
public void setLicenseHoursValid(Integer licenseHoursValid)
licenseHoursValid
- Max hours that the license is validpublic String getDlpStatus()
public void setDlpStatus(String dlpStatus)
dlpStatus
- return the DLP status of an uploading filepublic boolean isSupportedFileType()
@Deprecated public boolean getSupportedFileType()
public void setSupportedFileType(boolean supportedFileType)
supportedFileType
- Indicates that a file can be shown in Watchdox
Online Viewerpublic boolean isOpenToAnyone()
@Deprecated public boolean getOpenToAnyone()
public void setOpenToAnyone(boolean openToAnyone)
openToAnyone
- Indicates that the file can be accessed by
non-authenticated userspublic DocumentAccessLevel getAccessLevel()
public void setAccessLevel(DocumentAccessLevel accessLevel)
accessLevel
- Document Access Level. Levels are FULL, VIEWER,
TRACKING, NONE.public String getEditorUrl()
public void setEditorUrl(String editorUrl)
editorUrl
- URL to edit the document using Wopipublic String getDocumentName()
public void setDocumentName(String documentName)
documentName
- Use 'name' insteadpublic Boolean getReadAcknowledged()
public void setReadAcknowledged(Boolean readAcknowledged)
public Integer getNumOfVersions()
public void setNumOfVersions(Integer numOfVersions)
numOfVersions
- Indicates how many versions this file haspublic String getFolderUuid()
public void setFolderUuid(String folderUuid)
public PermissionsToUserJson getPermissionsJson()
public void setPermissionsJson(PermissionsToUserJson permissionsJson)
permissionsJson
- Permissions, in some contexts may be null.public String getViewerUrl()
public void setViewerUrl(String viewerUrl)
viewerUrl
- URL of a (protected) file for viewing .public String getUrl()
public void setUrl(String url)
url
- URL of a (protected) file.public String getRoom()
public void setRoom(String room)
room
- Id of the workspace the file has been submitted to.public String getWorkspaceUuid()
public void setWorkspaceUuid(String workspaceUuid)
workspaceUuid
- Workspace uuidpublic TagListJson getTagList()
public void setTagList(TagListJson tagList)
tagList
- Tags, if exist.public String getWorkspaceType()
public void setWorkspaceType(String workspaceType)
public Date getStarredDate()
public void setStarredDate(Date starredDate)
public DocumentAnnotationsListJson getAnnotationsList()
public void setAnnotationsList(DocumentAnnotationsListJson annotationsList)
annotationsList
- A json which represents the users who annotated
the document, and the last update date of their annotationpublic Boolean getCollaboration()
public void setCollaboration(Boolean collaboration)
public Boolean getInheritsPerms()
public void setInheritsPerms(Boolean inheritsPerms)
public String getLastVersionUploaderUserAddress()
public void setLastVersionUploaderUserAddress(String lastVersionUploaderUserAddress)
Copyright © 2019. All rights reserved.