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

Provides properties that describe the contents of a workspace folder. More...

Inheritance diagram for DocuSign.eSign.Model.WorkspaceFolderContents:

Public Member Functions

 WorkspaceFolderContents (string EndPosition=default(string), WorkspaceItem Folder=default(WorkspaceItem), List< WorkspaceItem > Items=default(List< WorkspaceItem >), List< WorkspaceItem > ParentFolders=default(List< WorkspaceItem >), string ResultSetSize=default(string), string StartPosition=default(string), string TotalSetSize=default(string), string WorkspaceId=default(string))
 Initializes a new instance of the WorkspaceFolderContents 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 (WorkspaceFolderContents other)
 Returns true if WorkspaceFolderContents instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string EndPosition [get, set]
 The last position in the result set. More...
 
WorkspaceItem Folder [get, set]
 The folder from which to return items. You can enter either the folder name or folder ID. More...
 
List< WorkspaceItemItems [get, set]
 Gets or Sets Items More...
 
List< WorkspaceItemParentFolders [get, set]
 Gets or Sets ParentFolders More...
 
string ResultSetSize [get, set]
 The number of results returned in this response. More...
 
string StartPosition [get, set]
 Starting position of the current result set. More...
 
string TotalSetSize [get, set]
 The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. More...
 
string WorkspaceId [get, set]
 The id of the workspace, always populated. More...
 

Detailed Description

Provides properties that describe the contents of a workspace folder.

Constructor & Destructor Documentation

◆ WorkspaceFolderContents()

DocuSign.eSign.Model.WorkspaceFolderContents.WorkspaceFolderContents ( string  EndPosition = default(string),
WorkspaceItem  Folder = default(WorkspaceItem),
List< WorkspaceItem Items = default(List<WorkspaceItem>),
List< WorkspaceItem ParentFolders = default(List<WorkspaceItem>),
string  ResultSetSize = default(string),
string  StartPosition = default(string),
string  TotalSetSize = default(string),
string  WorkspaceId = default(string) 
)
inline

Initializes a new instance of the WorkspaceFolderContents class.

Parameters
EndPositionThe last position in the result set. .
FolderThe folder from which to return items. You can enter either the folder name or folder ID..
ItemsItems.
ParentFoldersParentFolders.
ResultSetSizeThe number of results returned in this response. .
StartPositionStarting position of the current result set..
TotalSetSizeThe total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response..
WorkspaceIdThe id of the workspace, always populated..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if WorkspaceFolderContents instances are equal

Parameters
otherInstance of WorkspaceFolderContents to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ EndPosition

string DocuSign.eSign.Model.WorkspaceFolderContents.EndPosition
getset

The last position in the result set.

The last position in the result set.

◆ Folder

WorkspaceItem DocuSign.eSign.Model.WorkspaceFolderContents.Folder
getset

The folder from which to return items. You can enter either the folder name or folder ID.

The folder from which to return items. You can enter either the folder name or folder ID.

◆ Items

List<WorkspaceItem> DocuSign.eSign.Model.WorkspaceFolderContents.Items
getset

Gets or Sets Items

◆ ParentFolders

List<WorkspaceItem> DocuSign.eSign.Model.WorkspaceFolderContents.ParentFolders
getset

Gets or Sets ParentFolders

◆ ResultSetSize

string DocuSign.eSign.Model.WorkspaceFolderContents.ResultSetSize
getset

The number of results returned in this response.

The number of results returned in this response.

◆ StartPosition

string DocuSign.eSign.Model.WorkspaceFolderContents.StartPosition
getset

Starting position of the current result set.

Starting position of the current result set.

◆ TotalSetSize

string DocuSign.eSign.Model.WorkspaceFolderContents.TotalSetSize
getset

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

◆ WorkspaceId

string DocuSign.eSign.Model.WorkspaceFolderContents.WorkspaceId
getset

The id of the workspace, always populated.

The id of the workspace, always populated.


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