DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.WorkspaceItem Class Reference

A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call. More...

Inheritance diagram for DocuSign.eSign.Model.WorkspaceItem:

Public Member Functions

 WorkspaceItem (WorkspaceUserAuthorization CallerAuthorization=default(WorkspaceUserAuthorization), string ContentType=default(string), string Created=default(string), string CreatedById=default(string), WorkspaceUser CreatedByInformation=default(WorkspaceUser), string Extension=default(string), string FileSize=default(string), string FileUri=default(string), string Id=default(string), string IsPublic=default(string), string LastModified=default(string), string LastModifiedById=default(string), WorkspaceUser LastModifiedByInformation=default(WorkspaceUser), string Name=default(string), string PageCount=default(string), string ParentFolderId=default(string), string ParentFolderUri=default(string), string Sha256=default(string), string ThumbHeight=default(string), Page Thumbnail=default(Page), string ThumbWidth=default(string), string Type=default(string), string Uri=default(string), WorkspaceUserAuthorization UserAuthorization=default(WorkspaceUserAuthorization))
 Initializes a new instance of the WorkspaceItem class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object obj)
 Returns true if objects are equal More...
 
bool Equals (WorkspaceItem other)
 Returns true if WorkspaceItem instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

WorkspaceUserAuthorization CallerAuthorization [get, set]
 Gets or Sets CallerAuthorization More...
 
string ContentType [get, set]
 Gets or Sets ContentType More...
 
string Created [get, set]
 The UTC DateTime when the workspace item was created. More...
 
string CreatedById [get, set]
 Gets or Sets CreatedById More...
 
WorkspaceUser CreatedByInformation [get, set]
 Details about the user who created the workspace item. More...
 
string Extension [get, set]
 Gets or Sets Extension More...
 
string FileSize [get, set]
 Gets or Sets FileSize More...
 
string FileUri [get, set]
 Gets or Sets FileUri More...
 
string Id [get, set]
 Gets or Sets Id More...
 
string IsPublic [get, set]
 If true, this supersedes need for bit mask permission with workspaceUserAuthorization More...
 
string LastModified [get, set]
 Gets or Sets LastModified More...
 
string LastModifiedById [get, set]
 Utc date and time the comment was last updated (can only be done by creator) More...
 
WorkspaceUser LastModifiedByInformation [get, set]
 Details about the user who last modified the workspace item. More...
 
string Name [get, set]
 A simple string description of the item, such as a file name or a folder name. More...
 
string PageCount [get, set]
 Gets or Sets PageCount More...
 
string ParentFolderId [get, set]
 The ID of the parent folder. This is the GUID of the parent folder, or the special value &#39;root&#39; for the root folder. More...
 
string ParentFolderUri [get, set]
 Gets or Sets ParentFolderUri More...
 
string Sha256 [get, set]
 Gets or Sets Sha256 More...
 
string ThumbHeight [get, set]
 Gets or Sets ThumbHeight More...
 
Page Thumbnail [get, set]
 Gets or Sets Thumbnail More...
 
string ThumbWidth [get, set]
 Gets or Sets ThumbWidth More...
 
string Type [get, set]
 The type of the workspace item. Valid values are file, folder. More...
 
string Uri [get, set]
 Gets or Sets Uri More...
 
WorkspaceUserAuthorization UserAuthorization [get, set]
 Gets or Sets UserAuthorization More...
 

Detailed Description

A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call.

Constructor & Destructor Documentation

◆ WorkspaceItem()

DocuSign.eSign.Model.WorkspaceItem.WorkspaceItem ( WorkspaceUserAuthorization  CallerAuthorization = default(WorkspaceUserAuthorization),
string  ContentType = default(string),
string  Created = default(string),
string  CreatedById = default(string),
WorkspaceUser  CreatedByInformation = default(WorkspaceUser),
string  Extension = default(string),
string  FileSize = default(string),
string  FileUri = default(string),
string  Id = default(string),
string  IsPublic = default(string),
string  LastModified = default(string),
string  LastModifiedById = default(string),
WorkspaceUser  LastModifiedByInformation = default(WorkspaceUser),
string  Name = default(string),
string  PageCount = default(string),
string  ParentFolderId = default(string),
string  ParentFolderUri = default(string),
string  Sha256 = default(string),
string  ThumbHeight = default(string),
Page  Thumbnail = default(Page),
string  ThumbWidth = default(string),
string  Type = default(string),
string  Uri = default(string),
WorkspaceUserAuthorization  UserAuthorization = default(WorkspaceUserAuthorization) 
)
inline

Initializes a new instance of the WorkspaceItem class.

