Package com.docusign.esign.model

Class WorkspaceItem

  • All Implemented Interfaces:
    Serializable
    public class WorkspaceItem
extends Object
implements Serializable
    A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call..
    See Also:
    Serialized Form

    • Constructor Detail

      • WorkspaceItem

        public WorkspaceItem()

    • Method Detail

      • setCallerAuthorization

        public void setCallerAuthorization​(WorkspaceUserAuthorization callerAuthorization)
        setCallerAuthorization.

      • contentType

        public WorkspaceItem contentType​(String contentType)
        contentType.
        Returns:
        WorkspaceItem

      • getContentType

        public String getContentType()
        .
        Returns:
        contentType

      • setContentType

        public void setContentType​(String contentType)
        setContentType.

      • getCreated

        public String getCreated()
        The UTC DateTime when the workspace item was created..
        Returns:
        created

      • setCreated

        public void setCreated​(String created)
        setCreated.

      • createdById

        public WorkspaceItem createdById​(String createdById)
        createdById.
        Returns:
        WorkspaceItem

      • getCreatedById

        public String getCreatedById()
        .
        Returns:
        createdById

      • setCreatedById

        public void setCreatedById​(String createdById)
        setCreatedById.

      • createdByInformation

        public WorkspaceItem createdByInformation​(WorkspaceUser createdByInformation)
        createdByInformation.
        Returns:
        WorkspaceItem

      • getCreatedByInformation

        public WorkspaceUser getCreatedByInformation()
        Details about the user who created the workspace item..
        Returns:
        createdByInformation

      • setCreatedByInformation

        public void setCreatedByInformation​(WorkspaceUser createdByInformation)
        setCreatedByInformation.

      • extension

        public WorkspaceItem extension​(String extension)
        extension.
        Returns:
        WorkspaceItem

      • getExtension

        public String getExtension()
        .
        Returns:
        extension

      • setExtension

        public void setExtension​(String extension)
        setExtension.

      • fileSize

        public WorkspaceItem fileSize​(String fileSize)
        fileSize.
        Returns:
        WorkspaceItem

      • getFileSize

        public String getFileSize()
        .
        Returns:
        fileSize

      • setFileSize

        public void setFileSize​(String fileSize)
        setFileSize.

      • getFileUri

        public String getFileUri()
        .
        Returns:
        fileUri

      • setFileUri

        public void setFileUri​(String fileUri)
        setFileUri.

      • getId

        public String getId()
        .
        Returns:
        id

      • setId

        public void setId​(String id)
        setId.

      • isPublic

        public WorkspaceItem isPublic​(String isPublic)
        isPublic.
        Returns:
        WorkspaceItem

      • getIsPublic

        public String getIsPublic()
        If true, this supersedes need for bit mask permission with workspaceUserAuthorization.
        Returns:
        isPublic

      • setIsPublic

        public void setIsPublic​(String isPublic)
        setIsPublic.

      • lastModified

        public WorkspaceItem lastModified​(String lastModified)
        lastModified.
        Returns:
        WorkspaceItem

      • getLastModified

        public String getLastModified()
        .
        Returns:
        lastModified

      • setLastModified

        public void setLastModified​(String lastModified)
        setLastModified.

      • lastModifiedById

        public WorkspaceItem lastModifiedById​(String lastModifiedById)
        lastModifiedById.
        Returns:
        WorkspaceItem

      • getLastModifiedById

        public String getLastModifiedById()
        Utc date and time the comment was last updated (can only be done by creator).
        Returns:
        lastModifiedById

      • setLastModifiedById

        public void setLastModifiedById​(String lastModifiedById)
        setLastModifiedById.

      • lastModifiedByInformation

        public WorkspaceItem lastModifiedByInformation​(WorkspaceUser lastModifiedByInformation)
        lastModifiedByInformation.
        Returns:
        WorkspaceItem

      • getLastModifiedByInformation

        public WorkspaceUser getLastModifiedByInformation()
        Details about the user who last modified the workspace item..
        Returns:
        lastModifiedByInformation

      • setLastModifiedByInformation

        public void setLastModifiedByInformation​(WorkspaceUser lastModifiedByInformation)
        setLastModifiedByInformation.

      • getName

        public String getName()
        A simple string description of the item, such as a file name or a folder name..
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • pageCount

        public WorkspaceItem pageCount​(String pageCount)
        pageCount.
        Returns:
        WorkspaceItem

      • getPageCount

        public String getPageCount()
        .
        Returns:
        pageCount

      • setPageCount

        public void setPageCount​(String pageCount)
        setPageCount.

      • parentFolderId

        public WorkspaceItem parentFolderId​(String parentFolderId)
        parentFolderId.
        Returns:
        WorkspaceItem

      • getParentFolderId

        public 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​(String parentFolderId)
        setParentFolderId.

      • parentFolderUri

        public WorkspaceItem parentFolderUri​(String parentFolderUri)
        parentFolderUri.
        Returns:
        WorkspaceItem

      • getParentFolderUri

        public String getParentFolderUri()
        .
        Returns:
        parentFolderUri

      • setParentFolderUri

        public void setParentFolderUri​(String parentFolderUri)
        setParentFolderUri.

      • getSha256

        public String getSha256()
        .
        Returns:
        sha256

      • setSha256

        public void setSha256​(String sha256)
        setSha256.

      • thumbHeight

        public WorkspaceItem thumbHeight​(String thumbHeight)
        thumbHeight.
        Returns:
        WorkspaceItem

      • getThumbHeight

        public String getThumbHeight()
        .
        Returns:
        thumbHeight

      • setThumbHeight

        public void setThumbHeight​(String thumbHeight)
        setThumbHeight.

      • thumbnail

        public WorkspaceItem thumbnail​(Page thumbnail)
        thumbnail.
        Returns:
        WorkspaceItem

      • getThumbnail

        public Page getThumbnail()
        .
        Returns:
        thumbnail

      • setThumbnail

        public void setThumbnail​(Page thumbnail)
        setThumbnail.

      • thumbWidth

        public WorkspaceItem thumbWidth​(String thumbWidth)
        thumbWidth.
        Returns:
        WorkspaceItem

      • getThumbWidth

        public String getThumbWidth()
        .
        Returns:
        thumbWidth

      • setThumbWidth

        public void setThumbWidth​(String thumbWidth)
        setThumbWidth.

      • getType

        public String getType()
        The type of the workspace item. Valid values are file, folder..
        Returns:
        type

      • setType

        public void setType​(String type)
        setType.

      • getUri

        public String getUri()
        .
        Returns:
        uri

      • setUri

        public void setUri​(String uri)
        setUri.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object