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

FolderItem More...

Inheritance diagram for DocuSign.eSign.Model.FolderItem:

Public Member Functions

 FolderItem (string CompletedDateTime=default(string), string CreatedDateTime=default(string), List< CustomFieldV2 > CustomFields=default(List< CustomFieldV2 >), string Description=default(string), string EnvelopeId=default(string), string EnvelopeUri=default(string), string Is21CFRPart11=default(string), string IsSignatureProviderEnvelope=default(string), string LastModified=default(string), string Name=default(string), string OwnerName=default(string), int? PageCount=default(int?), string Password=default(string), string SenderEmail=default(string), string SenderName=default(string), string SentDateTime=default(string), string Shared=default(string), string Status=default(string), string Subject=default(string), string TemplateId=default(string), string Uri=default(string))
 Initializes a new instance of the FolderItem 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 (FolderItem other)
 Returns true if FolderItem instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string CompletedDateTime [get, set]
 Specifies the date and time this item was completed. More...
 
string CreatedDateTime [get, set]
 Indicates the date and time the item was created. More...
 
List< CustomFieldV2CustomFields [get, set]
 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. More...
 
string Description [get, set]
 
string EnvelopeId [get, set]
 The envelope ID of the envelope status that failed to post. More...
 
string EnvelopeUri [get, set]
 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. More...
 
string Is21CFRPart11 [get, set]
 When set to true, indicates that this module is enabled on the account. More...
 
string IsSignatureProviderEnvelope [get, set]
 
string LastModified [get, set]
 
string Name [get, set]
 
string OwnerName [get, set]
 Name of the envelope owner. More...
 
int PageCount [get, set]
 
string Password [get, set]
 
string SenderEmail [get, set]
 
string SenderName [get, set]
 Name of the envelope sender. More...
 
string SentDateTime [get, set]
 The date and time the envelope was sent. More...
 
string Shared [get, set]
 When set to true, this custom tab is shared. 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 Subject [get, set]
 
string TemplateId [get, set]
 The unique identifier of the template. If this is not provided, DocuSign will generate a value. More...
 
string Uri [get, set]
 

Detailed Description

FolderItem

Constructor & Destructor Documentation

◆ FolderItem()

DocuSign.eSign.Model.FolderItem.FolderItem ( string  CompletedDateTime = default(string),
string  CreatedDateTime = default(string),
List< CustomFieldV2 CustomFields = default(List<CustomFieldV2>),
string  Description = default(string),
string  EnvelopeId = default(string),
string  EnvelopeUri = default(string),
string  Is21CFRPart11 = default(string),
string  IsSignatureProviderEnvelope = default(string),
string  LastModified = default(string),
string  Name = default(string),
string  OwnerName = default(string),
int?  PageCount = default(int?),
string  Password = default(string),
string  SenderEmail = default(string),
string  SenderName = default(string),
string  SentDateTime = default(string),
string  Shared = default(string),
string  Status = default(string),
string  Subject = default(string),
string  TemplateId = default(string),
string  Uri = default(string) 
)
inline

Initializes a new instance of the FolderItem class.

Parameters
CompletedDateTimeSpecifies the date and time this item was completed..
CreatedDateTimeIndicates the date and time the item was created..
CustomFieldsAn optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters..
Description.
EnvelopeIdThe envelope ID of the envelope status that failed to post..
EnvelopeUriContains a URI for an endpoint that you can use to retrieve the envelope or envelopes..
Is21CFRPart11When set to true, indicates that this module is enabled on the account..
IsSignatureProviderEnvelope.
LastModified.
Name.
OwnerNameName of the envelope owner..
PageCount.
Password.
SenderEmail.
SenderNameName of the envelope sender..
SentDateTimeThe date and time the envelope was sent..
SharedWhen set to true, this custom tab is shared..
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..
Subject.
TemplateIdThe unique identifier of the template. If this is not provided, DocuSign will generate a value. .
Uri.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if FolderItem instances are equal

Parameters
otherInstance of FolderItem to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CompletedDateTime

string DocuSign.eSign.Model.FolderItem.CompletedDateTime
getset

Specifies the date and time this item was completed.

Specifies the date and time this item was completed.

◆ CreatedDateTime

string DocuSign.eSign.Model.FolderItem.CreatedDateTime
getset

Indicates the date and time the item was created.

Indicates the date and time the item was created.

◆ CustomFields

List<CustomFieldV2> DocuSign.eSign.Model.FolderItem.CustomFields
getset

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

◆ Description

string DocuSign.eSign.Model.FolderItem.Description
getset

◆ EnvelopeId

string DocuSign.eSign.Model.FolderItem.EnvelopeId
getset

The envelope ID of the envelope status that failed to post.

The envelope ID of the envelope status that failed to post.

◆ EnvelopeUri

string DocuSign.eSign.Model.FolderItem.EnvelopeUri
getset

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

◆ Is21CFRPart11

string DocuSign.eSign.Model.FolderItem.Is21CFRPart11
getset

When set to true, indicates that this module is enabled on the account.

When set to true, indicates that this module is enabled on the account.

◆ IsSignatureProviderEnvelope

string DocuSign.eSign.Model.FolderItem.IsSignatureProviderEnvelope
getset

◆ LastModified

string DocuSign.eSign.Model.FolderItem.LastModified
getset

◆ Name

string DocuSign.eSign.Model.FolderItem.Name
getset

◆ OwnerName

string DocuSign.eSign.Model.FolderItem.OwnerName
getset

Name of the envelope owner.

Name of the envelope owner.

◆ PageCount

int DocuSign.eSign.Model.FolderItem.PageCount
getset

◆ Password

string DocuSign.eSign.Model.FolderItem.Password
getset

◆ SenderEmail

string DocuSign.eSign.Model.FolderItem.SenderEmail
getset

◆ SenderName

string DocuSign.eSign.Model.FolderItem.SenderName
getset

Name of the envelope sender.

Name of the envelope sender.

◆ SentDateTime

string DocuSign.eSign.Model.FolderItem.SentDateTime
getset

The date and time the envelope was sent.

The date and time the envelope was sent.

◆ Shared

string DocuSign.eSign.Model.FolderItem.Shared
getset

When set to true, this custom tab is shared.

When set to true, this custom tab is shared.

◆ Status

string DocuSign.eSign.Model.FolderItem.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.

◆ Subject

string DocuSign.eSign.Model.FolderItem.Subject
getset

◆ TemplateId

string DocuSign.eSign.Model.FolderItem.TemplateId
getset

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

◆ Uri

string DocuSign.eSign.Model.FolderItem.Uri
getset


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