Parameters
CallerAuthorizationCallerAuthorization.
ContentTypeContentType.
CreatedThe UTC DateTime when the workspace item was created..
CreatedByIdCreatedById.
CreatedByInformationDetails about the user who created the workspace item..
ExtensionExtension.
FileSizeFileSize.
FileUriFileUri.
IdId.
IsPublicIf true, this supersedes need for bit mask permission with workspaceUserAuthorization.
LastModifiedLastModified.
LastModifiedByIdUtc date and time the comment was last updated (can only be done by creator).
LastModifiedByInformationDetails about the user who last modified the workspace item..
NameA simple string description of the item, such as a file name or a folder name..
PageCountPageCount.
ParentFolderIdThe ID of the parent folder. This is the GUID of the parent folder, or the special value &#39;root&#39; for the root folder..
ParentFolderUriParentFolderUri.
Sha256Sha256.
ThumbHeightThumbHeight.
ThumbnailThumbnail.
ThumbWidthThumbWidth.
TypeThe type of the workspace item. Valid values are file, folder..
UriUri.
UserAuthorizationUserAuthorization.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.WorkspaceItem.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.WorkspaceItem.Equals ( WorkspaceItem  other)
inline

Returns true if WorkspaceItem instances are equal

Parameters
otherInstance of WorkspaceItem to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.WorkspaceItem.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.WorkspaceItem.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.WorkspaceItem.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CallerAuthorization

WorkspaceUserAuthorization DocuSign.eSign.Model.WorkspaceItem.CallerAuthorization
getset

Gets or Sets CallerAuthorization

◆ ContentType

string DocuSign.eSign.Model.WorkspaceItem.ContentType
getset

Gets or Sets ContentType

◆ Created

string DocuSign.eSign.Model.WorkspaceItem.Created
getset

The UTC DateTime when the workspace item was created.

The UTC DateTime when the workspace item was created.

◆ CreatedById

string DocuSign.eSign.Model.WorkspaceItem.CreatedById
getset

Gets or Sets CreatedById

◆ CreatedByInformation

WorkspaceUser DocuSign.eSign.Model.WorkspaceItem.CreatedByInformation
getset

Details about the user who created the workspace item.

Details about the user who created the workspace item.

◆ Extension

string DocuSign.eSign.Model.WorkspaceItem.Extension
getset

Gets or Sets Extension

◆ FileSize

string DocuSign.eSign.Model.WorkspaceItem.FileSize
getset

Gets or Sets FileSize

◆ FileUri

string DocuSign.eSign.Model.WorkspaceItem.FileUri
getset

Gets or Sets FileUri

◆ Id

string DocuSign.eSign.Model.WorkspaceItem.Id
getset

Gets or Sets Id

◆ IsPublic

string DocuSign.eSign.Model.WorkspaceItem.IsPublic
getset

If true, this supersedes need for bit mask permission with workspaceUserAuthorization

If true, this supersedes need for bit mask permission with workspaceUserAuthorization

◆ LastModified

string DocuSign.eSign.Model.WorkspaceItem.LastModified
getset

Gets or Sets LastModified

◆ LastModifiedById

string DocuSign.eSign.Model.WorkspaceItem.LastModifiedById
getset

Utc date and time the comment was last updated (can only be done by creator)

Utc date and time the comment was last updated (can only be done by creator)

◆ LastModifiedByInformation

WorkspaceUser DocuSign.eSign.Model.WorkspaceItem.LastModifiedByInformation
getset

Details about the user who last modified the workspace item.

Details about the user who last modified the workspace item.

◆ Name

string DocuSign.eSign.Model.WorkspaceItem.Name
getset

A simple string description of the item, such as a file name or a folder name.

A simple string description of the item, such as a file name or a folder name.

◆ PageCount

string DocuSign.eSign.Model.WorkspaceItem.PageCount
getset

Gets or Sets PageCount

◆ ParentFolderId

string DocuSign.eSign.Model.WorkspaceItem.ParentFolderId
getset

The ID of the parent folder. This is the GUID of the parent folder, or the special value &#39;root&#39; for the root folder.

The ID of the parent folder. This is the GUID of the parent folder, or the special value &#39;root&#39; for the root folder.

◆ ParentFolderUri

string DocuSign.eSign.Model.WorkspaceItem.ParentFolderUri
getset

Gets or Sets ParentFolderUri

◆ Sha256

string DocuSign.eSign.Model.WorkspaceItem.Sha256
getset

Gets or Sets Sha256

◆ ThumbHeight

string DocuSign.eSign.Model.WorkspaceItem.ThumbHeight
getset

Gets or Sets ThumbHeight

◆ Thumbnail

Page DocuSign.eSign.Model.WorkspaceItem.Thumbnail
getset

Gets or Sets Thumbnail

◆ ThumbWidth

string DocuSign.eSign.Model.WorkspaceItem.ThumbWidth
getset

Gets or Sets ThumbWidth

◆ Type

string DocuSign.eSign.Model.WorkspaceItem.Type
getset

The type of the workspace item. Valid values are file, folder.

The type of the workspace item. Valid values are file, folder.

◆ Uri

string DocuSign.eSign.Model.WorkspaceItem.Uri
getset

Gets or Sets Uri

◆ UserAuthorization

WorkspaceUserAuthorization DocuSign.eSign.Model.WorkspaceItem.UserAuthorization
getset

Gets or Sets UserAuthorization


The documentation for this class was generated from the following file: