Package com.docusign.esign.model
Class WorkspaceItem
- java.lang.Object
-
- com.docusign.esign.model.WorkspaceItem
-
public class WorkspaceItem extends java.lang.ObjectA workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call..
-
-
Constructor Summary
Constructors Constructor Description WorkspaceItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WorkspaceItemcallerAuthorization(WorkspaceUserAuthorization callerAuthorization)callerAuthorization.WorkspaceItemcontentType(java.lang.String contentType)contentType.WorkspaceItemcreated(java.lang.String created)created.WorkspaceItemcreatedById(java.lang.String createdById)createdById.WorkspaceItemcreatedByInformation(WorkspaceUser createdByInformation)createdByInformation.booleanequals(java.lang.Object o)Compares objects.WorkspaceItemextension(java.lang.String extension)extension.WorkspaceItemfileSize(java.lang.String fileSize)fileSize.WorkspaceItemfileUri(java.lang.String fileUri)fileUri.WorkspaceUserAuthorizationgetCallerAuthorization()Get callerAuthorization.java.lang.StringgetContentType().java.lang.StringgetCreated()The UTC DateTime when the workspace item was created..java.lang.StringgetCreatedById().WorkspaceUsergetCreatedByInformation()Get createdByInformation.java.lang.StringgetExtension().java.lang.StringgetFileSize().java.lang.StringgetFileUri().java.lang.StringgetId().java.lang.StringgetIsPublic()If true, this supersedes need for bit mask permission with workspaceUserAuthorization.java.lang.StringgetLastModified().java.lang.StringgetLastModifiedById()Utc date and time the comment was last updated (can only be done by creator).WorkspaceUsergetLastModifiedByInformation()Get lastModifiedByInformation.java.lang.StringgetName()A simple string description of the item, such as a file name or a folder name..java.lang.StringgetPageCount().java.lang.StringgetParentFolderId()The ID of the parent folder.java.lang.StringgetParentFolderUri().java.lang.StringgetSha256().java.lang.StringgetThumbHeight().PagegetThumbnail()Get thumbnail.java.lang.StringgetThumbWidth().java.lang.StringgetType()The type of the workspace item.java.lang.StringgetUri().WorkspaceUserAuthorizationgetUserAuthorization()Get userAuthorization.inthashCode()Returns the HashCode.WorkspaceItemid(java.lang.String id)id.WorkspaceItemisPublic(java.lang.String isPublic)isPublic.WorkspaceItemlastModified(java.lang.String lastModified)lastModified.WorkspaceItemlastModifiedById(java.lang.String lastModifiedById)lastModifiedById.WorkspaceItemlastModifiedByInformation(WorkspaceUser lastModifiedByInformation)lastModifiedByInformation.WorkspaceItemname(java.lang.String name)name.WorkspaceItempageCount(java.lang.String pageCount)pageCount.WorkspaceItemparentFolderId(java.lang.String parentFolderId)parentFolderId.WorkspaceItemparentFolderUri(java.lang.String parentFolderUri)parentFolderUri.voidsetCallerAuthorization(WorkspaceUserAuthorization callerAuthorization)setCallerAuthorization.voidsetContentType(java.lang.String contentType)setContentType.voidsetCreated(java.lang.String created)setCreated.voidsetCreatedById(java.lang.String createdById)setCreatedById.voidsetCreatedByInformation(WorkspaceUser createdByInformation)setCreatedByInformation.voidsetExtension(java.lang.String extension)setExtension.voidsetFileSize(java.lang.String fileSize)setFileSize.voidsetFileUri(java.lang.String fileUri)setFileUri.voidsetId(java.lang.String id)setId.voidsetIsPublic(java.lang.String isPublic)setIsPublic.voidsetLastModified(java.lang.String lastModified)setLastModified.voidsetLastModifiedById(java.lang.String lastModifiedById)setLastModifiedById.voidsetLastModifiedByInformation(WorkspaceUser lastModifiedByInformation)setLastModifiedByInformation.voidsetName(java.lang.String name)setName.voidsetPageCount(java.lang.String pageCount)setPageCount.voidsetParentFolderId(java.lang.String parentFolderId)setParentFolderId.voidsetParentFolderUri(java.lang.String parentFolderUri)setParentFolderUri.voidsetSha256(java.lang.String sha256)setSha256.voidsetThumbHeight(java.lang.String thumbHeight)setThumbHeight.voidsetThumbnail(Page thumbnail)setThumbnail.voidsetThumbWidth(java.lang.String thumbWidth)setThumbWidth.voidsetType(java.lang.String type)setType.voidsetUri(java.lang.String uri)setUri.voidsetUserAuthorization(WorkspaceUserAuthorization userAuthorization)setUserAuthorization.WorkspaceItemsha256(java.lang.String sha256)sha256.WorkspaceItemthumbHeight(java.lang.String thumbHeight)thumbHeight.WorkspaceItemthumbnail(Page thumbnail)thumbnail.WorkspaceItemthumbWidth(java.lang.String thumbWidth)thumbWidth.java.lang.StringtoString()Converts the given object to string.WorkspaceItemtype(java.lang.String type)type.WorkspaceItemuri(java.lang.String uri)uri.WorkspaceItemuserAuthorization(WorkspaceUserAuthorization userAuthorization)userAuthorization.
-
-
-
Method Detail
-
callerAuthorization
public WorkspaceItem callerAuthorization(WorkspaceUserAuthorization callerAuthorization)
callerAuthorization.- Returns:
- WorkspaceItem
-
getCallerAuthorization
public WorkspaceUserAuthorization getCallerAuthorization()
Get callerAuthorization.- Returns:
- callerAuthorization
-
setCallerAuthorization
public void setCallerAuthorization(WorkspaceUserAuthorization callerAuthorization)
setCallerAuthorization.
-
contentType
public WorkspaceItem contentType(java.lang.String contentType)
contentType.- Returns:
- WorkspaceItem
-
getContentType
public java.lang.String getContentType()
.- Returns:
- contentType
-
setContentType
public void setContentType(java.lang.String contentType)
setContentType.
-
created
public WorkspaceItem created(java.lang.String created)
created.- Returns:
- WorkspaceItem
-
getCreated
public java.lang.String getCreated()
The UTC DateTime when the workspace item was created..- Returns:
- created
-
setCreated
public void setCreated(java.lang.String created)
setCreated.
-
createdById
public WorkspaceItem createdById(java.lang.String createdById)
createdById.- Returns:
- WorkspaceItem
-
getCreatedById
public java.lang.String getCreatedById()
.- Returns:
- createdById
-
setCreatedById
public void setCreatedById(java.lang.String createdById)
setCreatedById.
-
createdByInformation
public WorkspaceItem createdByInformation(WorkspaceUser createdByInformation)
createdByInformation.- Returns:
- WorkspaceItem
-
getCreatedByInformation
public WorkspaceUser getCreatedByInformation()
Get createdByInformation.- Returns:
- createdByInformation
-
setCreatedByInformation
public void setCreatedByInformation(WorkspaceUser createdByInformation)
setCreatedByInformation.
-
extension
public WorkspaceItem extension(java.lang.String extension)
extension.- Returns:
- WorkspaceItem
-
getExtension
public java.lang.String getExtension()
.- Returns:
- extension
-
setExtension
public void setExtension(java.lang.String extension)
setExtension.
-
fileSize
public WorkspaceItem fileSize(java.lang.String fileSize)
fileSize.- Returns:
- WorkspaceItem
-
getFileSize
public java.lang.String getFileSize()
.- Returns:
- fileSize
-
setFileSize
public void setFileSize(java.lang.String fileSize)
setFileSize.
-
fileUri
public WorkspaceItem fileUri(java.lang.String fileUri)
fileUri.- Returns:
- WorkspaceItem
-
getFileUri
public java.lang.String getFileUri()
.- Returns:
- fileUri
-
setFileUri
public void setFileUri(java.lang.String fileUri)
setFileUri.
-
id
public WorkspaceItem id(java.lang.String id)
id.- Returns:
- WorkspaceItem
-
getId
public java.lang.String getId()
.- Returns:
- id
-
setId
public void setId(java.lang.String id)
setId.
-
isPublic
public WorkspaceItem isPublic(java.lang.String isPublic)
isPublic.- Returns:
- WorkspaceItem
-
getIsPublic
public java.lang.String getIsPublic()
If true, this supersedes need for bit mask permission with workspaceUserAuthorization.- Returns:
- isPublic
-
setIsPublic
public void setIsPublic(java.lang.String isPublic)
setIsPublic.
-
lastModified
public WorkspaceItem lastModified(java.lang.String lastModified)
lastModified.- Returns:
- WorkspaceItem
-
getLastModified
public java.lang.String getLastModified()
.- Returns:
- lastModified
-
setLastModified
public void setLastModified(java.lang.String lastModified)
setLastModified.
-
lastModifiedById
public WorkspaceItem lastModifiedById(java.lang.String lastModifiedById)
lastModifiedById.- Returns:
- WorkspaceItem
-
getLastModifiedById
public java.lang.String getLastModifiedById()
Utc date and time the comment was last updated (can only be done by creator).- Returns:
- lastModifiedById
-
setLastModifiedById
public void setLastModifiedById(java.lang.String lastModifiedById)
setLastModifiedById.
-
lastModifiedByInformation
public WorkspaceItem lastModifiedByInformation(WorkspaceUser lastModifiedByInformation)
lastModifiedByInformation.- Returns:
- WorkspaceItem
-
getLastModifiedByInformation
public WorkspaceUser getLastModifiedByInformation()
Get lastModifiedByInformation.- Returns:
- lastModifiedByInformation
-
setLastModifiedByInformation
public void setLastModifiedByInformation(WorkspaceUser lastModifiedByInformation)
setLastModifiedByInformation.
-
name
public WorkspaceItem name(java.lang.String name)
name.- Returns:
- WorkspaceItem
-
getName
public java.lang.String getName()
A simple string description of the item, such as a file name or a folder name..- Returns:
- name
-
setName
public void setName(java.lang.String name)
setName.
-
pageCount
public WorkspaceItem pageCount(java.lang.String pageCount)
pageCount.- Returns:
- WorkspaceItem
-
getPageCount
public java.lang.String getPageCount()
.- Returns:
- pageCount
-
setPageCount
public void setPageCount(java.lang.String pageCount)
setPageCount.
-
parentFolderId
public WorkspaceItem parentFolderId(java.lang.String parentFolderId)
parentFolderId.- Returns:
- WorkspaceItem
-
getParentFolderId
public java.lang.String getParentFolderId()
The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder..- Returns:
- parentFolderId
-
setParentFolderId
public void setParentFolderId(java.lang.String parentFolderId)
setParentFolderId.
-
parentFolderUri
public WorkspaceItem parentFolderUri(java.lang.String parentFolderUri)
parentFolderUri.- Returns:
- WorkspaceItem
-
getParentFolderUri
public java.lang.String getParentFolderUri()
.- Returns:
- parentFolderUri
-
setParentFolderUri
public void setParentFolderUri(java.lang.String parentFolderUri)
setParentFolderUri.
-
sha256
public WorkspaceItem sha256(java.lang.String sha256)
sha256.- Returns:
- WorkspaceItem
-
getSha256
public java.lang.String getSha256()
.- Returns:
- sha256
-
setSha256
public void setSha256(java.lang.String sha256)
setSha256.
-
thumbHeight
public WorkspaceItem thumbHeight(java.lang.String thumbHeight)
thumbHeight.- Returns:
- WorkspaceItem
-
getThumbHeight
public java.lang.String getThumbHeight()
.- Returns:
- thumbHeight
-
setThumbHeight
public void setThumbHeight(java.lang.String thumbHeight)
setThumbHeight.
-
thumbnail
public WorkspaceItem thumbnail(Page thumbnail)
thumbnail.- Returns:
- WorkspaceItem
-
getThumbnail
public Page getThumbnail()
Get thumbnail.- Returns:
- thumbnail
-
setThumbnail
public void setThumbnail(Page thumbnail)
setThumbnail.
-
thumbWidth
public WorkspaceItem thumbWidth(java.lang.String thumbWidth)
thumbWidth.- Returns:
- WorkspaceItem
-
getThumbWidth
public java.lang.String getThumbWidth()
.- Returns:
- thumbWidth
-
setThumbWidth
public void setThumbWidth(java.lang.String thumbWidth)
setThumbWidth.
-
type
public WorkspaceItem type(java.lang.String type)
type.- Returns:
- WorkspaceItem
-
getType
public java.lang.String getType()
The type of the workspace item. Valid values are file, folder..- Returns:
- type
-
setType
public void setType(java.lang.String type)
setType.
-
uri
public WorkspaceItem uri(java.lang.String uri)
uri.- Returns:
- WorkspaceItem
-
getUri
public java.lang.String getUri()
.- Returns:
- uri
-
setUri
public void setUri(java.lang.String uri)
setUri.
-
userAuthorization
public WorkspaceItem userAuthorization(WorkspaceUserAuthorization userAuthorization)
userAuthorization.- Returns:
- WorkspaceItem
-
getUserAuthorization
public WorkspaceUserAuthorization getUserAuthorization()
Get userAuthorization.- Returns:
- userAuthorization
-
setUserAuthorization
public void setUserAuthorization(WorkspaceUserAuthorization userAuthorization)
setUserAuthorization.
-
equals
public boolean equals(java.lang.Object o)
Compares objects.- Overrides:
equalsin classjava.lang.Object- Returns:
- true or false depending on comparison result.
-
hashCode
public int hashCode()
Returns the HashCode.- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
Converts the given object to string.- Overrides:
toStringin classjava.lang.Object
-
-