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

Provides properties that describe a workspace. More...

Inheritance diagram for DocuSign.eSign.Model.Workspace:

Public Member Functions

 Workspace (string BillableAccountId=default(string), WorkspaceUser CallerInformation=default(WorkspaceUser), string Created=default(string), WorkspaceUser CreatedByInformation=default(WorkspaceUser), string LastModified=default(string), WorkspaceUser LastModifiedByInformation=default(WorkspaceUser), WorkspaceSettings Settings=default(WorkspaceSettings), string Status=default(string), string WorkspaceBaseUrl=default(string), string WorkspaceDescription=default(string), string WorkspaceId=default(string), string WorkspaceName=default(string), string WorkspaceUri=default(string))
 Initializes a new instance of the Workspace 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 (Workspace other)
 Returns true if Workspace instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string BillableAccountId [get, set]
 Gets or Sets BillableAccountId More...
 
WorkspaceUser CallerInformation [get, set]
 Gets or Sets CallerInformation More...
 
string Created [get, set]
 Gets or Sets Created More...
 
WorkspaceUser CreatedByInformation [get, set]
 Details about the user who created the workspace. More...
 
string LastModified [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. More...
 
WorkspaceSettings Settings [get, set]
 Information about the settings for the workspace. More...
 
string Status [get, set]
 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. More...
 
string WorkspaceBaseUrl [get, set]
 The relative URL that may be used to access the workspace. More...
 
string WorkspaceDescription [get, set]
 Text describing the purpose of the workspace. More...
 
string WorkspaceId [get, set]
 The id of the workspace, always populated. More...
 
string WorkspaceName [get, set]
 The name of the workspace. More...
 
string WorkspaceUri [get, set]
 The relative URI that may be used to access the workspace. More...
 

Detailed Description

Provides properties that describe a workspace.

Constructor & Destructor Documentation

◆ Workspace()

DocuSign.eSign.Model.Workspace.Workspace ( string  BillableAccountId = default(string),
WorkspaceUser  CallerInformation = default(WorkspaceUser),
string  Created = default(string),
WorkspaceUser  CreatedByInformation = default(WorkspaceUser),
string  LastModified = default(string),
WorkspaceUser  LastModifiedByInformation = default(WorkspaceUser),
WorkspaceSettings  Settings = default(WorkspaceSettings),
string  Status = default(string),
string  WorkspaceBaseUrl = default(string),
string  WorkspaceDescription = default(string),
string  WorkspaceId = default(string),
string  WorkspaceName = default(string),
string  WorkspaceUri = default(string) 
)
inline

Initializes a new instance of the Workspace class.

Parameters
BillableAccountIdBillableAccountId.
CallerInformationCallerInformation.
CreatedCreated.
CreatedByInformationDetails about the user who created the workspace..
LastModifiedUtc date and time the comment was last updated (can only be done by creator.).
LastModifiedByInformationDetails about the user who last modified the workspace..
SettingsInformation about the settings for the workspace..
StatusIndicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
WorkspaceBaseUrlThe relative URL that may be used to access the workspace..
WorkspaceDescriptionText describing the purpose of the workspace..
WorkspaceIdThe id of the workspace, always populated..
WorkspaceNameThe name of the workspace..
WorkspaceUriThe relative URI that may be used to access the workspace..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if Workspace instances are equal

Parameters
otherInstance of Workspace to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BillableAccountId

string DocuSign.eSign.Model.Workspace.BillableAccountId
getset

Gets or Sets BillableAccountId

◆ CallerInformation

WorkspaceUser DocuSign.eSign.Model.Workspace.CallerInformation
getset

Gets or Sets CallerInformation

◆ Created

string DocuSign.eSign.Model.Workspace.Created
getset

Gets or Sets Created

◆ CreatedByInformation

WorkspaceUser DocuSign.eSign.Model.Workspace.CreatedByInformation
getset

Details about the user who created the workspace.

Details about the user who created the workspace.

◆ LastModified

string DocuSign.eSign.Model.Workspace.LastModified
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.Workspace.LastModifiedByInformation
getset

Details about the user who last modified the workspace.

Details about the user who last modified the workspace.

◆ Settings

WorkspaceSettings DocuSign.eSign.Model.Workspace.Settings
getset

Information about the settings for the workspace.

Information about the settings for the workspace.

◆ Status

string DocuSign.eSign.Model.Workspace.Status
getset

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

◆ WorkspaceBaseUrl

string DocuSign.eSign.Model.Workspace.WorkspaceBaseUrl
getset

The relative URL that may be used to access the workspace.

The relative URL that may be used to access the workspace.

◆ WorkspaceDescription

string DocuSign.eSign.Model.Workspace.WorkspaceDescription
getset

Text describing the purpose of the workspace.

Text describing the purpose of the workspace.

◆ WorkspaceId

string DocuSign.eSign.Model.Workspace.WorkspaceId
getset

The id of the workspace, always populated.

The id of the workspace, always populated.

◆ WorkspaceName

string DocuSign.eSign.Model.Workspace.WorkspaceName
getset

The name of the workspace.

The name of the workspace.

◆ WorkspaceUri

string DocuSign.eSign.Model.Workspace.WorkspaceUri
getset

The relative URI that may be used to access the workspace.

The relative URI that may be used to access the workspace.


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